Skip to main content
Module

x/docxml/src/classes/Component.ts>Component

An experimental Deno tool to transform XML to DOCX with a little XPath- and component based configuration
wvbe/docxml
Go to Latest
class Component
Abstract
import { Component } from "https://deno.land/x/docxml@2.4.1/src/classes/Component.ts";

Constructors

new
Component(props: PropsGeneric, ...children: ChildGeneric[])

Type Parameters

optional
PropsGeneric extends { [key: string]: unknown; } = { [key: string]: never; }
optional
ChildGeneric extends AnyComponent | string = never

Properties

readonly
children: ChildGeneric[]

The children given to this component instance.

readonly
props: PropsGeneric

The props given to this component instance.

Methods

protected
childrenToNode(ancestry: Array<ComponentAncestor>): ComponentNode[]
toNode(ancestry: Array<ComponentAncestor>): ComponentNodes

Create a DOM node for this XML component, one that can be stringified to schema-valid OOXML.

By default, an XML component would serialize to its children and string contents -- like a fragment. Most components have an override to use specific OOXML elememnts, such as <w:p>.

Static Properties

readonly
children: string[]

Informs the JSX pragma which child components are allowed in this component. The JSX pragma can use this to attempt repairs at invalidly nested children.

readonly
mixed: boolean

Informs the JSX pragma on wether or not this component can contain text (string) children. The JSX pragma can use this to attempt repairs at invalidly nested children.

[IS_COMPONENT]: true

Static Methods

fromNode(_node: Node): AnyComponent
matchesNode(_node: Node): boolean