Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including react-flickity-component with all npm packages installed. Try it out:

require("flickity/package.json"); // flickity is a peer dependency. require("react/package.json"); // react is a peer dependency. require("react-dom/package.json"); // react-dom is a peer dependency. var reactFlickityComponent = require("react-flickity-component")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

react-flickity-component v3.5.0

react flickity component

React Flickity Component

Greenkeeper badge build status dependencies styled with prettier


A React.js Flickity component.


npm install react-flickity-component --save
// Or
yarn add react-flickity-component


// Commonjs
const Flickity = require('flickity');
// Or for ES2015 module
import Flickity from 'react-flickity-component'

const flickityOptions = {
    initialIndex: 2

function Carousel() {
  return (
      className={'carousel'} // default ''
      elementType={'div'} // default 'div'
      options={flickityOptions} // takes flickity options {}
      disableImagesLoaded={false} // default false
      reloadOnUpdate // default false
      static // default false
      <img src="/images/placeholder.png"/>
      <img src="/images/placeholder.png"/>
      <img src="/images/placeholder.png"/>

Example Usage:

See a codesandbox example here:

See an example with server side rendering:

And with typescript:


classNameString''Applied to top level wrapper
elementTypeString'div'Wrapper's element type
optionsObject{}Flickity initialization opions
disableImagesLoadedBooleanfalseDisable call reloadCells images are loaded
flickityRefFunctionLike ref function, get Flickity instance in parent component
reloadOnUpdateBooleanfalseRead next section before you set this prop. Run reloadCells and resize on componentDidUpdate
staticBooleanfalseRead next section before you set this prop. Carousel contents are static and not updated at runtime. Useful for smoother server-side rendering however the carousel contents cannot be updated dynamically.

How it works

Under the hood, react-flickity-component uses a React Portal to render children slides inside a Flickity instance. The need for a portal is because after Flickity is initialized, new DOM nodes (mostly Flickity wrapper elements) would be created, this changes the DOM hierarchy of the parent component, thus any future update, whether it's originated from Flickity, like adding/removing slides, or from parent, like a prop changes, will make React fail to reconcile for the DOM snapshot is out of sync.

#64 introduced a new prop to change the underlying render method: instead of portal, react-flickity-component will directly render children. This is create a smoother server-side rendering experience, but please be aware using static prop possibly will cause all your future update to fail, which means adding/removing slides will definitely fail to render, so use with caution.

However there is a fail-safe option reloadOnUpdate. It means every time there is a update, we tear down and set up Flickity. This will ensure that Flickity is always rendered correctly, but it's a rather costly operation and it will cause a flicker since DOM nodes are destroyed and recreated.

Use Flickity's API and events

You can access the Flickity instance with flickityRef prop just like ref, and use this instance to register events and use API.

class Carousel extends React.Component {

  componentDidMount = () => {
    // You can register events in componentDidMount hook
    this.flkty.on('settle', () => {
      console.log(`current index is ${this.flkty.selectedIndex}`)

  myCustomNext = () => {
    // You can use Flickity API

  render() {
    return (
      <Flickity flickityRef={c => this.flkty = c}>
        <img src="/images/placeholder.png"/>
        <img src="/images/placeholder.png"/>
        <img src="/images/placeholder.png"/>
      <Button onClick={myCustomNext}>My custom next button</Button>

License Information:


Flickity may be used in commercial projects and applications with the one-time purchase of a commercial license.

See this issue for more information

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free