BlockSuite API Documentation / @blocksuite/blocks / AffineReference

Class: AffineReference

Extends

• AffineReference_base

Constructors

new AffineReference()

new AffineReference(): AffineReference

Returns

AffineReference

Inherited from

AffineReference_base.constructor

Defined in

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

Other

_disposables

protected _disposables: DisposableGroup

Inherited from

AffineReference_base._disposables

Defined in

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

---

disposables

readonly disposables: DisposableGroup

Inherited from

AffineReference_base.disposables

Defined in

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

---

virtualKeyboardPolicy

virtualKeyboardPolicy: string

Inherited from

AffineReference_base.virtualKeyboardPolicy

Defined in

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

---

connectedCount

static connectedCount: WeakMap<Constructor, WeakMap<Node, number>>

Inherited from

AffineReference_base.connectedCount

Defined in

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

---

onDisconnectedMap

static onDisconnectedMap: WeakMap<Constructor, null | () => void>

Inherited from

AffineReference_base.onDisconnectedMap

Defined in

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

---

styles

static styles: CSSResult

Overrides

AffineReference_base.styles

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:10

---

_icon

Get Signature

get _icon(): undefined | TemplateResult<ResultType>

Returns

undefined | TemplateResult<ResultType>

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:14

---

_title

Get Signature

get _title(): undefined | string

Returns

undefined | string

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:15

---

block

Get Signature

get block(): undefined | null | BlockComponent<BlockModel<object, object>, BlockService, string>

Returns

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

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:16

---

config

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:28

---

customContent

Get Signature

get customContent(): undefined | (reference) => TemplateResult<ResultType>

Returns

undefined | (reference) => TemplateResult<ResultType>

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:17

---

delta

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:29

---

doc

Get Signature

get doc(): Doc

Returns

Doc

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:18

---

inlineEditor

Get Signature

get inlineEditor(): undefined | InlineEditor<AffineTextAttributes>

Returns

undefined | InlineEditor<AffineTextAttributes>

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:19

---

referenceInfo

Get Signature

get referenceInfo(): object

Returns

object

description?

optional description: string

pageId

pageId: string

params?

optional params: object

params.blockIds?

optional params.blockIds: string[]

params.databaseId?

optional params.databaseId: string

params.databaseRowId?

optional params.databaseRowId: string

params.elementIds?

optional params.elementIds: string[]

params.mode?

optional params.mode: "edgeless" | "page"

title?

optional title: string

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:20

---

refMeta

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:12

---

selected

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:30

---

selfInlineRange

Get Signature

get selfInlineRange(): undefined | null | InlineRange

Returns

undefined | null | InlineRange

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:21

---

std

Get Signature

get std(): BlockStdScope

Returns

BlockStdScope

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:22

---

connectedCallback()

connectedCallback(): void

Returns

void

Overrides

AffineReference_base.connectedCallback

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:24

---

referenceToNode()

referenceToNode(): boolean

Returns

boolean

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:25

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.

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

An element may be re-connected after being disconnected.

Returns

void

Inherited from

AffineReference_base.disconnectedCallback

Defined in

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

rendering

createRenderRoot()

createRenderRoot(): this

Returns

this

Inherited from

AffineReference_base.createRenderRoot

Defined in

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

---

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

AffineReference_base.render

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:26

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

AffineReference_base.finalizeStyles

Defined in

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

updates

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.

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

AffineReference_base.willUpdate

Defined in

packages/affine/components/dist/rich-text/inline/presets/nodes/reference-node/reference-node.d.ts:27