Skip to content
PHP Ecosystem
Explore

Template

API reference › HTML › Metadata › Template

Renders the HTML <template> element for inert HTML fragments.

Supports experimental declarative shadow DOM attributes. Availability and behavior may vary across browsers.

See also: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/template (BaseBlock for the base implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getContent()Returns the content assigned to the element.UIAwesome\Html\Mixin\HasContent
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
shadowRootClonable()Sets the shadowrootclonable attribute.Template
shadowRootDelegatesFocus()Sets the shadowrootdelegatesfocus attribute.Template
shadowRootMode()Sets the shadowrootmode attribute.Template
shadowRootReferenceTarget()Sets the shadowrootreferencetarget attribute.Template
shadowRootSerializable()Sets the shadowrootserializable attribute.Template
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
getTag() protectedReturns the tag enumeration for the <template> element.Template
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the block element.UIAwesome\Html\Core\Element\BaseBlock
runBegin() protectedReturns the opening tag for begin/end rendering.UIAwesome\Html\Core\Element\BaseBlock
public function shadowRootClonable(bool $value): static

Sets the shadowrootclonable attribute.

Parameters

ParameterTypeDescription
$valueboolWhether to allow cloning the generated shadow root.

Returns

static: New instance with the updated shadowrootclonable attribute.

public function shadowRootDelegatesFocus(bool $value): static

Sets the shadowrootdelegatesfocus attribute.

Parameters

ParameterTypeDescription
$valueboolWhether to delegate focus into the generated shadow root.

Returns

static: New instance with the updated shadowrootdelegatesfocus attribute.

public function shadowRootMode(string|UnitEnum|null $value): static

Sets the shadowrootmode attribute.

Parameters

ParameterTypeDescription
$valuestring|UnitEnum|nullShadow root mode (‘open’ or ‘closed’), or null to remove the attribute.

Returns

static: New instance with the updated shadowrootmode attribute. ShadowRootMode for predefined enum values.

Throws

public function shadowRootReferenceTarget(string|Stringable|UnitEnum|null $value): static

Sets the shadowrootreferencetarget attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullReference target ID, or null to remove the attribute.

Returns

static: New instance with the updated shadowrootreferencetarget attribute.

public function shadowRootSerializable(bool $value): static

Sets the shadowrootserializable attribute.

Parameters

ParameterTypeDescription
$valueboolWhether to allow serializing the generated shadow root.

Returns

static: New instance with the updated shadowrootserializable attribute.

protected function getTag(): UIAwesome\Html\Interop\MetadataBlock

Returns the tag enumeration for the <template> element.

Returns

MetadataBlock: Tag enumeration instance for <template>. MetadataBlock for valid metadata block-level tags.