https://github.com/gem-mine/rc-slick

fork from https://github.com/akiran/react-slick
https://github.com/gem-mine/rc-slick

Last synced: about 1 month ago
JSON representation

fork from https://github.com/akiran/react-slick

• Host: GitHub
• URL: https://github.com/gem-mine/rc-slick
• Owner: gem-mine
• License: mit
• Created: 2019-09-23T13:30:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-30T11:18:45.000Z (about 3 years ago)
• Last Synced: 2024-04-13T19:06:05.763Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 156 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
### react-slick

[![Backers on Open Collective](https://opencollective.com/react-slick/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/react-slick/sponsors/badge.svg)](#sponsors) [![Join the chat at https://gitter.im/akiran/react-slick](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/akiran/react-slick?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

##### Carousel component built with React. It is a react port of [slick carousel](http://kenwheeler.github.io/slick/)

## [Documentation](http://react-slick.neostack.com)

### Installation

**npm**

```bash

npm install react-slick --save

```

**yarn**

```bash

yarn add react-slick

```

**Also install slick-carousel for css and font**

```bash

npm install slick-carousel

// Import css files

import "slick-carousel/slick/slick.css";

import "slick-carousel/slick/slick-theme.css";

```

or add cdn link in your html

```html

```

### [PlayGround](https://codesandbox.io/s/ppwkk5l6xx)

### Example

```js

import React from "react";

import Slider from "react-slick";

export default function SimpleSlider() {

  var settings = {

    dots: true,

    infinite: true,

    speed: 500,

    slidesToShow: 1,

    slidesToScroll: 1

  };

  return (

    

      


        
1

      

      


        
2

      

      


        
3

      

      


        
4

      

      


        
5

      

      


        
6

      

    

  );

}

```


### Props

For all available props, go [here](https://react-slick.neostack.com/docs/api/).

### Methods

For all available methods, go [here](https://react-slick.neostack.com/docs/api#methods)

### Development

Want to run demos locally

```bash

git clone https://github.com/akiran/react-slick

cd react-slick

npm install

npm start

open http://localhost:8080

```

## Contributing

Please see the [contributing guidelines](./CONTRIBUTING.md)