BlockSuite API Documentation / @blocksuite/blocks / Peekable

Function: Peekable()

Peekable<T, C>(options?): (Class, context) => undefined | C

Mark a class as peekable, which means the class can be peeked by the peek view service.

Note: This class must be syntactically below the @customElement decorator (it will be applied before customElement).

Type Parameters

• T extends PeekableClass

• C extends Constructor<PeekableClass>

Parameters

• options?: PeekableOptions<T>

Returns

Function

Parameters

• Class: C

• context: ClassDecoratorContext<(...args) => any>

Returns

undefined | C

Defined in

packages/affine/components/dist/peek/peekable.d.ts:11