BlockSuite API Documentation / @blocksuite/presets / EdgelessEditor

Class: EdgelessEditor

Extends

• ShadowlessElement<this> & DisposableClass<this>

Constructors

new EdgelessEditor()

new EdgelessEditor(): EdgelessEditor

Returns

EdgelessEditor

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).constructor

Defined in

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/global/dist/utils/with-disposable.d.ts:5

---

disposables

readonly disposables: DisposableGroup

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).disposables

Defined in

packages/framework/global/dist/utils/with-disposable.d.ts:6

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).virtualKeyboardPolicy

Defined in

packages/framework/global/dist/types/virtual-keyboard.d.ts:20

---

connectedCount

static connectedCount: WeakMap<Constructor, WeakMap<Node, number>>

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).connectedCount

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:5

---

onDisconnectedMap

static onDisconnectedMap: WeakMap<Constructor, null | () => void>

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).onDisconnectedMap

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:6

---

styles

static styles: CSSResult

Overrides

SignalWatcher( WithDisposable(ShadowlessElement) ).styles

Defined in

packages/presets/src/editors/edgeless-editor.ts:13

---

doc

Defined in

packages/presets/src/editors/edgeless-editor.ts:89

---

editor

Defined in

packages/presets/src/editors/edgeless-editor.ts:92

---

host

Get Signature

get host(): null | EditorHost

Returns

null | EditorHost

Defined in

packages/presets/src/editors/edgeless-editor.ts:39

---

specs

Defined in

packages/presets/src/editors/edgeless-editor.ts:95

---

std

Defined in

packages/presets/src/editors/edgeless-editor.ts:98

---

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

SignalWatcher( WithDisposable(ShadowlessElement) ).connectedCallback

Defined in

packages/presets/src/editors/edgeless-editor.ts:47

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

SignalWatcher( WithDisposable(ShadowlessElement) ).disconnectedCallback

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:12

rendering

createRenderRoot()

createRenderRoot(): this

Returns

this

Inherited from

SignalWatcher( WithDisposable(ShadowlessElement) ).createRenderRoot

Defined in

packages/framework/block-std/dist/view/element/shadowless-element.d.ts:11

---

render()

render(): typeof nothing | TemplateResult<1>

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

typeof nothing | TemplateResult<1>

Overrides

SignalWatcher( WithDisposable(ShadowlessElement) ).render

Defined in

packages/presets/src/editors/edgeless-editor.ts:64

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/dist/view/element/shadowless-element.d.ts:7

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/presets/src/editors/edgeless-editor.ts:58

---

willUpdate()

willUpdate(changedProperties): void

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

willUpdate(changedProperties) {
  // only need to check changed properties for an expensive computation.
  if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
    this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
  }
}

render() {
  return html`SHA: ${this.sha}`;
}

Parameters

changedProperties

Map<string | number | symbol, unknown>

Returns

void

Overrides

SignalWatcher( WithDisposable(ShadowlessElement) ).willUpdate

Defined in

packages/presets/src/editors/edgeless-editor.ts:76