BlockSuite API Documentation / @blocksuite/blocks / FrameBlockComponent
Class: FrameBlockComponent
Extends
Constructors
new FrameBlockComponent()
new FrameBlockComponent():
FrameBlockComponent
Returns
Inherited from
Defined in
node_modules/.pnpm/@[email protected]/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
Other
[GfxElementSymbol]
[GfxElementSymbol]:
boolean
Inherited from
GfxBlockComponent
.[GfxElementSymbol]
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:7
[blockComponentSymbol]
[blockComponentSymbol]:
boolean
Inherited from
GfxBlockComponent
.[blockComponentSymbol]
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:13
_disposables
protected
_disposables:DisposableGroup
Inherited from
GfxBlockComponent
._disposables
Defined in
packages/framework/block-std/dist/view/utils/with-disposable.d.ts:4
disposables
readonly
disposables:DisposableGroup
Inherited from
Defined in
packages/framework/block-std/dist/view/utils/with-disposable.d.ts:5
handleEvent()
handleEvent: (
name
,handler
,options
?) =>void
Parameters
• name: "pan"
| "click"
| "doubleClick"
| "tripleClick"
| "pointerDown"
| "pointerMove"
| "pointerUp"
| "pointerOut"
| "dragStart"
| "dragMove"
| "dragEnd"
| "pinch"
| "keyDown"
| "keyUp"
| "selectionChange"
| "compositionStart"
| "compositionUpdate"
| "compositionEnd"
| "cut"
| "copy"
| "paste"
| "beforeInput"
| "blur"
| "focus"
| "drop"
| "contextMenu"
| "wheel"
• handler: UIEventHandler
• options?
• options.flavour?: boolean
• options.global?: boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:14
disableShadowRoot
static
disableShadowRoot:boolean
Inherited from
GfxBlockComponent
.disableShadowRoot
Defined in
packages/framework/block-std/dist/view/element/shadowless-element.d.ts:4
_renderers
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:53
blockId
get
blockId():string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:18
childBlocks
get
childBlocks():BlockComponent
<BlockModel
<object
,object
>,BlockService
,string
>[]
Returns
BlockComponent
<BlockModel
<object
, object
>, BlockService
, string
>[]
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:19
dirty
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:55
doc
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:56
flavour
get
flavour():string
Returns
string
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:20
gfx
get
gfx():GfxController
Returns
GfxController
Inherited from
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:8
host
get
host():EditorHost
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:21
isVersionMismatch
get
isVersionMismatch():boolean
Returns
boolean
Inherited from
GfxBlockComponent
.isVersionMismatch
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:22
model
get
model():Model
Returns
Model
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:23
parentComponent
get
parentComponent():null
|BlockComponent
<BlockModel
<object
,SignaledProps
<object
>>,BlockService
,string
>
Returns
null
| BlockComponent
<BlockModel
<object
, SignaledProps
<object
>>, BlockService
, string
>
Inherited from
GfxBlockComponent
.parentComponent
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:24
renderChildren
get
renderChildren(): (model
,filter
?) =>TemplateResult
Returns
Function
Parameters
• model: BlockModel
<object
, SignaledProps
<object
>>
• filter?
Returns
TemplateResult
Inherited from
GfxBlockComponent
.renderChildren
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:25
rootComponent
get
rootComponent():null
|BlockComponent
<BlockModel
<object
,SignaledProps
<object
>>,BlockService
,string
>
Returns
null
| BlockComponent
<BlockModel
<object
, SignaledProps
<object
>>, BlockService
, string
>
Inherited from
GfxBlockComponent
.rootComponent
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:26
rootService
get
rootService():EdgelessRootService
Returns
Defined in
packages/blocks/src/frame-block/frame-block.ts:335
selected
get
selected():null
|BaseSelection
Returns
null
| BaseSelection
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:27
selection
get
selection():SelectionManager
Returns
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:28
service
get
service():Service
Returns
Service
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:29
showBorder
Defined in
packages/blocks/src/frame-block/frame-block.ts:396
std
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:57
titleElement
Defined in
packages/blocks/src/frame-block/frame-block.ts:399
topContenteditableElement
get
topContenteditableElement():null
|BlockComponent
<BlockModel
<object
,SignaledProps
<object
>>,BlockService
,string
>
Returns
null
| BlockComponent
<BlockModel
<object
, SignaledProps
<object
>>, BlockService
, string
>
Inherited from
GfxBlockComponent
.topContenteditableElement
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:30
viewType
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:58
widgetComponents
get
widgetComponents():Partial
<Record
<WidgetName
,WidgetComponent
<BlockModel
<object
,SignaledProps
<object
>>,BlockComponent
<BlockModel
<object
,SignaledProps
<object
>>,BlockService
,string
>,BlockService
>>>
Returns
Partial
<Record
<WidgetName
, WidgetComponent
<BlockModel
<object
, SignaledProps
<object
>>, BlockComponent
<BlockModel
<object
, SignaledProps
<object
>>, BlockService
, string
>, BlockService
>>>
Inherited from
GfxBlockComponent
.widgetComponents
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:31
widgets
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:59
addRenderer()
addRenderer(
renderer
):void
Parameters
• renderer
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:34
bindHotKey()
bindHotKey(
keymap
,options
?): () =>void
Parameters
• keymap: Record
<string
, UIEventHandler
>
• options?
• options.flavour?: boolean
• options.global?: boolean
Returns
Function
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:35
connectedCallback()
connectedCallback():
void
Invoked when the component is added to the document's DOM.
In connectedCallback()
you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.
connectedCallback() {
super.connectedCallback();
addEventListener('keydown', this._handleKeydown);
}
Typically, anything done in connectedCallback()
should be undone when the element is disconnected, in disconnectedCallback()
.
Returns
void
Overrides
GfxBlockComponent
.connectedCallback
Defined in
packages/blocks/src/frame-block/frame-block.ts:339
getRenderingRect()
getRenderingRect():
object
Returns
object
h
h:
any
w
w:
any
x
x:
any
y
y:
any
zIndex
zIndex:
string
Inherited from
GfxBlockComponent
.getRenderingRect
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:10
renderBlock()
renderBlock():
unknown
Returns
unknown
Inherited from
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:17
renderGfxBlock()
renderGfxBlock():
TemplateResult
<1
>
Returns
TemplateResult
<1
>
Overrides
GfxBlockComponent
.renderGfxBlock
Defined in
packages/blocks/src/frame-block/frame-block.ts:357
renderPageContent()
renderPageContent():
unknown
Returns
unknown
Inherited from
GfxBlockComponent
.renderPageContent
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:19
renderVersionMismatch()
renderVersionMismatch(
expectedVersion
,actualVersion
):TemplateResult
Render a warning message when the block version is mismatched.
Parameters
• expectedVersion: number
If the schema is not found, the expected version is -1. Which means the block is not supported in the current editor.
• actualVersion: number
The version of the block's crdt data.
Returns
TemplateResult
Inherited from
GfxBlockComponent
.renderVersionMismatch
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:50
toZIndex()
toZIndex():
string
Returns
string
Overrides
Defined in
packages/blocks/src/frame-block/frame-block.ts:388
updateZIndex()
updateZIndex():
void
Returns
void
Inherited from
GfxBlockComponent
.updateZIndex
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:22
lifecycle
disconnectedCallback()
disconnectedCallback():
void
Invoked when the component is removed from the document's DOM.
This callback is the main signal to the element that it may no longer be used. disconnectedCallback()
should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.
disconnectedCallback() {
super.disconnectedCallback();
window.removeEventListener('keydown', this._handleKeydown);
}
An element may be re-connected after being disconnected.
Returns
void
Inherited from
GfxBlockComponent
.disconnectedCallback
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:40
rendering
createRenderRoot()
createRenderRoot():
HTMLElement
|DocumentFragment
Returns
HTMLElement
| DocumentFragment
Inherited from
GfxBlockComponent
.createRenderRoot
Defined in
packages/framework/block-std/dist/view/element/shadowless-element.d.ts:6
render()
render():
unknown
Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart
- typically a TemplateResult
. Setting properties inside this method will not trigger the element to update.
Returns
unknown
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:42
styles
finalizeStyles()
protected
static
finalizeStyles(styles
?):CSSResultOrNative
[]
Takes the styles the user supplied via the static styles
property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.
Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.
Parameters
• styles?: CSSResultGroup
Returns
CSSResultOrNative
[]
Nocollapse
Inherited from
GfxBlockComponent
.finalizeStyles
Defined in
packages/framework/block-std/dist/view/element/shadowless-element.d.ts:5
updates
firstUpdated()
firstUpdated():
void
Invoked when the element is first updated. Implement to perform one time work on the element after update.
firstUpdated() {
this.renderRoot.getElementById('my-text-area').focus();
}
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Returns
void
Overrides
GfxBlockComponent.firstUpdated
Defined in
packages/blocks/src/frame-block/frame-block.ts:351
getUpdateComplete()
protected
getUpdateComplete():Promise
<boolean
>
Override point for the updateComplete
promise.
It is not safe to override the updateComplete
getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)
) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:
class MyElement extends LitElement {
override async getUpdateComplete() {
const result = await super.getUpdateComplete();
await this._myChild.updateComplete;
return result;
}
}
Returns
Promise
<boolean
>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Inherited from
GfxBlockComponent
.getUpdateComplete
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:41
scheduleUpdate()
scheduleUpdate():
Promise
<void
>
Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate()
must be called.
For instance, to schedule updates to occur just before the next frame:
override protected async scheduleUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.scheduleUpdate();
}
Returns
Promise
<void
>
Inherited from
GfxBlockComponent
.scheduleUpdate
Defined in
packages/framework/block-std/dist/view/element/gfx-block-component.d.ts:20
update()
protected
update(changedProperties
):void
Updates the element. This method reflects property values to attributes and calls render
to render DOM via lit-html. Setting properties inside this method will not trigger another update.
Parameters
• changedProperties: PropertyValueMap
<any
> | Map
<PropertyKey
, unknown
>
Map of changed properties with old values
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/view/element/block-component.d.ts:51