Skip to main content

개요

사용자가 채널, DM 또는 지원 채팅에서 메시지를 검색할 수 있게 해 주는 UI 요소입니다.

사용법

기본 사용법

모달로 사용하기

이벤트

SearchElement가 발생시키는 이벤트입니다. on() 메서드를 사용하거나 옵션에 콜백 함수를 전달하여 이 이벤트를 수신할 수 있습니다.

error

요소 초기화 또는 작업 중 오류가 발생하면 발생합니다. 콜백 시그니처: (error: unknown) => void

ready

요소가 로딩을 마치고 사용자 상호작용 준비가 완료되면 발생합니다. 콜백 시그니처: (element: SearchElement) => void

optionsUpdated

updateOptions()를 통해 요소의 옵션이 업데이트되면 발생합니다. 콜백 시그니처: (options: SearchElementOptions) => void

snapshot

요소의 내부 상태가 변경되면 발생합니다. 콜백 시그니처: (snapshot: SearchElementSnapshot) => void

close

사용자가 검색 요소를 닫으면 발생합니다. 요소가 자동으로 마운트 해제되지 않도록 하려면 ev.preventDefault()를 호출하세요. 콜백 시그니처: (ev: CustomEvent<any>) => void

resultClick

사용자가 검색 결과를 클릭하면 실행되는 콜백입니다. 요소가 자동으로 마운트 해제되지 않도록 하려면 ev.preventDefault()를 호출하세요. 콜백 시그니처: (ev: CustomEvent<{ messageId: string; channelId: string; }>) => void

메서드

mount(container)

요소를 DOM 컨테이너에 마운트합니다. 컨테이너는 빈 요소여야 합니다. 요소는 자식으로 추가됩니다. 요소가 이미 마운트된 경우 이 메서드는 경고를 기록하고 반환합니다.

unmount()

DOM에서 요소를 제거하고 모든 이벤트 리스너를 정리합니다. 마운트 해제한 후에는 요소 인스턴스를 재사용하면 안 됩니다. 다시 마운트해야 하는 경우 새 요소 인스턴스를 생성하세요.

updateOptions(options)

생성 후 요소의 구성 옵션을 업데이트합니다. 제공된 옵션만 업데이트되며, 다른 옵션은 변경되지 않습니다. 요소는 새 옵션으로 다시 렌더링됩니다.

getSnapshot()

요소의 현재 상태 스냅샷을 가져옵니다. 스냅샷에는 로딩 상태, 폼 값 또는 기타 요소별 데이터 등 요소의 현재 내부 상태가 포함됩니다. 반환값: SearchElementSnapshot

스타일링

appearance.classes로 이 요소를 사용자 지정할 수 있습니다. 안정적인 클래스 이름의 전체 목록과 예제 스니펫은 스타일링 레퍼런스를 참조하세요.

타입

SearchElementOptions

SearchElement의 구성 옵션입니다.

SearchElementSnapshot

SearchElement의 현재 상태를 나타냅니다. 현재 상태를 가져오려면 element.getSnapshot()을 사용하고, 변경 사항을 확인하려면 snapshot 이벤트를 수신하세요.