# react-flickity

> Flickity component for React

Latest version **1.0.8** (published 2016-03-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-flickity
pnpm add react-flickity
yarn add react-flickity
bun add react-flickity
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2016-03-07 |
| First published | 2016-02-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Juven A. Pajares |
| Maintainers | shingou |
| Keywords | react, flickity, component, slider, carousel |

## Links

- npm: https://www.npmjs.com/package/react-flickity
- Repository: https://github.com/juvenpajares/react-flickity
- Homepage: https://github.com/juvenpajares/react-flickity#readme
- Issues: https://github.com/juvenpajares/react-flickity/issues
- npm.io page: https://npm.io/package/react-flickity

## Dependencies (1)

- [flickity-fix](https://npm.io/package/flickity-fix.md) ^1.1.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2016-03-07
- 1.0.2 — 2016-02-11
- 1.0.1 — 2016-02-11
- 1.0.0 — 2016-02-10

## README

# Flickity React
Flickity component for React

### Installation
```bash
  npm install flickity --save
  npm install react-flickity --save
```

### Add loaders to webpack config and production files
```js
module: {
    loaders: [
      {
        test: /flickity/,
        loader: 'imports?define=>false&this=>window'
      }
    ]
  }
```

### Download and import flickity to your css

+ CSS:
  - [flickity.css](https://raw.githubusercontent.com/juvenpajares/react-flickity/master/lib/flickity.css)

### Example
```js
var React = require('react')
var Flickity = require('react-flickity')

var flickityOptions = {
    initialIndex: 0,
    cellSelector: '.sliderBoxes',
    accessibility: true,
    pageDots: true,
    wrapAround: true,
    autoPlay: 3000 // default false
}

var Carousel = React.createClass({
    render: function () {
    return (
      <Flickity
        className={ 'carousel' } // default ''
        elementType={ 'div' } // default 'div'
        options={ flickityOptions } // takes flickity options {}
        disableImagesLoaded={ false } // default false
      >
        <div className="sliderBoxes"></div>
        <div className="sliderBoxes"></div>
        <div className="sliderBoxes"></div>
      </Flickity>
    );
  }
});

module.exports = Carousel;
});
```

---
_Source: https://npm.io/package/react-flickity · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._