solid-slider 1.3.0 → 1.3.3

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.
@@ -0,0 +1,163 @@
1
+ import { createSignal, onMount, onCleanup, createEffect, on, createContext, useContext } from 'solid-js';
2
+ import KeenSlider from 'keen-slider';
3
+ import { createComponent, isServer, insert, effect, classList, delegateEvents, template } from 'solid-js/web';
4
+
5
+ /**
6
+ * Creates a slider powered by KeenSlider.
7
+ *
8
+ * @param {Object} options Values to initialize the slider with
9
+ * @param {Array} plugins Extensions that enhance KeenSlider options
10
+ * @returns {[create: Function, helpers: Object]} Returns mount and helper methods
11
+ * @returns {Function} create Mounts the slider on provided element
12
+ * @returns {Function} helpers.current Current slide number
13
+ * @returns {Function} helpers.current Current slide number
14
+ * @returns {Function} helpers.next Function to trigger the next slide
15
+ * @returns {Function} helpers.prev Function to trigger the previous slide
16
+ * @returns {Function<Object>} helpers.details Provides details about the current slider
17
+ * @returns {Function} helpers.slider Returns the KeenSlider instance
18
+ * @returns {Function} helpers.destroy Manual destroy function
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const [create, { prev, next }] = createSlider();
23
+ * <div use:slider>...</div>
24
+ * ```
25
+ */
26
+ const createSlider = (options, ...plugins) => {
27
+ let slider;
28
+
29
+ const opts = () => typeof options == "function" ? options() : options;
30
+
31
+ const [current, setCurrent] = createSignal(opts()?.initial || 0);
32
+
33
+ const destroy = () => slider && slider.destroy(); // Slider creation method and directive function
34
+
35
+
36
+ const create = el => {
37
+ el.classList.add("keen-slider"); // @ts-ignore
38
+
39
+ const getOptions = () => ({
40
+ selector: el.childNodes,
41
+ ...opts()
42
+ });
43
+
44
+ onMount(() => {
45
+ slider = new KeenSlider(el, getOptions(), plugins);
46
+ slider.on("slideChanged", () => setCurrent(slider.track.details.rel));
47
+ });
48
+ onCleanup(destroy);
49
+
50
+ if (typeof options === "function") {
51
+ createEffect(on(() => options, () => slider && slider.update(getOptions())));
52
+ }
53
+ };
54
+
55
+ return [create, {
56
+ current,
57
+ next: () => slider && slider.next(),
58
+ prev: () => slider && slider.prev(),
59
+ details: () => slider ? slider.track.details : {},
60
+ slider: () => slider,
61
+ moveTo: (id, duration = 250, absolute = false, easing) => slider?.moveToIdx(id, absolute, {
62
+ duration,
63
+ easing: easing
64
+ }),
65
+ destroy
66
+ }];
67
+ };
68
+
69
+ const _tmpl$ = /*#__PURE__*/template(`<div></div>`, 2),
70
+ _tmpl$2 = /*#__PURE__*/template(`<button></button>`, 2);
71
+
72
+ function returnType(func) {
73
+ return {};
74
+ }
75
+ // Main context for the slider
76
+ const SliderContext = createContext(createSignal(null));
77
+ /**
78
+ * A helpful and simple Provider to wrap your Slider if controls such as SliderButton are used.
79
+ *
80
+ * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.
81
+ * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.
82
+ */
83
+
84
+ const SliderProvider = props => createComponent(SliderContext.Provider, {
85
+ get value() {
86
+ return createSignal(null);
87
+ },
88
+
89
+ get children() {
90
+ return props.children;
91
+ }
92
+
93
+ });
94
+ /**
95
+ * Main Slider component for specifying the Slider on the page.
96
+ *
97
+ * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.
98
+ * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.
99
+ */
100
+
101
+ const Slider = props => {
102
+ if (isServer) return props.children;
103
+ const [, setHelpers] = useContext(SliderContext);
104
+ const [slider, helpers] = createSlider(props.options || {}, ...(props.plugins || []));
105
+ setHelpers(helpers);
106
+ return (() => {
107
+ const _el$ = _tmpl$.cloneNode(true);
108
+
109
+ slider(_el$, () => true);
110
+
111
+ insert(_el$, () => props.children);
112
+
113
+ return _el$;
114
+ })();
115
+ };
116
+ /**
117
+ * Provides a helpful button with next/prev to pair with your slider.
118
+ *
119
+ * @param props {boolean} next - Specify if this should be a next button.
120
+ * @param props {boolean} prev - Specify if this should be a prev button.
121
+ * @param props {string} class - Class to override the button.
122
+ * @param props {object} classList - List of classes to override the button.
123
+ */
124
+
125
+ const SliderButton = props => {
126
+ const context = useContext(SliderContext);
127
+
128
+ const changeSlide = () => {
129
+ if (context == null) return;
130
+ const [helpers] = context;
131
+ props.next ? helpers()?.next() : helpers()?.prev();
132
+ };
133
+
134
+ return (() => {
135
+ const _el$2 = _tmpl$2.cloneNode(true);
136
+
137
+ _el$2.$$click = changeSlide;
138
+
139
+ insert(_el$2, () => props.children);
140
+
141
+ effect(_p$ => {
142
+ const _v$ = props.disabled || false,
143
+ _v$2 = props.class,
144
+ _v$3 = props.classList;
145
+
146
+ _v$ !== _p$._v$ && (_el$2.disabled = _p$._v$ = _v$);
147
+ _v$2 !== _p$._v$2 && (_el$2.className = _p$._v$2 = _v$2);
148
+ _p$._v$3 = classList(_el$2, _v$3, _p$._v$3);
149
+ return _p$;
150
+ }, {
151
+ _v$: undefined,
152
+ _v$2: undefined,
153
+ _v$3: undefined
154
+ });
155
+
156
+ return _el$2;
157
+ })();
158
+ };
159
+
160
+ delegateEvents(["click"]);
161
+
162
+ export { Slider, SliderButton, SliderContext, SliderProvider, createSlider, returnType };
163
+ //# sourceMappingURL=index.module.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.module.js","sources":["../../src/primitive.ts","../../src/components.tsx"],"sourcesContent":["import { on, onMount, createSignal, onCleanup, Accessor, createEffect } from \"solid-js\";\nimport KeenSlider, {\n KeenSliderHooks,\n KeenSliderInstance,\n KeenSliderOptions,\n KeenSliderPlugin,\n TrackDetails\n} from \"keen-slider\";\n\ndeclare module \"solid-js\" {\n namespace JSX {\n interface Directives {\n slider: {};\n }\n }\n}\n\n/**\n * Creates a slider powered by KeenSlider.\n *\n * @param {Object} options Values to initialize the slider with\n * @param {Array} plugins Extensions that enhance KeenSlider options\n * @returns {[create: Function, helpers: Object]} Returns mount and helper methods\n * @returns {Function} create Mounts the slider on provided element\n * @returns {Function} helpers.current Current slide number\n * @returns {Function} helpers.current Current slide number\n * @returns {Function} helpers.next Function to trigger the next slide\n * @returns {Function} helpers.prev Function to trigger the previous slide\n * @returns {Function<Object>} helpers.details Provides details about the current slider\n * @returns {Function} helpers.slider Returns the KeenSlider instance\n * @returns {Function} helpers.destroy Manual destroy function\n *\n * @example\n * ```ts\n * const [create, { prev, next }] = createSlider();\n * <div use:slider>...</div>\n * ```\n */\nexport const createSlider = <O = {}, P = {}, H extends string = KeenSliderHooks>(\n options?: KeenSliderOptions<O, P, H> | Accessor<KeenSliderOptions<O, P, H>>,\n ...plugins: KeenSliderPlugin<O, P, H>[]\n): [\n create: (el: HTMLElement) => void,\n helpers: {\n current: Accessor<number>;\n next: Accessor<void>;\n prev: Accessor<void>;\n moveTo: (\n id: number,\n duration?: number,\n absolute?: boolean,\n easing?: (t: number) => number\n ) => void;\n details: Accessor<TrackDetails>;\n slider: Accessor<KeenSliderInstance<O, P, H> | undefined>;\n destroy: Accessor<void>;\n }\n] => {\n let slider: KeenSliderInstance<O, P, H> | undefined;\n const opts = () => typeof options == \"function\" ? options() : options;\n const [current, setCurrent] = createSignal(opts()?.initial || 0);\n const destroy = () => slider && slider.destroy();\n // Slider creation method and directive function\n const create = (el: HTMLElement) => {\n el.classList.add(\"keen-slider\");\n // @ts-ignore\n const getOptions: Accessor<KeenSliderOptions<O, P, H> | undefined> = () => ({\n selector: el.childNodes,\n ...(opts())\n });\n onMount(() => {\n slider = new KeenSlider<O, P, H>(el, getOptions(), plugins);\n slider.on(\"slideChanged\", () => setCurrent(slider!.track.details.rel));\n });\n onCleanup(destroy);\n if (typeof options === \"function\") {\n createEffect(\n on(\n () => options,\n () => slider && slider.update(getOptions())\n )\n );\n }\n };\n return [\n create,\n {\n current,\n next: () => slider && slider.next(),\n prev: () => slider && slider.prev(),\n details: () => (slider ? slider.track.details : ({} as TrackDetails)),\n slider: () => slider,\n moveTo: (id: number, duration = 250, absolute = false, easing?: (t: number) => number) =>\n slider?.moveToIdx(id, absolute, { duration, easing: easing }),\n destroy\n }\n ];\n};\n","import { Component, createContext, useContext, createSignal, createMemo } from \"solid-js\";\nimport { createSlider } from \"./primitive\";\nimport { KeenSliderOptions, KeenSliderPlugin } from \"keen-slider\";\nimport { isServer } from \"solid-js/web\";\n\n// The following is a hacky way of extracting SliderHelpers\ninterface Func<T> {\n ([...args]: any, args2?: any): T;\n}\nexport function returnType<T>(func: Func<T>) {\n return {} as T;\n}\nconst sliderValues = returnType(createSlider);\ntype SliderHelpers = typeof sliderValues[1];\n\n// Main context for the slider\nexport const SliderContext = createContext(createSignal<SliderHelpers | null>(null));\n\n/**\n * A helpful and simple Provider to wrap your Slider if controls such as SliderButton are used.\n *\n * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.\n * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.\n */\nexport const SliderProvider: Component = props => (\n <SliderContext.Provider value={createSignal(null)}>{props.children}</SliderContext.Provider>\n);\n\n/**\n * Main Slider component for specifying the Slider on the page.\n *\n * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.\n * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.\n */\nexport const Slider: Component<{\n options?: KeenSliderOptions;\n plugins?: KeenSliderPlugin[];\n}> = props => {\n if (isServer) return props.children;\n const [, setHelpers] = useContext(SliderContext);\n const [slider, helpers] = createSlider(props.options || {}, ...(props.plugins || []));\n setHelpers(helpers);\n slider;\n return <div use:slider>{props.children}</div>;\n};\n\n/**\n * Provides a helpful button with next/prev to pair with your slider.\n *\n * @param props {boolean} next - Specify if this should be a next button.\n * @param props {boolean} prev - Specify if this should be a prev button.\n * @param props {string} class - Class to override the button.\n * @param props {object} classList - List of classes to override the button.\n */\nexport const SliderButton: Component<{\n next?: boolean;\n prev?: boolean;\n disabled?: boolean;\n class?: string;\n classList?: { [k: string]: boolean | undefined };\n}> = props => {\n const context = useContext(SliderContext);\n const changeSlide = () => {\n if (context == null) return;\n const [helpers] = context;\n props.next ? helpers()?.next() : helpers()?.prev();\n };\n return (\n <button\n disabled={props.disabled || false}\n class={props.class}\n classList={props.classList}\n onClick={changeSlide}\n >\n {props.children}\n </button>\n );\n};\n"],"names":["createSlider","options","plugins","slider","opts","current","setCurrent","createSignal","initial","destroy","create","el","classList","add","getOptions","selector","childNodes","onMount","KeenSlider","on","track","details","rel","onCleanup","createEffect","update","next","prev","moveTo","id","duration","absolute","easing","moveToIdx","returnType","func","SliderContext","createContext","SliderProvider","props","_$createComponent","children","Slider","isServer","setHelpers","useContext","helpers","SliderButton","context","changeSlide","_$effect","disabled","class","_$classList"],"mappings":";;;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,YAAY,GAAG,CAC1BC,OAD0B,EAE1B,GAAGC,OAFuB,KAmBvB;AACH,EAAA,IAAIC,MAAJ,CAAA;;AACA,EAAMC,MAAAA,IAAI,GAAG,MAAM,OAAOH,OAAP,IAAkB,UAAlB,GAA+BA,OAAO,EAAtC,GAA2CA,OAA9D,CAAA;;AACA,EAAA,MAAM,CAACI,OAAD,EAAUC,UAAV,CAAwBC,GAAAA,YAAY,CAACH,IAAI,EAAII,EAAAA,OAAR,IAAmB,CAApB,CAA1C,CAAA;;AACA,EAAMC,MAAAA,OAAO,GAAG,MAAMN,MAAM,IAAIA,MAAM,CAACM,OAAP,EAAhC,CAJG;;;AAMH,EAAMC,MAAAA,MAAM,GAAIC,EAAD,IAAqB;AAClCA,IAAAA,EAAE,CAACC,SAAH,CAAaC,GAAb,CAAiB,aAAjB,EADkC;;AAGlC,IAAMC,MAAAA,UAA4D,GAAG,OAAO;AAC1EC,MAAAA,QAAQ,EAAEJ,EAAE,CAACK,UAD6D;AAE1E,MAAA,GAAIZ,IAAI,EAAA;AAFkE,KAAP,CAArE,CAAA;;AAIAa,IAAAA,OAAO,CAAC,MAAM;AACZd,MAAAA,MAAM,GAAG,IAAIe,UAAJ,CAAwBP,EAAxB,EAA4BG,UAAU,EAAtC,EAA0CZ,OAA1C,CAAT,CAAA;AACAC,MAAAA,MAAM,CAACgB,EAAP,CAAU,cAAV,EAA0B,MAAMb,UAAU,CAACH,MAAM,CAAEiB,KAAR,CAAcC,OAAd,CAAsBC,GAAvB,CAA1C,CAAA,CAAA;AACD,KAHM,CAAP,CAAA;AAIAC,IAAAA,SAAS,CAACd,OAAD,CAAT,CAAA;;AACA,IAAA,IAAI,OAAOR,OAAP,KAAmB,UAAvB,EAAmC;AACjCuB,MAAAA,YAAY,CACVL,EAAE,CACA,MAAMlB,OADN,EAEA,MAAME,MAAM,IAAIA,MAAM,CAACsB,MAAP,CAAcX,UAAU,EAAxB,CAFhB,CADQ,CAAZ,CAAA;AAMD,KAAA;AACF,GApBD,CAAA;;AAqBA,EAAO,OAAA,CACLJ,MADK,EAEL;AACEL,IAAAA,OADF;AAEEqB,IAAAA,IAAI,EAAE,MAAMvB,MAAM,IAAIA,MAAM,CAACuB,IAAP,EAFxB;AAGEC,IAAAA,IAAI,EAAE,MAAMxB,MAAM,IAAIA,MAAM,CAACwB,IAAP,EAHxB;AAIEN,IAAAA,OAAO,EAAE,MAAOlB,MAAM,GAAGA,MAAM,CAACiB,KAAP,CAAaC,OAAhB,GAA2B,EAJnD;AAKElB,IAAAA,MAAM,EAAE,MAAMA,MALhB;AAMEyB,IAAAA,MAAM,EAAE,CAACC,EAAD,EAAaC,QAAQ,GAAG,GAAxB,EAA6BC,QAAQ,GAAG,KAAxC,EAA+CC,MAA/C,KACN7B,MAAM,EAAE8B,SAAR,CAAkBJ,EAAlB,EAAsBE,QAAtB,EAAgC;AAAED,MAAAA,QAAF;AAAYE,MAAAA,MAAM,EAAEA,MAAAA;AAApB,KAAhC,CAPJ;AAQEvB,IAAAA,OAAAA;AARF,GAFK,CAAP,CAAA;AAaD;;;;;ACxFM,SAASyB,UAAT,CAAuBC,IAAvB,EAAsC;AAC3C,EAAA,OAAO,EAAP,CAAA;AACD,CAAA;AAID;AACO,MAAMC,aAAa,GAAGC,aAAa,CAAC9B,YAAY,CAAuB,IAAvB,CAAb,EAAnC;AAEP;AACA;AACA;AACA;AACA;AACA;;MACa+B,cAAyB,GAAGC,KAAK,IAC3CC,eAAA,CAAA,aAD2C,CAC7B,QAD6B,EAAA;AAAA,EAAA,IACpB,KADoB,GAAA;AAAA,IACbjC,OAAAA,YAAY,CAAC,IAAD,CADC,CAAA;AAAA,GAAA;;AAAA,EAAA,IAAA,QAAA,GAAA;AAAA,IACQgC,OAAAA,KAAK,CAACE,QADd,CAAA;AAAA,GAAA;;AAAA,CAAvC,EAAA;AAIP;AACA;AACA;AACA;AACA;AACA;;AACaC,MAAAA,MAGX,GAAGH,KAAK,IAAI;AACZ,EAAA,IAAII,QAAJ,EAAc,OAAOJ,KAAK,CAACE,QAAb,CAAA;AACd,EAAA,MAAM,GAAGG,UAAH,CAAA,GAAiBC,UAAU,CAACT,aAAD,CAAjC,CAAA;AACA,EAAM,MAAA,CAACjC,MAAD,EAAS2C,OAAT,IAAoB9C,YAAY,CAACuC,KAAK,CAACtC,OAAN,IAAiB,EAAlB,EAAsB,IAAIsC,KAAK,CAACrC,OAAN,IAAiB,EAArB,CAAtB,CAAtC,CAAA;AACA0C,EAAAA,UAAU,CAACE,OAAD,CAAV,CAAA;AAEA,EAAA,OAAA,CAAA,MAAA;AAAA,IAAA,MAAA,IAAA,GAAA,MAAA,CAAA,SAAA,CAAA,IAAA,CAAA,CAAA;;AAAgB,IAAA,MAAhB,CAAA,IAAA,EAAA,MAAA,IAAA,CAAA,CAAA;;AAAA,IAAwBP,MAAAA,CAAAA,IAAAA,EAAAA,MAAAA,KAAK,CAACE,QAA9B,CAAA,CAAA;;AAAA,IAAA,OAAA,IAAA,CAAA;AAAA,GAAA,GAAA,CAAA;AACD,EAVM;AAYP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACaM,MAAAA,YAMX,GAAGR,KAAK,IAAI;AACZ,EAAA,MAAMS,OAAO,GAAGH,UAAU,CAACT,aAAD,CAA1B,CAAA;;AACA,EAAMa,MAAAA,WAAW,GAAG,MAAM;AACxB,IAAID,IAAAA,OAAO,IAAI,IAAf,EAAqB,OAAA;AACrB,IAAM,MAAA,CAACF,OAAD,CAAA,GAAYE,OAAlB,CAAA;AACAT,IAAAA,KAAK,CAACb,IAAN,GAAaoB,OAAO,EAAA,EAAIpB,IAAX,EAAb,GAAiCoB,OAAO,EAAInB,EAAAA,IAAX,EAAjC,CAAA;AACD,GAJD,CAAA;;AAKA,EAAA,OAAA,CAAA,MAAA;AAAA,IAAA,MAAA,KAAA,GAAA,OAAA,CAAA,SAAA,CAAA,IAAA,CAAA,CAAA;;AAAA,IAAA,KAAA,CAAA,OAAA,GAKasB,WALb,CAAA;;AAAA,IAOKV,MAAAA,CAAAA,KAAAA,EAAAA,MAAAA,KAAK,CAACE,QAPX,CAAA,CAAA;;AAAA,IAAAS,MAAA,CAAA,GAAA,IAAA;AAAA,MAAA,MAAA,GAAA,GAEcX,KAAK,CAACY,QAAN,IAAkB,KAFhC;AAAA,YAGWZ,IAAAA,GAAAA,KAAK,CAACa,KAHjB;AAAA,YAIeb,IAAAA,GAAAA,KAAK,CAAC3B,SAJrB,CAAA;;AAAA,MAAA,GAAA,KAAA,GAAA,CAAA,GAAA,KAAA,KAAA,CAAA,QAAA,GAAA,GAAA,CAAA,GAAA,GAAA,GAAA,CAAA,CAAA;AAAA,MAAA,IAAA,KAAA,GAAA,CAAA,IAAA,KAAA,KAAA,CAAA,SAAA,GAAA,GAAA,CAAA,IAAA,GAAA,IAAA,CAAA,CAAA;AAAA,MAAA,GAAA,CAAA,IAAA,GAAAyC,SAAA,CAAA,KAAA,EAAA,IAAA,EAAA,GAAA,CAAA,IAAA,CAAA,CAAA;AAAA,MAAA,OAAA,GAAA,CAAA;AAAA,KAAA,EAAA;AAAA,MAAA,GAAA,EAAA,SAAA;AAAA,MAAA,IAAA,EAAA,SAAA;AAAA,MAAA,IAAA,EAAA,SAAA;AAAA,KAAA,CAAA,CAAA;;AAAA,IAAA,OAAA,KAAA,CAAA;AAAA,GAAA,GAAA,CAAA;AAUD,EAvBM;;;;;;"}
@@ -0,0 +1,39 @@
1
+ import { Accessor } from "solid-js";
2
+ import { KeenSliderHooks, KeenSliderInstance, KeenSliderOptions, KeenSliderPlugin, TrackDetails } from "keen-slider";
3
+ declare module "solid-js" {
4
+ namespace JSX {
5
+ interface Directives {
6
+ slider: {};
7
+ }
8
+ }
9
+ }
10
+ /**
11
+ * Creates a slider powered by KeenSlider.
12
+ *
13
+ * @param {Object} options Values to initialize the slider with
14
+ * @param {Array} plugins Extensions that enhance KeenSlider options
15
+ * @returns {[create: Function, helpers: Object]} Returns mount and helper methods
16
+ * @returns {Function} create Mounts the slider on provided element
17
+ * @returns {Function} helpers.current Current slide number
18
+ * @returns {Function} helpers.current Current slide number
19
+ * @returns {Function} helpers.next Function to trigger the next slide
20
+ * @returns {Function} helpers.prev Function to trigger the previous slide
21
+ * @returns {Function<Object>} helpers.details Provides details about the current slider
22
+ * @returns {Function} helpers.slider Returns the KeenSlider instance
23
+ * @returns {Function} helpers.destroy Manual destroy function
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const [create, { prev, next }] = createSlider();
28
+ * <div use:slider>...</div>
29
+ * ```
30
+ */
31
+ export declare const createSlider: <O = {}, P = {}, H extends string = KeenSliderHooks>(options?: KeenSliderOptions<O, P, H> | Accessor<KeenSliderOptions<O, P, H>>, ...plugins: KeenSliderPlugin<O, P, H>[]) => [create: (el: HTMLElement) => void, helpers: {
32
+ current: Accessor<number>;
33
+ next: Accessor<void>;
34
+ prev: Accessor<void>;
35
+ moveTo: (id: number, duration?: number, absolute?: boolean, easing?: (t: number) => number) => void;
36
+ details: Accessor<TrackDetails>;
37
+ slider: Accessor<KeenSliderInstance<O, P, H>>;
38
+ destroy: Accessor<void>;
39
+ }];
@@ -0,0 +1,58 @@
1
+ import { on, onMount, createSignal, onCleanup, createEffect } from "solid-js";
2
+ import KeenSlider from "keen-slider";
3
+ /**
4
+ * Creates a slider powered by KeenSlider.
5
+ *
6
+ * @param {Object} options Values to initialize the slider with
7
+ * @param {Array} plugins Extensions that enhance KeenSlider options
8
+ * @returns {[create: Function, helpers: Object]} Returns mount and helper methods
9
+ * @returns {Function} create Mounts the slider on provided element
10
+ * @returns {Function} helpers.current Current slide number
11
+ * @returns {Function} helpers.current Current slide number
12
+ * @returns {Function} helpers.next Function to trigger the next slide
13
+ * @returns {Function} helpers.prev Function to trigger the previous slide
14
+ * @returns {Function<Object>} helpers.details Provides details about the current slider
15
+ * @returns {Function} helpers.slider Returns the KeenSlider instance
16
+ * @returns {Function} helpers.destroy Manual destroy function
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const [create, { prev, next }] = createSlider();
21
+ * <div use:slider>...</div>
22
+ * ```
23
+ */
24
+ export const createSlider = (options, ...plugins) => {
25
+ let slider;
26
+ const opts = () => typeof options == "function" ? options() : options;
27
+ const [current, setCurrent] = createSignal(opts()?.initial || 0);
28
+ const destroy = () => slider && slider.destroy();
29
+ // Slider creation method and directive function
30
+ const create = (el) => {
31
+ el.classList.add("keen-slider");
32
+ // @ts-ignore
33
+ const getOptions = () => ({
34
+ selector: el.childNodes,
35
+ ...(opts())
36
+ });
37
+ onMount(() => {
38
+ slider = new KeenSlider(el, getOptions(), plugins);
39
+ slider.on("slideChanged", () => setCurrent(slider.track.details.rel));
40
+ });
41
+ onCleanup(destroy);
42
+ if (typeof options === "function") {
43
+ createEffect(on(() => options, () => slider && slider.update(getOptions())));
44
+ }
45
+ };
46
+ return [
47
+ create,
48
+ {
49
+ current,
50
+ next: () => slider && slider.next(),
51
+ prev: () => slider && slider.prev(),
52
+ details: () => (slider ? slider.track.details : {}),
53
+ slider: () => slider,
54
+ moveTo: (id, duration = 250, absolute = false, easing) => slider?.moveToIdx(id, absolute, { duration, easing: easing }),
55
+ destroy
56
+ }
57
+ ];
58
+ };
package/dist/slider.css CHANGED
@@ -27,4 +27,4 @@
27
27
  }
