Welshman

Appearance

Welshman Docs / @welshman/editor / NodeViewProps

Interface: NodeViewProps ​

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:233

Extends ​

  • NodeViewRendererProps

Properties ​

decorations ​

decorations: readonly DecorationWithType[]

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:234

is an array of node or inline decorations that are active around the node. They are automatically drawn in the normal way, and you will usually just want to ignore this, but they can also be used as a way to provide context information to the node view without adding it to the document itself.

Overrides ​

NodeViewRendererProps.decorations

deleteNode() ​

deleteNode: () => void

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:237

Returns ​

void

editor ​

editor: Editor

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:274

The editor instance.

Inherited from ​

NodeViewRendererProps.editor

extension ​

extension: Node

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:278

The extension that is responsible for the node.

Inherited from ​

NodeViewRendererProps.extension

getPos() ​

getPos: () => number

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:260

A function that can be called to get the node's current position in the document.

Returns ​

number

Inherited from ​

NodeViewRendererProps.getPos

HTMLAttributes ​

HTMLAttributes: Record<string, any>

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:282

The HTML attributes that should be added to the node's DOM element.

Inherited from ​

NodeViewRendererProps.HTMLAttributes

innerDecorations ​

innerDecorations: DecorationSource

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:270

holds the decorations for the node's content. You can safely ignore this if your view has no content or a contentDOM property, since the editor will draw the decorations on the content. But if you, for example, want to create a nested editor with the content, it may make sense to provide it with the inner decorations.

Inherited from ​

NodeViewRendererProps.innerDecorations

node ​

node: Node

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:252

The node that is being rendered.

Inherited from ​

NodeViewRendererProps.node

selected ​

selected: boolean

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:235

updateAttributes() ​

updateAttributes: (attributes) => void

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:236

Parameters ​

attributes ​

Record<string, any>

Returns ​

void

view ​

view: EditorView

Defined in: node_modules/.pnpm/@tiptap+core@2.27.2_@tiptap+pm@2.27.2/node_modules/@tiptap/core/dist/types.d.ts:256

The editor's view.

Inherited from ​

NodeViewRendererProps.view