AMP

amp-bodymovin-animation

Description

Displays an AirBnB Bodymovin animation player.

 

Required Scripts

<script async custom-element="amp-bodymovin-animation" src="https://cdn.ampproject.org/v0/amp-bodymovin-animation-0.1.js"></script>

Usage

The <amp-bodymovin-animation> component embeds an AirBnB Bodymovin animation player, which renders an animation from JSON generated by Adobe After Effects.

The width and height attributes determine the aspect ratio of the animation embedded in responsive layouts.

<amp-bodymovin-animation
  layout="fixed"
  width="200"
  height="200"
  src="https://nainar.github.io/loader.json"
  loop="5"
>
</amp-bodymovin-animation>

Attributes

src

The path to the exported Bodymovin animation object. Must be https protocol.

loop (optional)

Indicates whether the animation should be looping or not. By default, this attribute is set to true. Values for this attribute can be: true, false, or a number value. If a number is specified, the animation loops that number of times.

noautoplay (optional)

By default, an animation autoplays. If this attribute is added the video waits for an action to start playing.

renderer (optional)

Multiple renderers are supported and can be specified:

  • canvas
  • html
  • svg (default)

title (optional)

Define a title attribute for the component to propagate to the underlying <iframe> element. The default value is "Airbnb BodyMovin animation".

Common attributes

This element includes common attributes extended to AMP components.

Actions

play

Plays the animation.

pause

Pauses the animation.

stop

Stops the animation.

seekTo(time=INTEGER)

Sets the currentTime of the animation to the specified value and pauses animation.

seekTo(percent=[0,1])

Uses the given percentage value to determine the currentTime of the animation to the specified value and pauses animation.

Validation

See amp-bodymovin-animation rules in the AMP validator specification.

Need more help?

You've read this document a dozen times but it doesn't really cover all of your questions? Maybe other people felt the same: reach out to them on Stack Overflow.

Go to Stack Overflow
Found a bug or missing a feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Go to GitHub