MarkpromptOptions
| Prop | Type | Description |
|---|---|---|
| apiUrl | string | The base API URL. Default: |
| children | React.ReactNode | Trigger component, such as a search button or a floating chat bubble. |
| display | MarkpromptDisplay | The way to display the chat/search content. Default: |
| sticky | boolean | Enable user interactions outside of the dialog while keeping it open. Default: |
| defaultView | View | The default view to show when both chat and search are enabled. Default: |
| layout | 'panels' | 'tabs' | Multi-pane layout when both search and chat are enabled. Default: |
| menu | MenuOptions | Options for the menu component. |
| chat | UserConfigurableOptions & ChatOptions | Options for the chat component. |
| search | SubmitSearchQueryOptions & SearchOptions | Options for the search component. |
| feedback | SubmitFeedbackOptions & FeedbackOptions | Options for the feedback component. |
| references | ReferencesOptions | Options for the references component. |
| integrations | IntegrationsOptions | Options for integrations. |
| trigger | TriggerOptions | Options for the trigger component. |
| close | CloseOptions | Options for the close button. |
| description | DescriptionOptions | Options for the description. |
| title | TitleOptions | Options for the title component. |
| linkAs | string | ComponentType<any> | Component to use in place of <a>. Default: |
| branding | BrandingOptions | Options for the title component. |
| debug | boolean | Display debug info. Default: |
BrandingOptions
| Prop | Type | Description |
|---|---|---|
| show | boolean | Show branding. Default: |
| type | 'plain' | 'text' | Branding display type. Default: |
CloseOptions
| Prop | Type | Description |
|---|---|---|
| label | string |
|
| visible | boolean | Show the close button Default: |
| hasIcon | boolean | Show an × icon in the close button instead of the keyboard
shortcut ('Esc'). Default: |
DescriptionOptions
| Prop | Type | Description |
|---|---|---|
| hide | boolean | Visually hide the description Default: |
| text | string | Description text |
TitleOptions
| Prop | Type | Description |
|---|---|---|
| hide | boolean | Visually hide the title. Default: |
| text | string | Text for the title. Default: |
TriggerOptions
| Prop | Type | Description |
|---|---|---|
| label | string |
|
| buttonLabel | string | Label for the open button |
| placeholder | string | Placeholder text for non-floating element. Default: |
| floating | boolean | Should the trigger button be displayed as a floating button at the bottom right of the page?
Setting this to false will display a trigger button in the element passed
to the |
| customElement | boolean | ReactNode | Do you use a custom element as the dialog trigger? |
| iconSrc | string | Custom image icon source for the open button |