Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 2.86 KB

amp-html-templates.md

File metadata and controls

81 lines (59 loc) · 2.86 KB
Raw

AMP HTML Templates

Overview

The AMP templating system allows AMP elements to render dynamic content using templates defined within the AMP document. The data for templates is received from a CORS JSON endpoint.

The templates are defined using a templating language exported by an AMP templating extension. For example, "amp-mustache" templates are defined using Mustache.js syntax. However, any templating language has its syntax restricted and verified by the AMP validator to ensure that XSS and other issues cannot be dynamically injected into the AMP document.

Declaration

Before AMP templates can be used, the templating system has to be declared in the document's head:

<script
  async
  custom-template="amp-mustache"
  src="https://cdn.ampproject.org/v0/amp-mustache-0.2.js"
></script>

The script tag must be declared as async and with the custom-template attribute. See the AMP Spec for more detail.

Security

All AMP template implementations must go through the AMP security review before they can be submitted to the AMP repository.

Usage

Templates can be defined anywhere in the AMP document's body, like this:

<!--
Using the template tag

The `type` attribute must reference the template's type as defined in the `custom-template` attribute when the templating system was imported in the document's `head`.
-->
<template type="amp-mustache">
  Hello {{world}}!
</template>

or like this:

<!--
Using the script tag

The template type is defined in the `template` attribute. The template
tag is preferred but using the script tag can be helpful when working with
tables or server-side rendering.
-->
<script type="text/plain" template="amp-mustache">
  Hello {{world}}!
</script>

The use of the template is up to a specific AMP element that wants to use it. An AMP element would typically look for a template within its children or using a template's ID. For instance, an amp-carousel element may (in the future) use a CORS endpoint and an AMP template to load and render a dynamic set of slides.

API

AMP elements can use templates.renderTemplate methods to render a template. It is up to a specific AMP element how templateElement and data are provided.

Templates

Here's a list of available templates:

Template Description
amp-mustache Allows rendering of Mustache.js templates.