Home > @yext/chat-ui-react > ChatHeaderProps
The props for the ChatHeader() component.
Signature:
export interface ChatHeaderProps | Property | Modifiers | Type | Description |
|---|---|---|---|
| aiSignpostProps? | AISignpostProps | (Optional) The props to pass to the built-in AI signpost component. | |
| closeButtonIcon? | JSX.Element | (Optional) Custom icon for for close button. | |
| customCssClasses? | ChatHeaderCssClasses | (Optional) CSS classes for customizing the component styling. | |
| hideAISignpost? | boolean | (Optional) Whether to hide the AI signpost. Defaults to false. | |
| onClose? | () => void | (Optional) A function which is called when the close button is clicked. | |
| restartButtonIcon? | JSX.Element | (Optional) Custom icon for for restart button. | |
| showCloseButton? | boolean | (Optional) Displays a close button which will invoke ChatHeaderProps.onClose on click. Default to false. | |
| showRestartButton? | boolean | (Optional) Displays a restart button which allows the user to restart the conversation. Defaults to false. | |
| title | string | The headers's title text, essentially how the chat window identifies itself to the user. |