Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsmrakhil/react-styled-carousel
React styled components carousel or slide show. No external css import is required.
https://github.com/itsmrakhil/react-styled-carousel
carousel react react-carousel react-slider slider styled-components
Last synced: 1 day ago
JSON representation
React styled components carousel or slide show. No external css import is required.
- Host: GitHub
- URL: https://github.com/itsmrakhil/react-styled-carousel
- Owner: ItsMrAkhil
- License: mit
- Created: 2018-02-21T12:31:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T11:14:58.000Z (3 months ago)
- Last Synced: 2024-12-21T13:08:31.071Z (1 day ago)
- Topics: carousel, react, react-carousel, react-slider, slider, styled-components
- Language: JavaScript
- Homepage:
- Size: 3.12 MB
- Stars: 44
- Watchers: 6
- Forks: 26
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Styled Slider
**React Styled Slider** is a react and styled component slider. It is fully configurable.
[](https://travis-ci.org/ItsMrAkhil/react-styled-carousel)
[](https://coveralls.io/github/ItsMrAkhil/react-styled-carousel?branch=coveralls)
#### Features
- Mostly configurable
- Styled-Components
- No external CSS required.
- Server Side Rendering supported
> **Note:** **Server Side Rendering** works well without the styled-components collectStyles function also. But for better user experience please use **collectStyles** function from **styled-components**
#### Installation
```sh
$ npm install --save react-styled-carousel
```
#### Running example in local
```sh
$ git clone github.com/itsMrAkhil/react-styled-carousel
$ npm start
```
It'll open localhost:9000 port, where you can see live demo.
#### Example
```js
import React from 'react';
import ReactDOM from 'react-dom'
import Slider from 'react-styled-carousel';
const ExampleSlider = () => (
1
2
3
4
);
ReactDOM.render(, document.getElementById('root'));
```
#### Responsive
`react-styled-carousel` is responsive. Below is the example configuration of responsiveness.
> **Note:** If `responsive` prop is provided then, it'll override the cardsToShow prop. In other words cardsToShow will not work.
```js
import React from 'react';
import ReactDOM from 'react-dom'
import Slider from 'react-styled-carousel';
const responsive = [
{ breakPoint: 1280, cardsToShow: 4 }, // this will be applied if screen size is greater than 1280px. cardsToShow will become 4.
{ breakPoint: 760, cardsToShow: 2 },
];
const ExampleSlider = () => (
1
2
3
4
);
ReactDOM.render(, document.getElementById('root'));
```
#### Configurable Props
Props | Type | Default Value | Description
----- | ---- | ------------- | -----------
`showArrows` | `Boolean` | `true` | If `true` then only Arrows of navigation will be shown
`showDots` | `Boolean` | `true` | Show navigation or pagination dots below the slider
`infinite` | `Boolean` | `true` | Infinitely slide cards.
`Dot` | `React Node` | Default | Customized pagination button (`Active slide Dot` will get `active` as `Boolean` prop.)
`DotsWrapper` | `Styled Element` | Default | Customized wrapper for your component to change the view of dots wrapper like position, background, etc. `Note: It should be a styled ul, otherwise you may not see any Dot Components.`
`LeftArrow` | `React Node` | Default | Customized left arrow button. It'll get `disabled Boolean` prop if first Dot is active and infinite is false.
`RightArrow` | `React Node` | Default | Customized right arrow button. It'll get `disabled Boolean` prop if last Dot is active and infinite is false.
`children` | `React Node` | null | Cards are components which you want to show in the carousel
`cardsToShow` | `Number` | Children length | How many cards to be shown for a single slide.
`afterSlide` | `Function` | null | This function will be executed after every sliding is completed
`beforeSlide` | `Function` | null | This function will be executed before starting every sliding
`responsive` | `Array` | null | Use this for responsiveness [Documentation](#responsive)
`autoSlide` | `Number` or `Boolean` | `2000` | Used to make carousel auto slide for every given time interval. Or for 2000ms if the prop value is true.
`pauseOnMouseOver`| `Boolean` | `true` | Pause auto sliding on mouse over the carousel.
`hideArrowsOnNoSlides` | `Boolean` | `true` | Hide arrows if there is only one slide to show.
`margin`| `String` | `0px` | Any valid css margin value for giving margin around the slider
`padding` | `String` | `0px 20px` | Any valid css padding value for giving padding around the slider
License
----
MIT (**Free Software, Chill Yeah!**)