BlockSuite API Documentation / @blocksuite/presets / AffineEditorContainer

Class: AffineEditorContainer

Extends

• ShadowlessElement<this> & DisposableClass<this>

Implements

• AbstractEditor

Constructors

new AffineEditorContainer()

new AffineEditorContainer(): AffineEditorContainer

Returns

AffineEditorContainer

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

---

slots

slots: EditorSlots

Deprecated

need to refactor

Implementation of

AbstractEditor.slots

Defined in

packages/presets/src/editors/editor-container.ts:120

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Implementation of

AbstractEditor.virtualKeyboardPolicy

Inherited from

SignalWatcher(WithDisposable(ShadowlessElement)).virtualKeyboardPolicy

Defined in

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

---

disableShadowRoot

static disableShadowRoot: boolean

Inherited from

SignalWatcher(WithDisposable(ShadowlessElement)).disableShadowRoot

Defined in

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

---

styles

static styles: CSSResult

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).styles

Defined in

packages/presets/src/editors/editor-container.ts:26

---

autofocus

MDN Reference

Implementation of

AbstractEditor.autofocus

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).autofocus

Defined in

packages/presets/src/editors/editor-container.ts:244

---

doc

get doc(): Doc

set doc(doc): void

Parameters

• doc: Doc

Returns

Doc

Implementation of

AbstractEditor.doc

Defined in

packages/presets/src/editors/editor-container.ts:124

---

edgelessSpecs

get edgelessSpecs(): ExtensionType[]

set edgelessSpecs(specs): void

Parameters

• specs: ExtensionType[]

Returns

ExtensionType[]

Defined in

packages/presets/src/editors/editor-container.ts:136

---

host

get host(): null | EditorHost

Returns

null | EditorHost

Defined in

packages/presets/src/editors/editor-container.ts:140

---

mode

get mode(): DocMode

set mode(mode): void

Parameters

• mode: DocMode

Returns

DocMode

Implementation of

AbstractEditor.mode

Defined in

packages/presets/src/editors/editor-container.ts:148

---

pageSpecs

get pageSpecs(): ExtensionType[]

set pageSpecs(specs): void

Parameters

• specs: ExtensionType[]

Returns

ExtensionType[]

Defined in

packages/presets/src/editors/editor-container.ts:160

---

rootModel

get rootModel(): BlockModel<object, SignaledProps<object>>

Returns

BlockModel<object, SignaledProps<object>>

Defined in

packages/presets/src/editors/editor-container.ts:164

---

std

get std(): BlockStdScope

Returns

BlockStdScope

Defined in

packages/presets/src/editors/editor-container.ts:168

---

connectedCallback()

connectedCallback(): void

Returns

void

Deprecated

need to refactor

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).connectedCallback

Defined in

packages/presets/src/editors/editor-container.ts:175

---

switchEditor()

switchEditor(mode): void

Parameters

• mode: DocMode

Returns

void

Defined in

packages/presets/src/editors/editor-container.ts:226

---

updated()

updated(changedProperties): void

Parameters

• changedProperties: Map<string, unknown>

Returns

void

Deprecated

need to refactor

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).updated

Defined in

packages/presets/src/editors/editor-container.ts:233

rendering

createRenderRoot()

createRenderRoot(): HTMLElement | DocumentFragment

Returns

HTMLElement | DocumentFragment

Inherited from

SignalWatcher(WithDisposable(ShadowlessElement)).createRenderRoot

Defined in

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

---

render()

render(): 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

TemplateResult<1>

Overrides

SignalWatcher(WithDisposable(ShadowlessElement)).render

Defined in

packages/presets/src/editors/editor-container.ts:195

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: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

SignalWatcher(WithDisposable(ShadowlessElement)).firstUpdated

Defined in

packages/presets/src/editors/editor-container.ts:183