HTML <template> Tag

The HTML <template> tag allows you to declare fragments HTML fragments that can be cloned and inserted into the document by script.

The <template> tag allows you to declare HTML fragments that are not used when the document loads, but can be used later (upon a given user action for example).

The contents of the <template> element are not part of the document until you use it. Therefore, until you use it, none of its contents are downloaded, and you can't reference it via the DOM.

When the contents of the <template> element are used, they are cloned and inserted into the DOM. Therefore, you can use it multiple times, and you can even add to its contents.

Syntax

The <template> tag is written as <template></template> with the template content between the start and end tags.

The global id attribute can be used so that scripts can refer to the element.

Like this:

Example

Basic Usage

Here's an example of the <template> element being used in conjunction with JavaScript. Clicking the button will clone the contents of the <template> element and insert it into the DOM.

<!-- Template Content -->
<template id="myTemplate">
<p>Template content. Click again...</p>
</template>

<!-- Normal Content -->
<div id="normalContent">
<p>Normal content</p>
</div>

<!-- JavaScript function: Clones the template and appends it to the normal content -->
<button onclick="useTemplate();">Use Template!</button>
<script>
function useTemplate() {
var myTemplate = document.getElementById('myTemplate'),
    normalContent = document.getElementById('normalContent'),
    clonedTemplate = myTemplate.content.cloneNode(true);
    normalContent.appendChild(clonedTemplate);
    }
</script>

Add Table Rows

Here's an example of adding rows to an editable table using the <template> tag.

<!DOCTYPE html>
<title>Example</title>
<style>
#myTable {
border-collapse:collapse;
}
#myTable td, 
#myTable th {
padding:5px;
border:1px solid #ccc;
}
#myTable th {
background-color:#eee;
}
</style>
<!-- JavaScript function: Clones the template and appends it to the normal content -->
<button onclick="addRow();">Add Row</button>

<!-- Template Content -->
<template id="newRow">
<tr><td>Cell</td><td>Cell</td><td>Cell</td></tr>
</template>

<!-- Normal Content -->
<table id="myTable" contenteditable>
<tr><th>Header 1</th><th>Header 2</th><th>Header 3</th></tr>
</table>

<script>
function addRow() {
var myTemplate = document.getElementById('newRow'),
    normalContent = document.getElementById('myTable'),
    clonedTemplate = myTemplate.content.cloneNode(true);
    normalContent.appendChild(clonedTemplate);
    }
</script>

Attributes

Attributes can be added to an HTML element to provide more information about how the element should appear or behave.

There are 3 kinds of attributes that you can add to your HTML tags: Element-specific, global, and event handler content attributes.

The <template> element accepts the following attributes.

Element-Specific Attributes

This table shows the attributes that are specific to the <template> tag/element.

Attribute	Description
None

Global Attributes

The following attributes are standard across all HTML5 elements. Therefore, you can use these attributes with the <template> tag , as well as with all other HTML tags.

accesskey
class
contenteditable
contextmenu
dir
draggable
dropzone
hidden
id
inert
itemid
itemprop
itemref
itemscope
itemtype
lang
spellcheck
style
tabindex
title
translate

For a full explanation of these attributes, see HTML 5 global attributes.

Event Handler Content Attributes

Event handler content attributes enable you to invoke a script from within your HTML. The script is invoked when a certain "event" occurs. Each event handler content attribute deals with a different event.

Below are the standard HTML5 event handler content attributes.

Again, you can use any of these with the <template> element, as well as any other HTML5 element.

onabort
oncancel
onblur
oncanplay
oncanplaythrough
onchange
onclick
oncontextmenu
ondblclick
ondrag
ondragend
ondragenter
ondragexit
ondragleave
ondragover
ondragstart
ondrop
ondurationchange
onemptied
onended
onerror
onfocus
onformchange
onforminput
oninput
oninvalid
onkeydown
onkeypress
onkeyup
onload
onloadeddata
onloadedmetadata
onloadstart
onmousedown
onmousemove
onmouseout
onmouseover
onmouseup
onmousewheel
onpause
onplay
onplaying
onprogress
onratechange
onreadystatechange
onscroll
onseeked
onseeking
onselect
onshow
onstalled
onsubmit
onsuspend
ontimeupdate
onvolumechange
onwaiting

For a full explanation of these attributes, see HTML 5 event handler content attributes.

Differences Between HTML 4 & HTML 5

The <template> element is new in HTML5.

To see more detail on the two versions see HTML5 <template> Tag. Also check out the links to the official specifications below.

Template

Here's a template for the <template> tag with all available attributes for the tag (based on HTML5). These are grouped into attribute types, each type separated by a space. In many cases, you will probably only need one or two (if any) attributes. Simply remove the attributes you don't need.

Note that the <template> element does not actually have any local attributes (i.e. attributes that are specific to the element), but the following global attributes and event handlers are available to the element (and all other HTML elements).

For more information on attributes for this tag, see HTML5 <template> Tag.

Tag Details

For more details about the <template> tag, see HTML5 <template> Tag.

Specifications

Here are the official specifications for the <template> element.

HTML5 Specification (W3C)
HTML Living Standard (WHATWG)
Current W3C Draft (the next version that is currently being worked on)

What's the Difference?

W3C creates "snapshot" specifications that don't change once defined. So the HTML5 specification won't change once it becomes an official recommendation. WHATWG on the other hand, develops a "living standard" that is updated on a regular basis. In general, you will probably find that the HTML living standard will be more closely aligned to the current W3C draft than to the HTML5 specification.

Web.QHMIT.com