@mozert-studio/vue 0.0.0-stage → 1.1.2

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 CHANGED
@@ -1,3 +1,34 @@
1
- # Temporary Holding Version
1
+ # @mozert-studio/vue
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Vue component for [Mozert Slider](https://mozert-slider.vercel.app/): a dependency-free slider and carousel with touch, responsive layouts, 3D effects, thumbnails, lightbox and scroll-driven mode.
4
+
5
+ ```
6
+ npm install @mozert-studio/vue @mozert-studio/mozert-slider
7
+ ```
8
+
9
+ Import the slider styles once (for example in your root layout):
10
+
11
+ ```js
12
+ import '@mozert-studio/mozert-slider/css';
13
+ import '@mozert-studio/mozert-slider/theme.css';
14
+ ```
15
+
16
+ ## Use
17
+
18
+ ```vue
19
+ <script setup>
20
+ import MozertSlider from '@mozert-studio/vue';
21
+ </script>
22
+
23
+ <template>
24
+ <MozertSlider :slides-to-show="3" :spaceBetween="16" dots thumbs lightbox @change="(i) => console.log(i)">
25
+ <div v-for="p in products" :key="p.id"><img :src="p.image" :alt="p.name" /></div>
26
+ </MozertSlider>
27
+ </template>
28
+ ```
29
+
30
+ - Every Mozert option can be an attribute, or be passed as `:options="{ ... }"`. Use camelCase names (`:slidesToShow="3"`).
31
+ - Each slide is **one element**. Give `v-for` items a `:key`.
32
+ - The slider is rebuilt when slides are added, removed or reordered, or when an option changes.
33
+ - Events: `init(slider)`, `change(index, slider)`, `before-change(from, to, slider)`. A template ref exposes `slider()` and `element()`.
34
+ - Nuxt 3: wrap it in `<ClientOnly>`.
package/index.cjs ADDED
@@ -0,0 +1,76 @@
1
+ 'use strict';
2
+ const { defineComponent, h, Fragment, Comment, Text } = require('vue');
3
+ const Mozert = require('@mozert-studio/mozert-slider');
4
+
5
+ // Flatten v-for / template fragments into the real slide vnodes.
6
+ function slidesOf(vnodes) {
7
+ const out = [];
8
+ (vnodes || []).forEach((v) => {
9
+ if (v.type === Comment) return;
10
+ if (v.type === Fragment) out.push.apply(out, slidesOf(v.children));
11
+ else if (v.type === Text && !String(v.children).trim()) return;
12
+ else out.push(v);
13
+ });
14
+ return out;
15
+ }
16
+ const sig = (opts) => JSON.stringify(opts, (k, v) => (typeof v === 'function' ? '[fn]' : v));
17
+
18
+ /**
19
+ * <MozertSlider :options="{ slidesToShow: 3 }" @change="i => ..."><div v-for="i in items" :key="i.id">…</div></MozertSlider>
20
+ * Every slide must render one element. Give v-for items a :key so the slider can follow reordering.
21
+ * Extra attributes (slidesToShow, dots...) are also passed as options. Methods: slider() returns the instance.
22
+ */
23
+ const MozertSlider = defineComponent({
24
+ name: 'MozertSlider',
25
+ inheritAttrs: false,
26
+ props: { options: { type: Object, default: () => ({}) }, tag: { type: String, default: 'div' } },
27
+ emits: ['init', 'change', 'before-change'],
28
+ setup(props, { slots, attrs, emit, expose }) {
29
+ let inst = null;
30
+ let host = null;
31
+ const merged = () => {
32
+ const o = Object.assign({}, props.options);
33
+ Object.keys(attrs).forEach((k) => {
34
+ if (k === 'class' || k === 'style' || k === 'id' || /^on[A-Z]/.test(k) || /^data-|^aria-/.test(k)) return;
35
+ o[k] = attrs[k];
36
+ });
37
+ const user = Object.assign({}, o.on);
38
+ o.on = Object.assign({}, user, {
39
+ afterChange(s, i) { user.afterChange && user.afterChange(s, i); emit('change', i, s); },
40
+ beforeChange(s, a, b) { user.beforeChange && user.beforeChange(s, a, b); emit('before-change', a, b, s); },
41
+ });
42
+ return o;
43
+ };
44
+ const start = (el) => {
45
+ host = el;
46
+ inst = new Mozert(el, merged());
47
+ emit('init', inst);
48
+ };
49
+ const stop = () => {
50
+ if (inst) { inst.destroy(); inst = null; }
51
+ host = null;
52
+ };
53
+ expose({ slider: () => inst, element: () => host });
54
+ return () => {
55
+ const kids = slidesOf(slots.default ? slots.default() : []);
56
+ const key = kids.map((k, i) => (k.key != null ? String(k.key) : '_' + i)).join('|') + '::' + sig(Object.assign({}, props.options, pickPlain(attrs)));
57
+ const passAttrs = {};
58
+ ['class', 'style', 'id'].forEach((k) => { if (attrs[k] !== undefined) passAttrs[k] = attrs[k]; });
59
+ return h(props.tag, Object.assign({ key, onVnodeMounted: (vn) => start(vn.el), onVnodeBeforeUnmount: stop }, passAttrs), kids);
60
+ };
61
+ },
62
+ });
63
+
64
+ function pickPlain(attrs) {
65
+ const o = {};
66
+ Object.keys(attrs).forEach((k) => {
67
+ if (k === 'class' || k === 'style' || k === 'id' || /^on[A-Z]/.test(k) || /^data-|^aria-/.test(k)) return;
68
+ o[k] = attrs[k];
69
+ });
70
+ return o;
71
+ }
72
+
73
+ module.exports = MozertSlider;
74
+ module.exports.default = MozertSlider;
75
+ module.exports.MozertSlider = MozertSlider;
76
+ module.exports.Mozert = Mozert;
package/index.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ import { DefineComponent } from 'vue';
2
+ import Mozert from '@mozert-studio/mozert-slider';
3
+
4
+ /** Props: `options` (object) and `tag`. Any other attribute (slidesToShow, dots, effect, thumbs, lightbox...) is passed to Mozert as an option. Events: init, change, before-change. */
5
+ export const MozertSlider: DefineComponent<{ options?: Record<string, any>; tag?: string } & Record<string, any>>;
6
+ export default MozertSlider;
7
+ export { Mozert };
package/index.mjs ADDED
@@ -0,0 +1,73 @@
1
+ import { defineComponent, h, Fragment, Comment, Text } from 'vue';
2
+ import Mozert from '@mozert-studio/mozert-slider';
3
+
4
+ // Flatten v-for / template fragments into the real slide vnodes.
5
+ function slidesOf(vnodes) {
6
+ const out = [];
7
+ (vnodes || []).forEach((v) => {
8
+ if (v.type === Comment) return;
9
+ if (v.type === Fragment) out.push.apply(out, slidesOf(v.children));
10
+ else if (v.type === Text && !String(v.children).trim()) return;
11
+ else out.push(v);
12
+ });
13
+ return out;
14
+ }
15
+ const sig = (opts) => JSON.stringify(opts, (k, v) => (typeof v === 'function' ? '[fn]' : v));
16
+
17
+ /**
18
+ * <MozertSlider :options="{ slidesToShow: 3 }" @change="i => ..."><div v-for="i in items" :key="i.id">…</div></MozertSlider>
19
+ * Every slide must render one element. Give v-for items a :key so the slider can follow reordering.
20
+ * Extra attributes (slidesToShow, dots...) are also passed as options. Methods: slider() returns the instance.
21
+ */
22
+ export const MozertSlider = defineComponent({
23
+ name: 'MozertSlider',
24
+ inheritAttrs: false,
25
+ props: { options: { type: Object, default: () => ({}) }, tag: { type: String, default: 'div' } },
26
+ emits: ['init', 'change', 'before-change'],
27
+ setup(props, { slots, attrs, emit, expose }) {
28
+ let inst = null;
29
+ let host = null;
30
+ const merged = () => {
31
+ const o = Object.assign({}, props.options);
32
+ Object.keys(attrs).forEach((k) => {
33
+ if (k === 'class' || k === 'style' || k === 'id' || /^on[A-Z]/.test(k) || /^data-|^aria-/.test(k)) return;
34
+ o[k] = attrs[k];
35
+ });
36
+ const user = Object.assign({}, o.on);
37
+ o.on = Object.assign({}, user, {
38
+ afterChange(s, i) { user.afterChange && user.afterChange(s, i); emit('change', i, s); },
39
+ beforeChange(s, a, b) { user.beforeChange && user.beforeChange(s, a, b); emit('before-change', a, b, s); },
40
+ });
41
+ return o;
42
+ };
43
+ const start = (el) => {
44
+ host = el;
45
+ inst = new Mozert(el, merged());
46
+ emit('init', inst);
47
+ };
48
+ const stop = () => {
49
+ if (inst) { inst.destroy(); inst = null; }
50
+ host = null;
51
+ };
52
+ expose({ slider: () => inst, element: () => host });
53
+ return () => {
54
+ const kids = slidesOf(slots.default ? slots.default() : []);
55
+ const key = kids.map((k, i) => (k.key != null ? String(k.key) : '_' + i)).join('|') + '::' + sig(Object.assign({}, props.options, pickPlain(attrs)));
56
+ const passAttrs = {};
57
+ ['class', 'style', 'id'].forEach((k) => { if (attrs[k] !== undefined) passAttrs[k] = attrs[k]; });
58
+ return h(props.tag, Object.assign({ key, onVnodeMounted: (vn) => start(vn.el), onVnodeBeforeUnmount: stop }, passAttrs), kids);
59
+ };
60
+ },
61
+ });
62
+
63
+ function pickPlain(attrs) {
64
+ const o = {};
65
+ Object.keys(attrs).forEach((k) => {
66
+ if (k === 'class' || k === 'style' || k === 'id' || /^on[A-Z]/.test(k) || /^data-|^aria-/.test(k)) return;
67
+ o[k] = attrs[k];
68
+ });
69
+ return o;
70
+ }
71
+
72
+ export default MozertSlider;
73
+ export { Mozert };
package/package.json CHANGED
@@ -1,6 +1,64 @@
1
1
  {
2
2
  "name": "@mozert-studio/vue",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "1.1.2",
4
+ "description": "Vue 3 component for Mozert Slider: a dependency-free slider and carousel with touch, responsive layouts, 3D effects, thumbnails and lightbox.",
5
+ "license": "MIT",
6
+ "type": "commonjs",
7
+ "main": "index.cjs",
8
+ "module": "index.mjs",
9
+ "types": "index.d.ts",
10
+ "exports": {
11
+ ".": {
12
+ "types": "./index.d.ts",
13
+ "import": "./index.mjs",
14
+ "require": "./index.cjs"
15
+ },
16
+ "./package.json": "./package.json"
17
+ },
18
+ "sideEffects": false,
19
+ "files": [
20
+ "index.mjs",
21
+ "index.cjs",
22
+ "index.d.ts",
23
+ "README.md"
24
+ ],
25
+ "peerDependencies": {
26
+ "vue": ">=3.3",
27
+ "@mozert-studio/mozert-slider": ">=1.1.2"
28
+ },
29
+ "keywords": [
30
+ "vue",
31
+ "vue-slider",
32
+ "vue-carousel",
33
+ "vue-component",
34
+ "vue-image-gallery",
35
+ "mozert",
36
+ "mozert-slider",
37
+ "mozert-studio",
38
+ "slider",
39
+ "carousel",
40
+ "image-slider",
41
+ "touch-slider",
42
+ "responsive-slider",
43
+ "product-gallery",
44
+ "lightbox",
45
+ "typescript",
46
+ "ssr",
47
+ "lightweight",
48
+ "zero-dependencies",
49
+ "vue3",
50
+ "vue-3",
51
+ "composition-api",
52
+ "nuxt",
53
+ "nuxt3"
54
+ ],
55
+ "homepage": "https://mozert-slider.vercel.app/",
56
+ "repository": {
57
+ "type": "git",
58
+ "url": "git+https://github.com/mozert-studio/mozert-slider.git",
59
+ "directory": "packages/vue"
60
+ },
61
+ "publishConfig": {
62
+ "access": "public"
63
+ }
64
+ }