@squirkle-ui/swiper 0.1.0 → 0.1.1
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 +24 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,15 +1,36 @@
|
|
|
1
1
|
# @squirkle-ui/swiper
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Carousel / slider for [Squirkle UI](https://www.npmjs.com/package/squirkle-ui). Works with Vue 3 and Vue 2.7.
|
|
4
4
|
|
|
5
|
+
## Install
|
|
5
6
|
```bash
|
|
6
7
|
npm i @squirkle-ui/swiper @squirkle-ui/ui
|
|
7
8
|
```
|
|
9
|
+
Or get every component and add-on with [`squirkle-ui`](https://www.npmjs.com/package/squirkle-ui) and import from `squirkle-ui/swiper`.
|
|
10
|
+
|
|
11
|
+
Peer dependencies: `vue`, `@squirkle-ui/ui`. Set up `@squirkle-ui/ui` first (`app.use(createSquirkle())` and `@squirkle-ui/ui/styles.css`).
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
8
14
|
```ts
|
|
9
15
|
import { SqSwiper } from '@squirkle-ui/swiper' // Vue 3
|
|
10
16
|
// import { SqSwiper } from '@squirkle-ui/swiper/vue2' // Vue 2.7
|
|
11
17
|
import '@squirkle-ui/swiper/styles.css'
|
|
12
18
|
```
|
|
13
|
-
|
|
19
|
+
```vue
|
|
20
|
+
<template>
|
|
21
|
+
<SqSwiper v-model="index" :items="slides" :slides-per-view="1.2" :space-between="16" loop>
|
|
22
|
+
<template #default="{ item }"><img :src="item.src" :alt="item.alt" /></template>
|
|
23
|
+
</SqSwiper>
|
|
24
|
+
</template>
|
|
25
|
+
<script setup lang="ts">
|
|
26
|
+
import { ref } from 'vue'
|
|
27
|
+
import { SqSwiper } from '@squirkle-ui/swiper'
|
|
28
|
+
const index = ref(0)
|
|
29
|
+
const slides = [{ src: '/a.jpg', alt: 'A' }, { src: '/b.jpg', alt: 'B' }]
|
|
30
|
+
</script>
|
|
31
|
+
```
|
|
32
|
+
Key props: `items`, `itemKey`, `slidesPerView`, `spaceBetween`, `breakpoints`, `effect`, `loop`, `pagination` (`dots` · `fraction` · `progress` · `false`).
|
|
33
|
+
|
|
14
34
|
|
|
15
|
-
|
|
35
|
+
## License
|
|
36
|
+
MIT © KheangLov · [Source and issues](https://github.com/KheangLov/squirkle-ui)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squirkle-ui/swiper",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Touch swiper / carousel for Squirkle UI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -46,13 +46,13 @@
|
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
48
|
"vue": "^2.7.0 || ^3.3.0",
|
|
49
|
-
"@squirkle-ui/ui": "^0.1.
|
|
49
|
+
"@squirkle-ui/ui": "^0.1.1"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@squirkle-ui/core": "^0.1.
|
|
52
|
+
"@squirkle-ui/core": "^0.1.1"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@squirkle-ui/ui": "^0.1.
|
|
55
|
+
"@squirkle-ui/ui": "^0.1.1"
|
|
56
56
|
},
|
|
57
57
|
"publishConfig": {
|
|
58
58
|
"access": "public"
|