Skip to content

JS API

The FigureVideo component mixes in the Transition behavior and declares the in-view mount strategy, so it mounts when it crosses into the viewport and unmounts when it leaves. It inherits the transition API; see that reference too. Adjust the margin with data-mount="in-view:<rootMargin>".

Options

lazy

  • Type: boolean
  • Default: false

Enables lazy loading. The source is read from the data-src attribute of the video ref's sources.

Refs

video

  • Type: HTMLVideoElement

The FigureVideo component should have a ref corresponding to its inner <video /> element. This <video /> element must contain at least one <source /> element.