pmx-carousel

2.0.0-0 • Public • Published

PMX Carousel:

Intro

Module to generate an accessible carousel slider

Getting Started

import carousel from '../src/pmx-carousel';
import './main.scss';
 

How to use

Setup

The module is exported as an UMD module so it can be used with AMD, CommonJS, ES Modules and in the browser.

  • Install the dependency Using Yarn
yarn add pmx-carousel

or using NPM

npm install pmx-carousel --save
  • Include the module

CommonJS

const inert = require('pmx-carousel').default;

ES2015 modules

import inert from 'pmx-carousel';

API

.init(config, shared):

Initializes the component.

.stop(config, shared)

Stops the component by removing all added mutations.

Browser Support

  • IE 10+
  • Chrome
  • Firefox
  • Safari

Dependencies

This library has been written with some ES2015 features that need to be polyfilled:

  • Map
  • Object.assign

Readme

Keywords

none

Package Sidebar

Install

npm i pmx-carousel

Weekly Downloads

32

Version

2.0.0-0

License

none

Last publish

Collaborators

  • framini