solid-slider 1.2.6 → 1.2.7
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 +11 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](https://www.npmjs.com/package/solid-slider)
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
A carousel/slider implementation in TypeScript for SolidJS. It's built on
|
|
7
|
+
A carousel/slider implementation in TypeScript for SolidJS. It's built on Keen-Slider 6, an open-source library agnostic touch slider with native touch/swipe behavior and great performance. It comes with no dependencies, TypeScript support, multitouch support and is compatible with all common browsers.
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
@@ -16,7 +16,7 @@ yarn add solid-slider ## or in yarn
|
|
|
16
16
|
Add as a module:
|
|
17
17
|
|
|
18
18
|
```ts
|
|
19
|
-
import "solid-slider/
|
|
19
|
+
import "solid-slider/slider.css";
|
|
20
20
|
import createSlider from "solid-slider";
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -26,7 +26,11 @@ You can find a functional demo of the slider with most features implemented here
|
|
|
26
26
|
|
|
27
27
|
## Plugins
|
|
28
28
|
|
|
29
|
-
Plugins may be added directly via the createSlider primitive. You may add a
|
|
29
|
+
Plugins may be added directly via the createSlider primitive. You may add a Keen-Slider plugin directly or built-in plugins shipped with this package. Currently an autoplay plugin is available that will assist with autoplaying actions in the slider. Simply add the plugins after the options parameter. Please feel free to post requests for additional plugins or submit PRs if you decide to improve the base functionality. Some ideas for additional plugins include:
|
|
30
|
+
|
|
31
|
+
- Slider nav (dot, arrow controls even thumbnails)
|
|
32
|
+
- Lazy loaded images
|
|
33
|
+
- Slide transitions
|
|
30
34
|
|
|
31
35
|
### Autoplay
|
|
32
36
|
|
|
@@ -86,17 +90,17 @@ const MyComponent = () => {
|
|
|
86
90
|
|
|
87
91
|
## Implementation
|
|
88
92
|
|
|
89
|
-
Solid Slider is meant to be a lightweight and compact wrapper of
|
|
93
|
+
Solid Slider is meant to be a lightweight and compact wrapper of Keen-Slider. It exposes helpers to make working with the slider convenient. Note that the when the slider mounts it assumes all children in the el are slides. You can override this functionality by passing in a "selector" value to target the specific slides you'd like to include.
|
|
90
94
|
|
|
91
|
-
Thie library exports it's own CSS which is the basic
|
|
95
|
+
Thie library exports it's own CSS which is the basic Keen-Slider implementation for convenience. If you supply options as an accessor function, the slider will reactively update the configuration so that you don't have to destroy and recreate the slider. As of Keen-Slider 6 plugins are now fully supported. You may supply them as a param in createSlider. Note that plugins are not reactively updated and must be supplied on creation.
|
|
92
96
|
|
|
93
97
|
## Changelog
|
|
94
98
|
|
|
95
99
|
- 1.0.0 - Initial release
|
|
96
100
|
- 1.0.3 - Changed the exported API to be slightly more flexible.
|
|
97
|
-
- 1.1.1 - Upgraded to
|
|
101
|
+
- 1.1.1 - Upgraded to Keen-Slider 6 and improved general reactivity.
|
|
98
102
|
- 1.2.5 - Added autoplay plugin and general plugin structure
|
|
99
|
-
- 1.2.
|
|
103
|
+
- 1.2.7 - Maybe I should actually export the .css? That'd be a good idea, right?
|
|
100
104
|
|
|
101
105
|
## Keen Options API
|
|
102
106
|
|