TLUiActionItem

interface TLUiActionItem<
  TransationKey extends string = string,
  IconType extends string = string,
> {}

Properties

checkbox?: boolean;

icon?: IconType | React.ReactElement;

id: string;

isRequiredA11yAction?: boolean;

kbd?: string;

label?:
  | {
      [key: string]: TransationKey;
    }
  | TransationKey;

readonlyOk?: boolean;

Methods

Whether the action exists in the current context at all, e.g. clipboard support or debug mode. Menus hide the item when it returns false (the keyboard shortcuts dialog still lists it); keyboard shortcuts ignore it. Must be pure and read only editor state.

Parameters

Editor;

Returns

boolean;

For checkbox actions: whether the item shows as checked. Must be pure and read only editor state.

Parameters

Editor;

Returns

boolean;

Whether the action can run now. Menus disable or hide the item when it returns false; keyboard shortcuts ignore it. Must be pure and read only editor state: menus re-run it when that state changes, so anything else it reads goes stale.

Parameters

Editor;

Returns

boolean;

Parameters

TLUiEventSource;

Returns

Promise<void> | void;