Skip to content

AIDK API Reference / aidk/renderers / SemanticContentBlock

Type Alias: SemanticContentBlock ​

ts
type SemanticContentBlock = ContentBlock & {
  semantic?: {
     href?: string;
     level?: number;
     preformatted?: boolean;
     rendererAttrs?: Record<string, any>;
     rendererTag?: string;
     structure?: any;
     type: SemanticType;
  };
  semanticNode?: SemanticNode;
};

Defined in: packages/core/src/renderers/base.ts:91

Extended ContentBlock with semantic information for renderers. Semantic metadata helps renderers format content appropriately.

Note: This is a type alias that extends ContentBlock with optional semantic metadata. All SemanticContentBlocks are valid ContentBlocks.

Type Declaration ​

NameTypeDescriptionDefined in
semantic?{ href?: string; level?: number; preformatted?: boolean; rendererAttrs?: Record<string, any>; rendererTag?: string; structure?: any; type: SemanticType; }Legacy semantic metadata (kept for backward compatibility)packages/core/src/renderers/base.ts:96
semantic.href?string-packages/core/src/renderers/base.ts:100
semantic.level?number-packages/core/src/renderers/base.ts:98
semantic.preformatted?boolean-packages/core/src/renderers/base.ts:106
semantic.rendererAttrs?Record<string, any>-packages/core/src/renderers/base.ts:103
semantic.rendererTag?string-packages/core/src/renderers/base.ts:102
semantic.structure?any-packages/core/src/renderers/base.ts:99
semantic.typeSemanticType-packages/core/src/renderers/base.ts:97
semanticNode?SemanticNodeSemantic node tree representing structured content with formatting hintspackages/core/src/renderers/base.ts:93

Released under the MIT License.