Skip to main content

Web SDK Reference

Interfaces

InterfaceDescription
AuthTokenDetails-
BoxCustomizationsStyle and other options which can be customized on the embedded search widget box.
ChatCustomizations-
ChatHandle-
ChatOptions-
FilterConfig-
GleanWebSDKEntry point for all Glean embedded widgets.
GuestAuthProviderCreates and manages auth tokens for guest users. Used primarily in Glean external search deployments
GuestAuthProviderOptions-
ModalSearchOptions-
Options-
RecommendationsBoxCustomizations-
RecommendationsOptions-
RecommendationsResultsOptions-
RecommendationsSearchOptions-
SearchBoxCustomizationsStyle and other options which can be customized on the embedded search widget box.
SearchBoxOptions-
SearchOptions-
SettingsOptions-
TabbedSearchOptions-
Theme-
WidgetHandle-

Type Aliases

Type AliasDescription
ThemeVariant-
WebSdkChatEventChat events that can be emitted by the chat component - chat:id_update and chat:location_update events may be sent multiple times for the same ID and the handler should be idempotent

Variables

VariableDescription
attach-
createGuestAuthProvider-
default-
getChatOptionsFromUrl-
openSidebar-
renderChat-
renderRecommendations-
renderSearchBox-
renderSearchResults-
version-