@yoursurprise/slider 0.0.8 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# React slider
|
|
1
|
+
# React slider (alpha)
|
|
2
2
|
|
|
3
3
|
This package contains a basic modern slider. The purpose of this slider is to provide a simple React component
|
|
4
4
|
which can be controlled in a userfriendly way on mobile, tablet and desktop.
|
|
@@ -11,20 +11,27 @@ This slider has the following features:
|
|
|
11
11
|
- Support for multiple variable width slides
|
|
12
12
|
|
|
13
13
|
Before using this slider, please consider the following:
|
|
14
|
+
- This project is still being set up, this is an alpha version
|
|
14
15
|
- The slider only contains styling to make it functional
|
|
15
16
|
- There is no configuration of aforementioned features (yet)
|
|
16
17
|
|
|
18
|
+
Todos:
|
|
19
|
+
- Add a demo page
|
|
20
|
+
- Add more configuration
|
|
21
|
+
- Add end-to-end tests
|
|
22
|
+
- Set up proper workflows in GitHub
|
|
23
|
+
|
|
17
24
|
All browsers with [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) are supported.
|
|
18
25
|
|
|
19
26
|
## Installation
|
|
20
27
|
|
|
21
28
|
### npm
|
|
22
29
|
|
|
23
|
-
`npm install @
|
|
30
|
+
`npm install @yoursurprise/slider --save`
|
|
24
31
|
|
|
25
32
|
### yarn
|
|
26
33
|
|
|
27
|
-
`yarn add @
|
|
34
|
+
`yarn add @yoursurprise/slider`
|
|
28
35
|
|
|
29
36
|
### Import the CSS files
|
|
30
37
|
|
|
@@ -33,8 +40,8 @@ All browsers with [IntersectionObserver](https://developer.mozilla.org/en-US/doc
|
|
|
33
40
|
### Implement the Slider
|
|
34
41
|
|
|
35
42
|
```
|
|
36
|
-
import { Slider } from '@
|
|
37
|
-
import '@
|
|
43
|
+
import { Slider } from '@yoursurprise/slider';
|
|
44
|
+
import '@yoursurprise/slider/dist/index.css';
|
|
38
45
|
|
|
39
46
|
export default function YourComponent() {
|
|
40
47
|
return (
|