BlockSuite API Documentation / @blocksuite/blocks / PeekableOptions

Type Alias: PeekableOptions<T>

PeekableOptions<T>: object

Type Parameters

• T extends PeekableClass

Type declaration

action?

optional action: PeekableAction | PeekableAction[] | false

Action to bind to the peekable element. default to ['double-click', 'shift-click'] false means do not bind any action.

enableOn()?

optional enableOn: (block) => boolean

It will check the block is enable to peek or not

Parameters

• block: T

Returns

boolean

selector?

optional selector: string

Selector inside of the peekable element to bind the action

Defined in

packages/affine/components/dist/peek/type.d.ts:37