BlockSuite API Documentation / @blocksuite/block-std / EditorHost
Class: EditorHost
Extends
ShadowlessElement
<this
> &DisposableClass
<this
>
Constructors
new EditorHost()
new EditorHost():
EditorHost
Returns
Inherited from
SignalWatcher( WithDisposable(ShadowlessElement) ).constructor
Defined in
node_modules/.pnpm/@[email protected]/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
Other
_disposables
protected
_disposables:DisposableGroup
Inherited from
SignalWatcher( WithDisposable(ShadowlessElement) )._disposables
Defined in
packages/framework/block-std/src/view/utils/with-disposable.ts:8
disposables
readonly
disposables:DisposableGroup
Inherited from
SignalWatcher( WithDisposable(ShadowlessElement) ).disposables
Defined in
packages/framework/block-std/src/view/utils/with-disposable.ts:10
slots
readonly
slots:object
unmounted
unmounted:
Slot
<void
>
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:106
disableShadowRoot
static
disableShadowRoot:boolean
=true
Inherited from
SignalWatcher( WithDisposable(ShadowlessElement) ).disableShadowRoot
Defined in
packages/framework/block-std/src/view/element/shadowless-element.ts:6
styles
static
styles:CSSResult
Overrides
SignalWatcher( WithDisposable(ShadowlessElement) ).styles
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:41
blockIdAttr
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:195
command
get
command():CommandManager
Returns
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:110
doc
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:199
event
get
event():UIEventDispatcher
Returns
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:114
range
get
range():RangeManager
Returns
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:118
selection
get
selection():SelectionManager
Returns
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:122
std
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:203
view
get
view():ViewStore
Returns
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:126
widgetIdAttr
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:206
dangerouslyRenderModel()
dangerouslyRenderModel(
model
):TemplateResult
Render a block model manually instead of let blocksuite render it. If you render the same block model multiple times, the event flow and data binding will be broken. Only use this method as a last resort.
Parameters
• model: BlockModel
<object
, SignaledProps
<object
>>
Returns
TemplateResult
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:91
renderChildren()
renderChildren(
model
,filter
?):TemplateResult
Parameters
• model: BlockModel
<object
, SignaledProps
<object
>>
• filter?
Returns
TemplateResult
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:95
lifecycle
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
SignalWatcher( WithDisposable(ShadowlessElement) ).connectedCallback
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:130
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
Overrides
SignalWatcher( WithDisposable(ShadowlessElement) ).disconnectedCallback
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:144
rendering
createRenderRoot()
createRenderRoot():
HTMLElement
|DocumentFragment
Returns
HTMLElement
| DocumentFragment
Inherited from
SignalWatcher( WithDisposable(ShadowlessElement) ).createRenderRoot
Defined in
packages/framework/block-std/src/view/element/shadowless-element.ts:30
render()
render():
TemplateResult
| typeofnothing
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
TemplateResult
| typeof nothing
Overrides
SignalWatcher( WithDisposable(ShadowlessElement) ).render
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:187
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
SignalWatcher( WithDisposable(ShadowlessElement) ).finalizeStyles
Defined in
packages/framework/block-std/src/view/element/shadowless-element.ts:8
updates
getUpdateComplete()
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.
Overrides
SignalWatcher( WithDisposable(ShadowlessElement) ).getUpdateComplete
Defined in
packages/framework/block-std/src/view/element/lit-host.ts:150