Home > @tridion-sites/models > ComponentTemplate
Represents a Component Template: a template used to render a Component into a Component Presentation.
Signature:
export declare class ComponentTemplate extends Template
Extends: Template
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)({ backendModel, approvalStatus, relatedSchemas, trackingCategories, workflowInfo, …templateArgs }) | Constructs a new instance of the ComponentTemplate class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _backendModel | BackendComponentTemplate | ||
| allowOnPage | boolean | <p>Whether the Component Template may be used on a Page.</p><p>This setting only applies to Component Templates which render “dynamic” Component Presentations.</p> | |
| approvalStatus | Link | undefined | <p>Approval status of the item.</p><p>Can be undefined if the item has not been part of a workflow process.</p> | |
| dynamicTemplate | string | <p>“dynamic” part of the Component Template: an XSLT which is executed on the Content Delivery system.</p><p>A string containing the XSLT or an empty string if not applicable.</p><p>Only applicable if the “OutputFormat” is set to “XML Document”.</p> | |
| getInternalModel | () => BackendComponentTemplate | ||
| isRepositoryPublishable | boolean | <p>Whether the Component Template renders “dynamic” Component Presentations.</p><p>This setting only applies to Component Templates which render “dynamic” Component Presentations.</p><p>A “dynamic” Component Presentation is published separately instead of being embedded on a Page.</p> | |
| outputFormat | string | undefined | <p>Format of the rendered Component Presentation.</p><p>The possible values are currently constrained by the system schema (cm_xml.xsd): * HTML * HTML Fragment * JSP Scripting * Plain Text * XML Document * XML Fragment * ASCX WebControl * REL * Other</p> | |
| priority | number | undefined | <p>Priority used for resolving Component links.</p><p>The Priority is used by Content Delivery linking to resolve a Component link: if a Component is published on multiple Pages, then a choice has to be made to which Page the hyperlink should point. This decision is made based on the Priority of the Component Template used to render the Component: the hyperlink will point to the Page containing a Component Presentation with the highest priority.</p> | |
| relatedSchemas | ReadonlyArray<Link> | undefined | ||
| trackingCategories | ReadonlyArray<Link> | undefined | When rendering a Component using the Component Template, code to increment “tracking keys” can get generated by the system. Which “tracking keys” will get incremented is determined by the Keywords attached to the Component and the Tracking Categories set on the Component Template: each Keyword attached to the Component which is part of one of the Tracking Categories will result in an associated “tracking key” increment. | |
| workflowInfo | WorkflowInfo | undefined | Workflow-related information for the item. |