Skip to content
This repository was archived by the owner on May 2, 2019. It is now read-only.

Commit 069be1e

Browse files
committed
1 parent c19a148 commit 069be1e

File tree

2 files changed

+6
-33
lines changed

2 files changed

+6
-33
lines changed

README.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
React Flex Slick
22
================
33

4-
This is library aims to replace [react-slick][react-slick]
4+
This is library aims to replace [react-slick][react-slick].
55

66
Uses **flexbox** exclusively, so no support for older browsers :cry: :cry:
77

8-
On the bright side, it is extremly flexible. Currently only supports `react-0.14`
8+
On the bright side, it is extremly flexible. Currently only supports `react-0.13`
99

1010
## Examples
1111

@@ -15,36 +15,11 @@ To run the examples:
1515
2. `cd react-flex-slick && npm i`
1616
3. `npm start`
1717

18-
## Usage
19-
20-
```javascript
21-
import React from 'react';
22-
import { Slides, Slider,
23-
LeftArrow, RightArrow } from 'react-flex-slick';
24-
25-
class App extends React.Component {
26-
27-
render() {
28-
return (
29-
<Slider>
30-
<LeftArrow />
31-
<Slides>
32-
<MySlide1 />
33-
<MySlide2 />
34-
<MySlide3 />
35-
<MySlide4 />
36-
</Slides>
37-
<RightArrow />
38-
</Slider>
39-
);
40-
}
41-
}
42-
```
43-
4418
## What works
4519

20+
- Infinite and Non-infinite Mode
4621
- Horizontal and Vertical Sliding
47-
- One Slide per page
22+
- Multiple Slides per page (slidesToScroll = slidesToShow)
4823
- Left and Right Arrows to go back and forth
4924

5025
## TODO
@@ -61,12 +36,10 @@ class App extends React.Component {
6136
- [React SoundPlayer][react-soundplayer]
6237
- [Smart and Dumb Componenst][smart-dumb]
6338

64-
6539
## License
6640

6741
MIT
6842

69-
7043
[react-slick]: https://github.com/akiran/react-slick
7144
[react-soundplayer]: https://github.com/soundblogs/react-soundplayer
7245
[smart-dumb]: https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-flex-slick",
3-
"version": "0.2.0",
3+
"version": "0.3.0",
44
"description": "Slick carousel using Flexbox",
55
"main": "./lib/index.js",
66
"scripts": {
@@ -48,6 +48,6 @@
4848
"webpack-hot-middleware": "^2.0.1"
4949
},
5050
"peerDependencies": {
51-
"react": ">= 0.14 || ^0.14.0-rc"
51+
"react": ">=0.13 || ^0.14.0-alpha"
5252
}
5353
}

0 commit comments

Comments
 (0)