Skip to content
ChatKit

ToolOption

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

Describes a selectable tool shown in the composer.

Properties

Section titled “Properties”

icon

Section titled “icon”
icon: ChatKitIcon;

Icon displayed next to the tool in the menu.

id

Section titled “id”
id: string;

label

Section titled “label”
label: string;

Label displayed in the tool menu

persistent?

Section titled “persistent?”
optional persistent: boolean;

Whether the tool continues to be selected after the user submits a message. The default behavior is for tool selection to be cleared after message submission.

Default

Section titled “Default”
false;

pinned?

Section titled “pinned?”
optional pinned: boolean;

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

Default

Section titled “Default”
false;

placeholderOverride?

Section titled “placeholderOverride?”
optional placeholderOverride: string;

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

shortLabel?

Section titled “shortLabel?”
optional shortLabel: string;

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