BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / EdgelessFrameTitle

Class: EdgelessFrameTitle ​

Extends ​

Constructors ​

new EdgelessFrameTitle() ​

new EdgelessFrameTitle(): EdgelessFrameTitle

Returns ​

EdgelessFrameTitle

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

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/blocks/src/frame-block/frame-block.ts:37

colors ​

get colors(): object

Returns ​

object

background ​

background: string = backgroundColor

text ​

text: string = textColor

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:76

doc ​

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:315

gfx ​

get gfx(): GfxController

Returns ​

GfxController

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:113

model ​

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:318

rootService ​

get rootService(): EdgelessRootService

Returns ​

EdgelessRootService

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:117

std ​

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:323

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.

ts
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/blocks/src/frame-block/frame-block.ts:152

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/blocks/src/frame-block/frame-block.ts:222

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.

ts
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/blocks/src/frame-block/frame-block.ts:215

updated() ​

updated(_changedProperties): void

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters ​

• _changedProperties: Map<string, unknown>

Map of changed properties with old values

Returns ​

void

Overrides ​

SignalWatcher( WithDisposable(ShadowlessElement) ).updated

Defined in ​

packages/blocks/src/frame-block/frame-block.ts:268

Copyright © 2022-present Toeverything