BlockSuite API Documentation / @blocksuite/blocks / PeekViewService

Interface: PeekViewService

Methods

peek()

peek(pageRef, options)

peek(pageRef, options?): Promise<void>

Peek a target element page ref info

Parameters

• pageRef

The page ref info to peek.

• pageRef.blockIds?: string[]

• pageRef.databaseId?: string

• pageRef.databaseRowId?: string

• pageRef.docId?: string

• pageRef.elementIds?: string[]

• pageRef.target?: HTMLElement

• options?: PeekOptions

Returns

Promise<void>

A promise that resolves when the peek view is closed.

Defined in

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

peek(element, options)

peek(element, options?): Promise<void>

Peek a target element with a optional template

Parameters

• element

• element.target: HTMLElement

• element.template?: TemplateResult

• options?: PeekOptions

Returns

Promise<void>

A promise that resolves when the peek view is closed.

Defined in

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

peek(element, options)

peek<Element>(element, options?): Promise<void>

Type Parameters

• Element extends BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Parameters

• element

• element.target: Element

• element.template?: TemplateResult

• options?: PeekOptions

Returns

Promise<void>

Defined in

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