BlockSuite API Documentation / @blocksuite/blocks / PeekViewService
Interface: PeekViewService
Methods
peek()
Call Signature
peek(
pageRef,options?):Promise<void>
Peek a target element page ref info
Parameters
pageRef
The page ref info to peek.
blockIds
string[]
databaseDocId
string
databaseId
string
databaseRowId
string
docId
string
elementIds
string[]
target
HTMLElement
options?
Returns
Promise<void>
A promise that resolves when the peek view is closed.
Defined in
packages/affine/components/dist/peek/type.d.ts:19
Call Signature
peek(
element,options?):Promise<void>
Peek a target element with a optional template
Parameters
element
target
HTMLElement
template
TemplateResult
options?
Returns
Promise<void>
A promise that resolves when the peek view is closed.
Defined in
packages/affine/components/dist/peek/type.d.ts:36
Call Signature
peek<
Element>(element,options?):Promise<void>
Type Parameters
• Element extends BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>
Parameters
element
target
Element
template
TemplateResult
options?
Returns
Promise<void>
Defined in
packages/affine/components/dist/peek/type.d.ts:40