BlockSuite API Documentation / @blocksuite/affine-block-root / KeyboardToolbarActionItem

Type Alias: KeyboardToolbarActionItem

KeyboardToolbarActionItem = object

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:127

Properties

action()?

optional action: (ctx) => void | Promise<void>

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:144

Parameters

ctx

KeyboardToolbarContext

Returns

void | Promise<void>

Description

The action to be executed when the item is clicked.

---

background?

optional background: string | (ctx) => string | undefined

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:130

---

disableWhen()?

optional disableWhen: (ctx) => boolean

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:140

Parameters

ctx

KeyboardToolbarContext

Returns

boolean

Default

false

Description

Whether to set the item as disabled status.

---

icon

icon: KeyboardIconType

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:129

---

name

name: string

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:128

---

showWhen()?

optional showWhen: (ctx) => boolean

Defined in: packages/affine/blocks/block-root/src/widgets/keyboard-toolbar/config.ts:135

Parameters

ctx

KeyboardToolbarContext

Returns

boolean

Default

true

Description

Whether to show the item in the toolbar.