TldrawUiMenuItem

Properties

Whether this item should be disabled.

disabled?: boolean

The icon to display on the item. Icons are only shown in certain menu types.

icon?: IconType | TLUiIconJsx

An icon to display to the left of the menu item.

iconLeft?: IconType | TLUiIconJsx

id: string

Whether the item is selected.

isSelected?: boolean

The keyboard shortcut to display on the item.

kbd?: string

The label to display on the item. If it's a string, it will be translated. If it's an object, the keys will be used as the language keys and the values will be translated.

label?:
  | {
      [key: string]: TranslationKey
    }
  | TranslationKey

Prevent the menu from closing when the item is clicked

noClose?: boolean

The function to call when the item is dragged. If this is provided, the item will be draggable.

Parameters

TLUiEventSource

TLPointerEventInfo

Returns

void

The function to call when the item is clicked.

Parameters

TLUiEventSource

Returns

Promise<void> | void

If the editor is in readonly mode and the item is not marked as readonlyok, it will not be rendered.

readonlyOk?: boolean

Whether to show a spinner on the item.

spinner?: boolean