BlockSuite API Documentation / @blocksuite/presets / DocTitle

Class: DocTitle

Extends

• ShadowlessElement<this> & DisposableClass<this>

Constructors

new DocTitle()

new DocTitle(): DocTitle

Returns

DocTitle

Inherited from

WithDisposable(ShadowlessElement).constructor

Defined in

node_modules/@lit/reactive-element/development/reactive-element.d.ts:504

Other

_disposables

protected _disposables: DisposableGroup

Inherited from

WithDisposable(ShadowlessElement)._disposables

Defined in

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

---

disposables

readonly disposables: DisposableGroup

Inherited from

WithDisposable(ShadowlessElement).disposables

Defined in

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

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

WithDisposable(ShadowlessElement).virtualKeyboardPolicy

Defined in

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

---

disableShadowRoot

static disableShadowRoot: boolean

Inherited from

WithDisposable(ShadowlessElement).disableShadowRoot

Defined in

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

---

styles

static styles: CSSResult

Overrides

WithDisposable(ShadowlessElement).styles

Defined in

packages/presets/src/fragments/doc-title/doc-title.ts:13

---

doc

Defined in

packages/presets/src/fragments/doc-title/doc-title.ts:182

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

WithDisposable(ShadowlessElement).connectedCallback

Defined in

packages/presets/src/fragments/doc-title/doc-title.ts:113

rendering

createRenderRoot()

createRenderRoot(): HTMLElement | DocumentFragment

Returns

HTMLElement | DocumentFragment

Inherited from

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

WithDisposable(ShadowlessElement).render

Defined in

packages/presets/src/fragments/doc-title/doc-title.ts:151

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

WithDisposable(ShadowlessElement).finalizeStyles

Defined in

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