Skip to content

Commit 82ab935

Browse files
committed
moved methods and unimplemented features section from readme to docs/api.md
1 parent e58fc07 commit 82ab935

File tree

2 files changed

+28
-21
lines changed

2 files changed

+28
-21
lines changed

README.md

+2-21
Original file line numberDiff line numberDiff line change
@@ -79,27 +79,8 @@ class SimpleSlider extends React.Component {
7979
For all available props, go [here](https://react-slick.neostack.com/docs/api/).
8080

8181
### Methods
82-
Name | Arguments | Description
83-
------------------|-----------------|-------------------------
84-
`slickPrev` | None | go to previous slide
85-
`slickNext` | None | go to next slide
86-
`slickGoTo` | index, dontAnimate| go to the given slide index
87-
`slickPause` | None | pause the autoplay
88-
`slickPlay` | None | start the autoplay
89-
90-
91-
#### Followings are not going to be implemented
92-
Name |type | Reason
93-
------------------|-----------------|-------------------
94-
`unslick` | method | same functionality can be achieved with `unslick` prop
95-
`slickSetOption` | method | same functionality can be achieved via props and managing state for them in wrapper
96-
`slickFilter` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
97-
`slickUnfilter` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
98-
`slickAdd` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
99-
`slickRemove` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
100-
`slickCurrentSlide`| method | same functionality can be achieved with `beforeChange hook`
101-
`slickGetOption` | method | manage wrapper state for desired options
102-
`getSlick` | method | a simple ref will do
82+
83+
For all available methods, go [here](https://react-slick.neostack.com/docs/api#methods)
10384

10485
#### `responsive` property
10586

docs/api.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Sections removed from readme
2+
============================
3+
4+
### Methods
5+
Name | Arguments | Description
6+
------------------|-----------------|-------------------------
7+
`slickPrev` | None | go to previous slide
8+
`slickNext` | None | go to next slide
9+
`slickGoTo` | index, dontAnimate| go to the given slide index
10+
`slickPause` | None | pause the autoplay
11+
`slickPlay` | None | start the autoplay
12+
13+
14+
#### Followings are not going to be implemented
15+
Name |type | Reason
16+
------------------|-----------------|-------------------
17+
`unslick` | method | same functionality can be achieved with `unslick` prop
18+
`slickSetOption` | method | same functionality can be achieved via props and managing state for them in wrapper
19+
`slickFilter` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
20+
`slickUnfilter` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
21+
`slickAdd` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
22+
`slickRemove` | method | same functionality can be achieved as with dynamic slides, look at dynamic slides [example](https://github.com/akiran/react-slick/blob/master/examples/DynamicSlides.js)
23+
`slickCurrentSlide`| method | same functionality can be achieved with `beforeChange hook`
24+
`slickGetOption` | method | manage wrapper state for desired options
25+
`getSlick` | method | a simple ref will do
26+

0 commit comments

Comments
 (0)