Docs / plugins

Plugins.

Opt-in capabilities. Each is a separate package. Import only what you need.

Usage

import snapdeck from '@snapdeck/core';
import { navDots } from '@snapdeck/plugin-nav-dots';
import { progressBar } from '@snapdeck/plugin-progress-bar';
import '@snapdeck/plugin-nav-dots/css';
import '@snapdeck/plugin-progress-bar/css';

snapdeck('#deck', {
  plugins: [
    navDots(),
    progressBar({ position: 'top' }),
  ],
});

Built-in

name	package	demo
`nav-dots`	`@snapdeck/plugin-nav-dots`	see →
`progress-bar`	`@snapdeck/plugin-progress-bar`	see →
`lazy-media`	`@snapdeck/plugin-lazy-media`	see →
`observer`	`@snapdeck/plugin-observer`	see →

Authoring

A plugin is a factory returning { name, setup(instance) }. Register via the plugins option.