TLUiToolItem
See source codeTable of contents
interface TLUiToolItem<
TranslationKey extends string = string,
IconType extends string = string,
> {}
Properties
icon
icon: IconType
id
id: string
kbd
optional
The keyboard shortcut for this tool. This is a string that can be a single key,
or a combination of keys.
For example, cmd+z
or cmd+shift+z
or cmd+u,ctrl+u
, or just v
or a
.
We have backwards compatibility with the old system, where we used to use
symbols to denote cmd/alt/shift, using !
for shift, $
for cmd, and ?
for alt.
kbd?: string
label
label: TranslationKey
meta
optional
meta?: {
[key: string]: any
}
readonlyOk
optional
readonlyOk?: boolean
shortcutsLabel
optional
shortcutsLabel?: TranslationKey
Methods
onSelect
Parameters
Name | Description |
---|---|
|
Returns
void
Prev
TLUiToolbarToggleItemPropsNext
TLUiToolsProviderProps