BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / SurfaceRefBlockComponent

Class: SurfaceRefBlockComponent ​

Extends ​

Constructors ​

new SurfaceRefBlockComponent() ​

new SurfaceRefBlockComponent(): SurfaceRefBlockComponent

Returns ​

SurfaceRefBlockComponent

Inherited from ​

BlockComponent.constructor

Defined in ​

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

Other ​

_disposables ​

protected _disposables: DisposableGroup

Inherited from ​

BlockComponent._disposables

Defined in ​

packages/framework/block-std/dist/view/utils/with-disposable.d.ts:4

[blockComponentSymbol] ​

[blockComponentSymbol]: boolean

Inherited from ​

BlockComponent.[blockComponentSymbol]

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:13

disposables ​

readonly disposables: DisposableGroup

Inherited from ​

BlockComponent.disposables

Defined in ​

packages/framework/block-std/dist/view/utils/with-disposable.d.ts:5

handleEvent() ​

handleEvent: (name, handler, options?) => void

Parameters ​

• name: "pan" | "click" | "blur" | "focus" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "drop" | "contextMenu" | "wheel"

• handler: UIEventHandler

• options?

• options.flavour?: boolean

• options.global?: boolean

Returns ​

void

Inherited from ​

BlockComponent.handleEvent

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:14

disableShadowRoot ​

static disableShadowRoot: boolean

Inherited from ​

BlockComponent.disableShadowRoot

Defined in ​

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

_renderers ​

Inherited from ​

BlockComponent._renderers

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:53

blockId ​

get blockId(): string

Returns ​

string

Inherited from ​

BlockComponent.blockId

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:18

captionElement ​

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:657

childBlocks ​

get childBlocks(): BlockComponent<BlockModel<object, object>, BlockService, string>[]

Returns ​

BlockComponent<BlockModel<object, object>, BlockService, string>[]

Inherited from ​

BlockComponent.childBlocks

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:19

dirty ​

Inherited from ​

BlockComponent.dirty

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:55

doc ​

Inherited from ​

BlockComponent.doc

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:56

flavour ​

get flavour(): string

Returns ​

string

Inherited from ​

BlockComponent.flavour

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:20

host ​

get host(): EditorHost

Returns ​

EditorHost

Inherited from ​

BlockComponent.host

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:21

isVersionMismatch ​

get isVersionMismatch(): boolean

Returns ​

boolean

Inherited from ​

BlockComponent.isVersionMismatch

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:22

model ​

get model(): Model

Returns ​

Model

Inherited from ​

BlockComponent.model

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:23

parentComponent ​

get parentComponent(): null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Returns ​

null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Inherited from ​

BlockComponent.parentComponent

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:24

previewEditor ​

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:660

referenceModel ​

get referenceModel(): null | GfxModel

Returns ​

null | GfxModel

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:257

renderChildren ​

get renderChildren(): (model, filter?) => TemplateResult

Returns ​

Function

Parameters ​

• model: BlockModel<object, SignaledProps<object>>

• filter?

Returns ​

TemplateResult

Inherited from ​

BlockComponent.renderChildren

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:25

rootComponent ​

get rootComponent(): null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Returns ​

null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Inherited from ​

BlockComponent.rootComponent

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:26

selected ​

get selected(): null | BaseSelection

Returns ​

null | BaseSelection

Inherited from ​

BlockComponent.selected

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:27

selection ​

get selection(): SelectionManager

Returns ​

SelectionManager

Inherited from ​

BlockComponent.selection

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:28

service ​

get service(): Service

Returns ​

Service

Inherited from ​

BlockComponent.service

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:29

std ​

Inherited from ​

BlockComponent.std

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:57

topContenteditableElement ​

get topContenteditableElement(): null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Returns ​

null | BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>

Inherited from ​

BlockComponent.topContenteditableElement

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:30

viewType ​

Inherited from ​

BlockComponent.viewType

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:58

widgetComponents ​

get widgetComponents(): Partial<Record<WidgetName, WidgetComponent<BlockModel<object, SignaledProps<object>>, BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>, BlockService>>>

Returns ​

Partial<Record<WidgetName, WidgetComponent<BlockModel<object, SignaledProps<object>>, BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>, BlockService>>>

Inherited from ​

BlockComponent.widgetComponents

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:31

widgets ​

Inherited from ​

BlockComponent.widgets

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:59

addRenderer() ​

addRenderer(renderer): void

Parameters ​

• renderer

Returns ​

void

Inherited from ​

BlockComponent.addRenderer

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:34

bindHotKey() ​

bindHotKey(keymap, options?): () => void

Parameters ​

• keymap: Record<string, UIEventHandler>

• options?

• options.flavour?: boolean

• options.global?: boolean

Returns ​

Function

Returns ​

void

Inherited from ​

BlockComponent.bindHotKey

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:35

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 ​

BlockComponent.connectedCallback

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:588

render() ​

render(): TemplateResult<1> | typeof nothing

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> | typeof nothing

Overrides ​

BlockComponent.render

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:603

renderBlock() ​

renderBlock(): unknown

Returns ​

unknown

Inherited from ​

BlockComponent.renderBlock

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:43

renderVersionMismatch() ​

renderVersionMismatch(expectedVersion, actualVersion): TemplateResult

Render a warning message when the block version is mismatched.

Parameters ​

• expectedVersion: number

If the schema is not found, the expected version is -1. Which means the block is not supported in the current editor.

• actualVersion: number

The version of the block's crdt data.

Returns ​

TemplateResult

Inherited from ​

BlockComponent.renderVersionMismatch

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:50

viewInEdgeless() ​

viewInEdgeless(): void

Returns ​

void

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:632

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.

ts
disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Returns ​

void

Inherited from ​

BlockComponent.disconnectedCallback

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:40

rendering ​

createRenderRoot() ​

createRenderRoot(): HTMLElement | DocumentFragment

Returns ​

HTMLElement | DocumentFragment

Inherited from ​

BlockComponent.createRenderRoot

Defined in ​

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

styles ​

styles ​

static styles: CSSResult

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

html
<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse ​

Overrides ​

BlockComponent.styles

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:72

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 ​

BlockComponent.finalizeStyles

Defined in ​

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

updates ​

getUpdateComplete() ​

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

ts
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.

Inherited from ​

BlockComponent.getUpdateComplete

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:41

update() ​

protected update(changedProperties): void

Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

Parameters ​

• changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

Map of changed properties with old values

Returns ​

void

Inherited from ​

BlockComponent.update

Defined in ​

packages/framework/block-std/dist/view/element/block-component.d.ts:51

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.

ts
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<PropertyKey, unknown>

Returns ​

void

Overrides ​

BlockComponent.willUpdate

Defined in ​

packages/blocks/src/surface-ref-block/surface-ref-block.ts:644

Copyright © 2022-present Toeverything