Markprompt
Renders the pre-built Markprompt component, including chat and search views, and trigger component.
Basic example
Component API
Prop | Type | Description | Default |
---|---|---|---|
projectKey | string | The project key associated to your project. | |
apiUrl | string | The base API URL. | "https://api.markprompt.com" |
headers | { [key: string]: string } | Headers to pass along the request. | |
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. | "sheet" |
sticky | boolean | Enable user interactions outside of the dialog while keeping it open. | false |
defaultView | View | The default view to show when both chat and search are enabled. | "search" |
layout | 'panels' | 'tabs' | Multi-pane layout when both search and chat are enabled. | "panels" |
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>. | "a" |
showBranding | boolean | Options for the title component. | true |
branding | BrandingOptions | Options for the title component. | |
debug | boolean | Display debug info. | false |