Skip to content

ToolOption

type ToolOption = {
icon: ChatKitIcon;
id: string;
label: string;
pinned?: boolean;
placeholderOverride?: string;
shortLabel?: string;
};

Describes a selectable tool shown in the composer.

icon: ChatKitIcon;

Icon displayed next to the tool in the menu.


id: string;

label: string;

Label displayed in the tool menu


optional pinned: boolean;

Whether the tool is pinned to the composer outside of the tool menu.

false;

optional placeholderOverride: string;

Optional placeholder text to show in the composer input when the tool is selected.


optional shortLabel: string;

Optional label displayed in the button when the tool is selected.