Class NextAttributeComponent<T>

Next-generation attribute component with explicit key-value pairs.

NextAttributeComponent provides an alternative approach to attributes where each property explicitly specifies both its XML attribute name and value. This gives more control but is more verbose than XmlAttributeComponent.

Example

new NextAttributeComponent({
  fontSize: { key: "w:sz", value: 24 },
  bold: { key: "w:b", value: true }
});
// Generates: _attr: { "w:sz": 24, "w:b": true }

Type Parameters

T extends AttributeData

Hierarchy (View Summary)

BaseXmlComponent
- NextAttributeComponent

Index

Constructors

constructor

Methods

prepForXml

Constructors

constructor

new NextAttributeComponent<T extends AttributeData>(
root: AttributePayload<T>,
): NextAttributeComponent<T>
Creates a new NextAttributeComponent.
Type Parameters
- T extends AttributeData
Parameters
- root: AttributePayload<T>
  Attribute payload with explicit key-value mappings
Returns NextAttributeComponent<T>
Overrides BaseXmlComponent.constructor
- Defined in file/xml-components/default-attributes.ts:108

Methods

prepForXml

prepForXml(_: IContext): IXmlableObject
Converts the attribute payload to an XML-serializable object.

Extracts the key and value from each property and filters out undefined values.
Parameters
- _: IContext
  Context (unused for attributes)
Returns IXmlableObject
Object with _attr key containing the attributes
Overrides BaseXmlComponent.prepForXml
- Defined in file/xml-components/default-attributes.ts:121

Class NextAttributeComponent<T>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NextAttributeComponent<T>

Methods

prepForXml

Parameters

Returns IXmlableObject

Settings

On This Page