Ui componentsJs snippet
Custom Trigger (JS)
Use the "Custom Trigger" component if you want to use a custom button, search bar, link, or any other UI element to open the Inkeep AI search or chat modal.
Quick Start
JavaScript example:
HTML example:
InkeepCustomTriggerProps
This type represents the configuration for the Inkeep custom trigger widget.
Property | Type | Description |
---|---|---|
isOpen | boolean | Required. Determines whether the modal is open. |
onClose | () => void | Required. Callback for when the modal is closed. |
onOpen | () => void | Callback for when the modal is opened. Default undefined . |
baseSettings | InkeepBaseSettings | Required. Base settings for any Inkeep widget. See reference here. |
modalSettings | InkeepModalSettings | Settings for the modal. See reference here. |
searchSettings | InkeepSearchSettings | Additional search settings for the Inkeep widget. See reference here. |
aiChatSettings | InkeepAIChatSettings | AI chat settings for the Inkeep widget. See reference here. |