Skip to content
πŸŒ„ A web component that displays a set of images with a ken burns effect
Branch: master
Clone or download

README.md

<ken-burns-carousel>

Travis

A bare and extremely light web component that displays a set of images with a ken burns effect. Demo.

Usage

Import the JS:

/*
 * Importing directly from the element defines the element class
 * and registers it with the global element registry with the tag
 * name 'ken-burns-carousel'.
 */
import 'ken-burns-carousel';

Alternatively:

/*
 * In case the default name conflicts, you can import from
 * 'ken-burns-element/dist/element'. This export _does not_ register
 * the element with the element registry and allows you to choose
 * a custom tag name.
 */
import KenBurnsElement from 'ken-burns-carousel/dist/element';

customElements.define('custom-ken-burns-element-tag', KenBurnsElement);

Use the element in the DOM:

<!-- Set images to display via attribute (property is also supported) -->
<ken-burns-carousel images="https://source.unsplash.com/Qh9Swf_8DyA https://source.unsplash.com/O453M2Liufs">
</ken-burns-carousel>

And the carousel will begin fading images ✨. See the Demo for more examples.

Compatibility

The element works in all evergreen browsers (tested on Firefox, Chrome, Safari and Edge). Mileage with other browsers may vary.

That said, the element does not do any complex DOM operations or use any fancy APIs (except for web components, of course), so adapting it, if needed, will be simple. The element has been adapted for usage with the ShadyDOM polyfill.

Performance

The element makes careful use of composition layers and uses CSS 3D transforms and opacity animations exclusively. As such, animations will run butter smooth even when expensive filters are applied to the images.

The element also preloads images before displaying them so that FOUCs are prevented. This also works across different image lists. For optimal results, ensure the element has a nice background color as the element is transparent while the first image is loading.

License

MIT

You can’t perform that action at this time.