BlockSuite API Documentation / @blocksuite/affine-block-surface-ref

@blocksuite/affine-block-surface-ref

Classes

EdgelessSurfaceRefBlockComponent

Extends

• BlockComponent<SurfaceRefBlockModel>

Constructors

Other

_focused

_referenceModel

gfx

Get Signature

get gfx(): GfxController

Returns

GfxController

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

BlockComponent.connectedCallback

renderBlock()

renderBlock(): TemplateResult<1>

Returns

TemplateResult<1>

Overrides

BlockComponent.renderBlock

attributes

controllers

dev-mode

lifecycle

properties

rendering

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:

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

Nocollapse

Overrides

BlockComponent.styles

updates

---

SurfaceRefBlockComponent

Extends

• BlockComponent<SurfaceRefBlockModel>

Constructors

Other

captionElement

hoverableContainer

isCommentHighlighted

Get Signature

get isCommentHighlighted(): boolean

Returns

boolean

previewEditor

referenceModel

Get Signature

get referenceModel(): GfxModel | null

Returns

GfxModel | null

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

BlockComponent.connectedCallback

open()

readonly open(__namedParameters): void

Parameters

__namedParameters

event?

MouseEvent

openMode?

OpenDocMode

Returns

void

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

viewInEdgeless()

viewInEdgeless(): void

Returns

void

attributes

controllers

dev-mode

lifecycle

properties

rendering

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:

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

Nocollapse

Overrides

BlockComponent.styles

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

BlockComponent.firstUpdated

Variables

insertSurfaceRefBlockCommand

const insertSurfaceRefBlockCommand: Command<{ place: "after" | "before"; reference: string; removeEmptyLine?: boolean; selectedModels?: BlockModel[]; }, { insertedSurfaceRefBlockId: string; }>