Interface TemplateBlockProvider

Runtime and validation contract for a named XML template block.

interface TemplateBlockProvider {
    contentModel: TemplateBlockContentModel;
    name: string;
    optionalAttributes?: readonly string[];
    requiredAttributes?: readonly string[];
    expand(
        block: TemplateBlockNode,
        context: TemplateBlockExpansionContext,
    ): string;
}

Index

Properties

contentModel name optionalAttributes? requiredAttributes?

Methods

Properties

`Readonly`contentModel

contentModel: TemplateBlockContentModel

Whether this block is self-closing, a container, or accepts either shape.

`Readonly`name

name: string

XML tag name handled by this provider.

`Optional` `Readonly`optionalAttributes

optionalAttributes?: readonly string[]

Optional XML attribute names. When omitted, any extra attributes are accepted.

`Optional` `Readonly`requiredAttributes

requiredAttributes?: readonly string[]

Required XML attribute names.

Methods

expand

expand(block: TemplateBlockNode, context: TemplateBlockExpansionContext): string
Expands the block into output content.
Parameters
- block: TemplateBlockNode
- context: TemplateBlockExpansionContext
Returns string
- Defined in packages/foundation/src/lib/templating/template-processor.ts:158