Skip to content

Type Editor


Type Editor / @type-editor/viewdesc / OuterDecoLevel / OuterDecoLevel

Class: OuterDecoLevel

Defined in: OuterDecoLevel.ts:15

Represents a level of outer decoration wrapping, storing HTML attributes like nodeName, class, style, and other custom attributes as key-value pairs.

Decorations can add multiple wrapper layers around nodes. Each layer can:

  • Specify a nodeName to create a new wrapper element
  • Add CSS classes
  • Add inline styles
  • Add custom HTML attributes

For example, a node might be wrapped like: <div class="highlight"><span style="color: red">content</span></div> This would use two OuterDecoLevel instances.

Constructors

Constructor

ts
new OuterDecoLevel(nodeName?): OuterDecoLevel;

Defined in: OuterDecoLevel.ts:33

Creates a new OuterDecoLevel.

Parameters

ParameterTypeDescription
nodeName?stringOptional tag name for this decoration level

Returns

OuterDecoLevel

Accessors

attributes

Get Signature

ts
get attributes(): ReadonlyMap<string, string>;

Defined in: OuterDecoLevel.ts:67

Gets the read-only map of custom attributes (excluding class, style, nodeName).

Returns

ReadonlyMap<string, string>


class

Get Signature

ts
get class(): string;

Defined in: OuterDecoLevel.ts:47

Returns

string

Set Signature

ts
set class(className): void;

Defined in: OuterDecoLevel.ts:51

Parameters
ParameterType
classNamestring
Returns

void


nodeName

Get Signature

ts
get nodeName(): string;

Defined in: OuterDecoLevel.ts:39

Returns

string

Set Signature

ts
set nodeName(nodeName): void;

Defined in: OuterDecoLevel.ts:43

Parameters
ParameterType
nodeNamestring
Returns

void


style

Get Signature

ts
get style(): string;

Defined in: OuterDecoLevel.ts:55

Returns

string

Set Signature

ts
set style(style): void;

Defined in: OuterDecoLevel.ts:59

Parameters
ParameterType
stylestring
Returns

void

Methods

setAttribute()

ts
setAttribute(name, value): void;

Defined in: OuterDecoLevel.ts:77

Sets a custom HTML attribute on this decoration level.

Parameters

ParameterTypeDescription
namestringThe attribute name (e.g., 'data-id', 'title')
valuestringThe attribute value

Returns

void