28
28
  .keen-slider:not([data-keen-slider-disabled])[data-keen-slider-moves] * {
29
29
  pointer-events: none;
30
- }
30
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "solid-slider",
3
- "version": "1.3.0",
3
+ "version": "1.3.3",
4
4
  "description": "A slider utility for SolidJS.",
5
5
  "author": "David Di Biase",
6
6
  "repository": {
@@ -14,16 +14,36 @@
14
14
  "homepage": "https://github.com/davedbase/solid-slider#readme",
15
15
  "scripts": {
16
16
  "format": "prettier -w \"src/**/*.{js,ts,json,css,tsx,jsx}\"",
17
- "build": "tsup && cp src/slider.css dist/slider.css"
17
+ "build": "rollup -c rollup.config.js && cp src/slider.css dist/slider.css && cp src/plugins/adaptiveHeight.css dist/adaptiveHeight/style.css"
18
18
  },
19
- "main": "dist/index.js",
20
- "module": "dist/index.mjs",
19
+ "main": "dist/index/index.common.js",
20
+ "module": "dist/index/index.module.js",
21
+ "types": "dist/index/index.d.ts",
21
22
  "exports": {
22
- ".": "./dist/index.js",
23
- "./plugins/autoplay": "./dist/plugins/autoplay.js",
24
- "./slider.css": "./dist/slider.css"
23
+ ".": {
24
+ "solid": "./dist/index/index.jsx",
25
+ "import": "./dist/index/index.module.js",
26
+ "browser": "./dist/index/index.module.js",
27
+ "require": "./dist/index/index.common.js",
28
+ "node": "./dist/index/index.common.js"
29
+ },
30
+ "./plugins/autoplay": {
31
+ "solid": "./dist/autoplay/autoplay.jsx",
32
+ "import": "./dist/autoplay/index.module.js",
33
+ "browser": "./dist/autoplay/index.module.js",
34
+ "require": "./dist/autoplay/index.common.js",
35
+ "node": "./dist/autoplay/index.common.js"
36
+ },
37
+ "./plugins/adaptiveHeight": {
38
+ "solid": "./dist/adaptiveHeight/autoplay.jsx",
39
+ "import": "./dist/adaptiveHeight/index.module.js",
40
+ "browser": "./dist/adaptiveHeight/index.module.js",
41
+ "require": "./dist/adaptiveHeight/index.common.js",
42
+ "node": "./dist/adaptiveHeight/index.common.js"
43
+ },
44
+ "./slider.css": "./dist/slider.css",
45
+ "./adaptiveHeight/style.css": "./dist/adaptiveHeight/slider.css"
25
46
  },
26
- "types": "dist/index.d.ts",
27
47
  "sideEffects": false,
28
48
  "files": [
29
49
  "dist"
@@ -41,15 +61,15 @@
41
61
  "plugin"
42
62
  ],
43
63
  "dependencies": {
44
- "@solid-primitives/context": "^0.1.0",
45
64
  "@solid-primitives/timer": "1.3.0",
46
- "esbuild-plugin-solid": "^0.4.2",
47
65
  "keen-slider": "^6.6.10",
48
- "solid-js": "^1.3.16"
66
+ "solid-js": "^1.4.5"
49
67
  },
50
68
  "devDependencies": {
69
+ "esbuild-plugin-solid": "^0.4.2",
70
+ "rollup": "^2.70.2",
71
+ "rollup-preset-solid": "^1.4.0",
51
72
  "prettier": "^2.5.1",
52
- "tsup": "^5.12.6",
53
73
  "typescript": "^4.5.5"
54
74
  }
55
75
  }
@@ -1,20 +0,0 @@
1
- var __defProp = Object.defineProperty;
2
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
3
- var __hasOwnProp = Object.prototype.hasOwnProperty;
4
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
5
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
6
- var __spreadValues = (a, b) => {
7
- for (var prop in b || (b = {}))
8
- if (__hasOwnProp.call(b, prop))
9
- __defNormalProp(a, prop, b[prop]);
10
- if (__getOwnPropSymbols)
11
- for (var prop of __getOwnPropSymbols(b)) {
12
- if (__propIsEnum.call(b, prop))
13
- __defNormalProp(a, prop, b[prop]);
14
- }
15
- return a;
16
- };
17
-
18
- export {
19
- __spreadValues
20
- };
package/dist/index.d.ts DELETED
@@ -1,92 +0,0 @@
1
- import * as solid_js from 'solid-js';
2
- import { Accessor, Component } from 'solid-js';
3
- import * as keen_slider from 'keen-slider';
4
- import { KeenSliderHooks, KeenSliderOptions, KeenSliderPlugin, TrackDetails, KeenSliderInstance } from 'keen-slider';
5
-
6
- declare module "solid-js" {
7
- namespace JSX {
8
- interface Directives {
9
- slider: {};
10
- }
11
- }
12
- }
13
- /**
14
- * Creates a slider powered by KeenSlider.
15
- *
16
- * @param {Object} options Values to initialize the slider with
17
- * @param {Array} plugins Extensions that enhance KeenSlider options
18
- * @returns {[create: Function, helpers: Object]} Returns mount and helper methods
19
- * @returns {Function} create Mounts the slider on provided element
20
- * @returns {Function} helpers.current Current slide number
21
- * @returns {Function} helpers.current Current slide number
22
- * @returns {Function} helpers.next Function to trigger the next slide
23
- * @returns {Function} helpers.prev Function to trigger the previous slide
24
- * @returns {Function<Object>} helpers.details Provides details about the current slider
25
- * @returns {Function} helpers.slider Returns the KeenSlider instance
26
- * @returns {Function} helpers.destroy Manual destroy function
27
- *
28
- * @example
29
- * ```ts
30
- * const [create, { prev, next }] = createSlider();
31
- * <div use:slider>...</div>
32
- * ```
33
- */
34
- declare const createSlider: <O = {}, P = {}, H extends string = KeenSliderHooks>(options?: KeenSliderOptions<O, P, H> | Accessor<KeenSliderOptions<O, P, H>> | undefined, ...plugins: KeenSliderPlugin<O, P, H>[]) => [create: (el: HTMLElement) => void, helpers: {
35
- current: Accessor<number>;
36
- next: Accessor<void>;
37
- prev: Accessor<void>;
38
- moveTo: (id: number, duration?: number | undefined, absolute?: boolean | undefined, easing?: ((t: number) => number) | undefined) => void;
39
- details: Accessor<TrackDetails>;
40
- slider: Accessor<KeenSliderInstance<O, P, H> | undefined>;
41
- destroy: Accessor<void>;
42
- }];
43
-
44
- interface Func<T> {
45
- ([...args]: any, args2?: any): T;
46
- }
47
- declare function returnType<T>(func: Func<T>): T;
48
- declare const SliderContext: solid_js.Context<solid_js.Signal<{
49
- current: solid_js.Accessor<number>;
50
- next: solid_js.Accessor<void>;
51
- prev: solid_js.Accessor<void>;
52
- moveTo: (id: number, duration?: number | undefined, absolute?: boolean | undefined, easing?: ((t: number) => number) | undefined) => void;
53
- details: solid_js.Accessor<keen_slider.TrackDetails>;
54
- slider: solid_js.Accessor<keen_slider.KeenSliderInstance<{}, {}, keen_slider.KeenSliderHooks> | undefined>;
55
- destroy: solid_js.Accessor<void>;
56
- } | null>>;
57
- /**
58
- * A helpful and simple Provider to wrap your Slider if controls such as SliderButton are used.
59
- *
60
- * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.
61
- * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.
62
- */
63
- declare const SliderProvider: Component;
64
- /**
65
- * Main Slider component for specifying the Slider on the page.
66
- *
67
- * @param props {KeenSliderOptions} options - Accepts all KeenSlider options.
68
- * @param props {KeenSLiderPlugin} plugins - A list of Solid Slider or Keen slider plugins.
69
- */
70
- declare const Slider: Component<{
71
- options?: KeenSliderOptions;
72
- plugins?: KeenSliderPlugin[];
73
- }>;
74
- /**
75
- * Provides a helpful button with next/prev to pair with your slider.
76
- *
77
- * @param props {boolean} next - Specify if this should be a next button.
78
- * @param props {boolean} prev - Specify if this should be a prev button.
79
- * @param props {string} class - Class to override the button.
80
- * @param props {object} classList - List of classes to override the button.
81
- */
82
- declare const SliderButton: Component<{
83
- next?: boolean;
84
- prev?: boolean;
85
- disabled?: boolean;
86
- class?: string;
87
- classList?: {
88
- [k: string]: boolean | undefined;
89
- };
90
- }>;
91
-
92
- export { Slider, SliderButton, SliderContext, SliderProvider, createSlider, returnType };
package/dist/index.js DELETED
@@ -1,158 +0,0 @@
1
- var __create = Object.create;
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
6
- var __getProtoOf = Object.getPrototypeOf;
7
- var __hasOwnProp = Object.prototype.hasOwnProperty;
8
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
9
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
10
- var __spreadValues = (a, b) => {
11
- for (var prop in b || (b = {}))
12
- if (__hasOwnProp.call(b, prop))
13
- __defNormalProp(a, prop, b[prop]);
14
- if (__getOwnPropSymbols)
15
- for (var prop of __getOwnPropSymbols(b)) {
16
- if (__propIsEnum.call(b, prop))
17
- __defNormalProp(a, prop, b[prop]);
18
- }
19
- return a;
20
- };
21
- var __export = (target, all) => {
22
- for (var name in all)
23
- __defProp(target, name, { get: all[name], enumerable: true });
24
- };
25
- var __copyProps = (to, from, except, desc) => {
26
- if (from && typeof from === "object" || typeof from === "function") {
27
- for (let key of __getOwnPropNames(from))
28
- if (!__hasOwnProp.call(to, key) && key !== except)
29
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
30
- }
31
- return to;
32
- };
33
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
34
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
35
-
36
- // src/index.ts
37
- var src_exports = {};
38
- __export(src_exports, {
39
- Slider: () => Slider,
40
- SliderButton: () => SliderButton,
41
- SliderContext: () => SliderContext,
42
- SliderProvider: () => SliderProvider,
43
- createSlider: () => createSlider,
44
- returnType: () => returnType
45
- });
46
- module.exports = __toCommonJS(src_exports);
47
-
48
- // src/primitive.ts
49
- var import_solid_js = require("solid-js");
50
- var import_keen_slider = __toESM(require("keen-slider"));
51
- var createSlider = (options, ...plugins) => {
52
- let slider;
53
- const [current, setCurrent] = (0, import_solid_js.createSignal)(0);
54
- const destroy = () => slider && slider.destroy();
55
- const create = (el) => {
56
- el.classList.add("keen-slider");
57
- const opts = () => __spreadValues({
58
- selector: el.childNodes
59
- }, typeof options == "function" ? options() : options);
60
- (0, import_solid_js.onMount)(() => {
61
- slider = new import_keen_slider.default(el, opts(), plugins);
62
- slider.on("slideChanged", () => setCurrent(slider.track.details.rel));
63
- setCurrent(slider.track.details.rel);
64
- });
65
- (0, import_solid_js.onCleanup)(destroy);
66
- if (typeof options === "function") {
67
- (0, import_solid_js.createEffect)((0, import_solid_js.on)(() => options, () => slider && slider.update(opts())));
68
- }
69
- };
70
- return [
71
- create,
72
- {
73
- current,
74
- next: () => slider && slider.next(),
75
- prev: () => slider && slider.prev(),
76
- details: () => slider ? slider.track.details : {},
77
- slider: () => slider,
78
- moveTo: (id, duration = 250, absolute = false, easing) => slider == null ? void 0 : slider.moveToIdx(id, absolute, { duration, easing }),
79
- destroy
80
- }
81
- ];
82
- };
83
-
84
- // src/components.tsx
85
- var import_web = require("solid-js/web");
86
- var import_web2 = require("solid-js/web");
87
- var import_web3 = require("solid-js/web");
88
- var import_web4 = require("solid-js/web");
89
- var import_web5 = require("solid-js/web");
90
- var import_web6 = require("solid-js/web");
91
- var import_solid_js2 = require("solid-js");
92
- var import_web7 = require("solid-js/web");
93
- var _tmpl$ = /* @__PURE__ */ (0, import_web.template)(`<div></div>`, 2);
94
- var _tmpl$2 = /* @__PURE__ */ (0, import_web.template)(`<button></button>`, 2);
95
- function returnType(func) {
96
- return {};
97
- }
98
- var sliderValues = returnType(createSlider);
99
- var SliderContext = (0, import_solid_js2.createContext)((0, import_solid_js2.createSignal)(null));
100
- var SliderProvider = (props) => (0, import_web6.createComponent)(SliderContext.Provider, {
101
- get value() {
102
- return (0, import_solid_js2.createSignal)(null);
103
- },
104
- get children() {
105
- return props.children;
106
- }
107
- });
108
- var Slider = (props) => {
109
- if (import_web7.isServer)
110
- return props.children;
111
- const [, setHelpers] = (0, import_solid_js2.useContext)(SliderContext);
112
- const [slider, helpers] = createSlider(props.options || {}, ...props.plugins || []);
113
- setHelpers(helpers);
114
- slider;
115
- return (() => {
116
- const _el$ = _tmpl$.cloneNode(true);
117
- slider(_el$, () => true);
118
- (0, import_web5.insert)(_el$, () => props.children);
119
- return _el$;
120
- })();
121
- };
122
- var SliderButton = (props) => {
123
- const context = (0, import_solid_js2.useContext)(SliderContext);
124
- const changeSlide = () => {
125
- var _a, _b;
126
- if (context == null)
127
- return;
128
- const [helpers] = context;
129
- props.next ? (_a = helpers()) == null ? void 0 : _a.next() : (_b = helpers()) == null ? void 0 : _b.prev();
130
- };
131
- return (() => {
132
- const _el$2 = _tmpl$2.cloneNode(true);
133
- _el$2.$$click = changeSlide;
134
- (0, import_web5.insert)(_el$2, () => props.children);
135
- (0, import_web4.effect)((_p$) => {
136
- const _v$ = props.disabled || false, _v$2 = props.class, _v$3 = props.classList;
137
- _v$ !== _p$._v$ && (_el$2.disabled = _p$._v$ = _v$);
138
- _v$2 !== _p$._v$2 && (_el$2.className = _p$._v$2 = _v$2);
139
- _p$._v$3 = (0, import_web3.classList)(_el$2, _v$3, _p$._v$3);
140
- return _p$;
141
- }, {
142
- _v$: void 0,
143
- _v$2: void 0,
144
- _v$3: void 0
145
- });
146
- return _el$2;
147
- })();
148
- };
149
- (0, import_web2.delegateEvents)(["click"]);
150
- // Annotate the CommonJS export names for ESM import in node:
151
- 0 && (module.exports = {
152
- Slider,
153
- SliderButton,
154
- SliderContext,
155
- SliderProvider,
156
- createSlider,
157
- returnType
158
- });