maz-ui 5.0.0 → 5.1.0-beta.0
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/dist/assets/{MazDropzone.DJ8au25t.css → MazDropzone.BW2grpTi.css} +1 -1
- package/dist/chunks/{MazDrawer.DANxKYxJ.js → MazDrawer.CC8zomfx.js} +2 -2
- package/dist/chunks/{MazDropzone.POH3pmfi.js → MazDropzone.Dez5j0WP.js} +2 -2
- package/dist/components/MazDrawer.js +1 -1
- package/dist/components/MazDropzone.js +1 -1
- package/dist/components/MazDropzone.vue.d.ts +2 -2
- package/dist/components/MazInputPrice.vue.d.ts +1 -1
- package/dist/components/index.js +2 -2
- package/docs/README.md +207 -0
- package/docs/agents/agents-md.md +52 -0
- package/docs/agents/claude-rule.md +52 -0
- package/docs/components/maz-accordion.md +76 -0
- package/docs/components/maz-alert.md +241 -0
- package/docs/components/maz-animated-counter.md +87 -0
- package/docs/components/maz-animated-element.md +46 -0
- package/docs/components/maz-animated-text.md +53 -0
- package/docs/components/maz-avatar.md +193 -0
- package/docs/components/maz-backdrop.md +178 -0
- package/docs/components/maz-badge.md +167 -0
- package/docs/components/maz-bottom-sheet.md +257 -0
- package/docs/components/maz-btn-group.md +316 -0
- package/docs/components/maz-btn.md +423 -0
- package/docs/components/maz-card-spotlight.md +84 -0
- package/docs/components/maz-card.md +321 -0
- package/docs/components/maz-carousel.md +153 -0
- package/docs/components/maz-chart.md +206 -0
- package/docs/components/maz-checkbox.md +138 -0
- package/docs/components/maz-checklist.md +251 -0
- package/docs/components/maz-circular-progress-bar.md +109 -0
- package/docs/components/maz-code-highlight.md +155 -0
- package/docs/components/maz-container.md +241 -0
- package/docs/components/maz-date-picker.md +791 -0
- package/docs/components/maz-dialog-confirm.md +215 -0
- package/docs/components/maz-dialog.md +143 -0
- package/docs/components/maz-drawer.md +106 -0
- package/docs/components/maz-dropdown.md +419 -0
- package/docs/components/maz-dropzone.md +387 -0
- package/docs/components/maz-expand-animation.md +82 -0
- package/docs/components/maz-fullscreen-loader.md +58 -0
- package/docs/components/maz-gallery.md +79 -0
- package/docs/components/maz-icon.md +203 -0
- package/docs/components/maz-input-code.md +73 -0
- package/docs/components/maz-input-number.md +79 -0
- package/docs/components/maz-input-phone-number.md +536 -0
- package/docs/components/maz-input-price.md +68 -0
- package/docs/components/maz-input-tags.md +112 -0
- package/docs/components/maz-input.md +334 -0
- package/docs/components/maz-lazy-img.md +113 -0
- package/docs/components/maz-link.md +146 -0
- package/docs/components/maz-loading-bar.md +38 -0
- package/docs/components/maz-markdown-editor.md +320 -0
- package/docs/components/maz-pagination.md +82 -0
- package/docs/components/maz-popover.md +794 -0
- package/docs/components/maz-pull-to-refresh.md +222 -0
- package/docs/components/maz-radio-buttons.md +313 -0
- package/docs/components/maz-radio.md +119 -0
- package/docs/components/maz-read-more.md +209 -0
- package/docs/components/maz-reading-progress-bar.md +96 -0
- package/docs/components/maz-select-country.md +513 -0
- package/docs/components/maz-select.md +318 -0
- package/docs/components/maz-sidebar-content.md +25 -0
- package/docs/components/maz-sidebar-footer.md +25 -0
- package/docs/components/maz-sidebar-group.md +27 -0
- package/docs/components/maz-sidebar-header.md +25 -0
- package/docs/components/maz-sidebar-menu-button.md +41 -0
- package/docs/components/maz-sidebar-menu-item.md +25 -0
- package/docs/components/maz-sidebar-menu-sub.md +32 -0
- package/docs/components/maz-sidebar-menu.md +25 -0
- package/docs/components/maz-sidebar-separator.md +21 -0
- package/docs/components/maz-sidebar-trigger.md +25 -0
- package/docs/components/maz-sidebar.md +507 -0
- package/docs/components/maz-skeleton.md +226 -0
- package/docs/components/maz-slider.md +165 -0
- package/docs/components/maz-spinner.md +84 -0
- package/docs/components/maz-stepper.md +301 -0
- package/docs/components/maz-switch.md +86 -0
- package/docs/components/maz-table-cell.md +27 -0
- package/docs/components/maz-table-row.md +28 -0
- package/docs/components/maz-table-title.md +27 -0
- package/docs/components/maz-table-virtualizer.md +31 -0
- package/docs/components/maz-table.md +426 -0
- package/docs/components/maz-tabs-bar.md +43 -0
- package/docs/components/maz-tabs-content-item.md +27 -0
- package/docs/components/maz-tabs-content.md +27 -0
- package/docs/components/maz-tabs.md +308 -0
- package/docs/components/maz-textarea.md +255 -0
- package/docs/components/maz-ticker.md +427 -0
- package/docs/components/maz-timeline.md +304 -0
- package/docs/components/maz-ui-provider.md +26 -0
- package/docs/components/maz-window-mockup.md +182 -0
- package/docs/composables/use-aos.md +41 -0
- package/docs/composables/use-breakpoints.md +42 -0
- package/docs/composables/use-dialog.md +58 -0
- package/docs/composables/use-display-names.md +130 -0
- package/docs/composables/use-drag.md +185 -0
- package/docs/composables/use-form-validator.md +1123 -0
- package/docs/composables/use-idle-timeout.md +172 -0
- package/docs/composables/use-pull-to-refresh.md +86 -0
- package/docs/composables/use-reading-time.md +132 -0
- package/docs/composables/use-string-matching.md +41 -0
- package/docs/composables/use-swipe.md +171 -0
- package/docs/composables/use-timer.md +104 -0
- package/docs/composables/use-toast.md +50 -0
- package/docs/composables/use-user-visibility.md +127 -0
- package/docs/composables/use-wait.md +50 -0
- package/docs/composables/use-window-size.md +25 -0
- package/docs/directives/click-outside.md +182 -0
- package/docs/directives/fullscreen-img.md +83 -0
- package/docs/directives/lazy-img.md +182 -0
- package/docs/directives/tooltip.md +298 -0
- package/docs/directives/zoom-img.md +100 -0
- package/docs/ecosystem/eslint-config.md +289 -0
- package/docs/ecosystem/icons/icon-set.md +25 -0
- package/docs/ecosystem/icons/index.md +584 -0
- package/docs/ecosystem/mcp.md +165 -0
- package/docs/ecosystem/node/exec-promise.md +93 -0
- package/docs/ecosystem/node/index.md +53 -0
- package/docs/ecosystem/node/logger.md +152 -0
- package/docs/ecosystem/node/print-banner.md +101 -0
- package/docs/ecosystem/node/setup-agents.md +102 -0
- package/docs/ecosystem/nuxt.md +551 -0
- package/docs/ecosystem/stylelint-config.md +310 -0
- package/docs/ecosystem/themes.md +966 -0
- package/docs/ecosystem/translations.md +1173 -0
- package/docs/ecosystem/utils/camel-case.md +37 -0
- package/docs/ecosystem/utils/capitalize.md +37 -0
- package/docs/ecosystem/utils/check-availability.md +85 -0
- package/docs/ecosystem/utils/cookie.md +86 -0
- package/docs/ecosystem/utils/country-code-to-unicode-flag.md +128 -0
- package/docs/ecosystem/utils/currency.md +53 -0
- package/docs/ecosystem/utils/date.md +53 -0
- package/docs/ecosystem/utils/debounce-callback.md +44 -0
- package/docs/ecosystem/utils/debounce-id.md +75 -0
- package/docs/ecosystem/utils/debounce.md +71 -0
- package/docs/ecosystem/utils/fetch-locale-ip.md +39 -0
- package/docs/ecosystem/utils/format-json.md +39 -0
- package/docs/ecosystem/utils/format-phone-number.md +43 -0
- package/docs/ecosystem/utils/get-browser-locale.md +35 -0
- package/docs/ecosystem/utils/get-country-flag-url.md +67 -0
- package/docs/ecosystem/utils/get-error-message.md +45 -0
- package/docs/ecosystem/utils/idle-timeout.md +96 -0
- package/docs/ecosystem/utils/index.md +57 -0
- package/docs/ecosystem/utils/is-client.md +38 -0
- package/docs/ecosystem/utils/is-equal.md +44 -0
- package/docs/ecosystem/utils/is-ios.md +43 -0
- package/docs/ecosystem/utils/is-server.md +37 -0
- package/docs/ecosystem/utils/is-standalone-mode.md +49 -0
- package/docs/ecosystem/utils/kebab-case.md +42 -0
- package/docs/ecosystem/utils/normalize-string.md +83 -0
- package/docs/ecosystem/utils/number.md +51 -0
- package/docs/ecosystem/utils/pascal-case.md +41 -0
- package/docs/ecosystem/utils/prevent-ios-input-zoom.md +72 -0
- package/docs/ecosystem/utils/script-loader.md +85 -0
- package/docs/ecosystem/utils/sleep.md +65 -0
- package/docs/ecosystem/utils/snake-case.md +42 -0
- package/docs/ecosystem/utils/swipe-handler.md +97 -0
- package/docs/ecosystem/utils/textarea-autogrow.md +47 -0
- package/docs/ecosystem/utils/throttle-id.md +54 -0
- package/docs/ecosystem/utils/throttle.md +63 -0
- package/docs/ecosystem/utils/truthy-filter.md +37 -0
- package/docs/ecosystem/utils/types/deep-key-of.md +54 -0
- package/docs/ecosystem/utils/types/deep-partial.md +48 -0
- package/docs/ecosystem/utils/types/deep-required.md +45 -0
- package/docs/ecosystem/utils/types/flatten-object-keys.md +50 -0
- package/docs/ecosystem/utils/types/generic-instance-type.md +48 -0
- package/docs/ecosystem/utils/types/infer-maybe-ref.md +41 -0
- package/docs/ecosystem/utils/upper-first.md +38 -0
- package/docs/ecosystem/utils/user-visibility.md +75 -0
- package/docs/guide/ai-agents.md +237 -0
- package/docs/guide/browser-support.md +88 -0
- package/docs/guide/getting-started.md +191 -0
- package/docs/guide/global-defaults.md +103 -0
- package/docs/guide/maz-ui-provider.md +231 -0
- package/docs/guide/migration-v5.md +871 -0
- package/docs/guide/resolvers.md +650 -0
- package/docs/guide/tailwind.md +483 -0
- package/docs/guide/vue.md +286 -0
- package/docs/manifest.json +1 -0
- package/docs/plugins/aos.md +312 -0
- package/docs/plugins/dialog.md +269 -0
- package/docs/plugins/toast.md +221 -0
- package/docs/plugins/wait.md +78 -0
- package/docs/reference/icons.md +46 -0
- package/docs/reference/tailwind-tokens.md +191 -0
- package/docs/rules.md +57 -0
- package/package.json +31 -4
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazSkeleton"
|
|
3
|
+
description: "MazSkeleton is a standalone component to display loading placeholders with animated shimmer effect"
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-skeleton"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazSkeleton
|
|
9
|
+
|
|
10
|
+
> MazSkeleton is a standalone component to display loading placeholders with animated shimmer effect
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazSkeleton from 'maz-ui/components/MazSkeleton'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-skeleton
|
|
16
|
+
|
|
17
|
+
> Before use it, you should install the MazUi plugin in your project, follow instructions in [Getting Started](../guide/getting-started.md)
|
|
18
|
+
|
|
19
|
+
**Tip:**
|
|
20
|
+
|
|
21
|
+
This component can be translated globally using the [MazUi](../ecosystem/translations.md) plugin.
|
|
22
|
+
|
|
23
|
+
## Basic usage
|
|
24
|
+
|
|
25
|
+
The skeleton displays a loading placeholder with a shimmer animation by default.
|
|
26
|
+
|
|
27
|
+
```vue
|
|
28
|
+
<script lang="ts" setup>
|
|
29
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
30
|
+
</script>
|
|
31
|
+
|
|
32
|
+
<template>
|
|
33
|
+
<MazSkeleton />
|
|
34
|
+
</template>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Shapes
|
|
38
|
+
|
|
39
|
+
Use the `shape` prop to change the skeleton shape: `rectangle` (default), `circle`, or `square`.
|
|
40
|
+
|
|
41
|
+
```vue
|
|
42
|
+
<script lang="ts" setup>
|
|
43
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
44
|
+
</script>
|
|
45
|
+
|
|
46
|
+
<template>
|
|
47
|
+
<MazSkeleton shape="rectangle" width="100px" height="1rem" />
|
|
48
|
+
<MazSkeleton shape="circle" size="3rem" />
|
|
49
|
+
<MazSkeleton shape="square" size="3rem" />
|
|
50
|
+
</template>
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Sizes
|
|
54
|
+
|
|
55
|
+
Use the `size` prop to set both width and height (for circle and square shapes), or use `width` and `height` props for more control.
|
|
56
|
+
|
|
57
|
+
```vue
|
|
58
|
+
<script lang="ts" setup>
|
|
59
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
60
|
+
</script>
|
|
61
|
+
|
|
62
|
+
<template>
|
|
63
|
+
<MazSkeleton shape="circle" size="2rem" />
|
|
64
|
+
<MazSkeleton shape="circle" size="3rem" />
|
|
65
|
+
<MazSkeleton shape="circle" size="4rem" />
|
|
66
|
+
<MazSkeleton shape="circle" size="5rem" />
|
|
67
|
+
</template>
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Custom dimensions
|
|
71
|
+
|
|
72
|
+
For rectangles, use `width` and `height` props for precise control.
|
|
73
|
+
|
|
74
|
+
```vue
|
|
75
|
+
<script lang="ts" setup>
|
|
76
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
77
|
+
</script>
|
|
78
|
+
|
|
79
|
+
<template>
|
|
80
|
+
<MazSkeleton width="100%" height="0.75rem" />
|
|
81
|
+
<MazSkeleton width="80%" height="0.75rem" />
|
|
82
|
+
<MazSkeleton width="60%" height="0.75rem" />
|
|
83
|
+
</template>
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Rounded sizes
|
|
87
|
+
|
|
88
|
+
Control the border radius using the `rounded-size` prop.
|
|
89
|
+
|
|
90
|
+
```vue
|
|
91
|
+
<script lang="ts" setup>
|
|
92
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
93
|
+
</script>
|
|
94
|
+
|
|
95
|
+
<template>
|
|
96
|
+
<MazSkeleton rounded-size="none" width="80px" height="2rem" />
|
|
97
|
+
<MazSkeleton rounded-size="sm" width="80px" height="2rem" />
|
|
98
|
+
<MazSkeleton rounded-size="md" width="80px" height="2rem" />
|
|
99
|
+
<MazSkeleton rounded-size="lg" width="80px" height="2rem" />
|
|
100
|
+
<MazSkeleton rounded-size="xl" width="80px" height="2rem" />
|
|
101
|
+
<MazSkeleton rounded-size="full" width="80px" height="2rem" />
|
|
102
|
+
</template>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Disable animation
|
|
106
|
+
|
|
107
|
+
Use the `animated` prop set to `false` to disable the shimmer animation.
|
|
108
|
+
|
|
109
|
+
```vue
|
|
110
|
+
<script lang="ts" setup>
|
|
111
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
112
|
+
</script>
|
|
113
|
+
|
|
114
|
+
<template>
|
|
115
|
+
<MazSkeleton shape="circle" size="3rem" :animated="true" />
|
|
116
|
+
<MazSkeleton shape="circle" size="3rem" :animated="false" />
|
|
117
|
+
</template>
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Card skeleton example
|
|
121
|
+
|
|
122
|
+
Combine multiple skeletons to create loading placeholders for complex layouts.
|
|
123
|
+
|
|
124
|
+
```vue
|
|
125
|
+
<script lang="ts" setup>
|
|
126
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
127
|
+
</script>
|
|
128
|
+
|
|
129
|
+
<template>
|
|
130
|
+
<div class="card-skeleton">
|
|
131
|
+
<MazSkeleton shape="circle" size="3rem" />
|
|
132
|
+
<div class="content">
|
|
133
|
+
<MazSkeleton width="60%" height="0.875rem" />
|
|
134
|
+
<MazSkeleton width="40%" height="0.75rem" />
|
|
135
|
+
</div>
|
|
136
|
+
</div>
|
|
137
|
+
</template>
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## Article skeleton example
|
|
141
|
+
|
|
142
|
+
Create an article loading placeholder with various skeleton elements.
|
|
143
|
+
|
|
144
|
+
```vue
|
|
145
|
+
<script lang="ts" setup>
|
|
146
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
147
|
+
</script>
|
|
148
|
+
|
|
149
|
+
<template>
|
|
150
|
+
<div class="article-skeleton">
|
|
151
|
+
<!-- Featured image -->
|
|
152
|
+
<MazSkeleton width="100%" height="200px" rounded-size="lg" />
|
|
153
|
+
|
|
154
|
+
<!-- Title and description -->
|
|
155
|
+
<MazSkeleton width="80%" height="1.5rem" />
|
|
156
|
+
<MazSkeleton width="100%" height="0.75rem" />
|
|
157
|
+
<MazSkeleton width="100%" height="0.75rem" />
|
|
158
|
+
<MazSkeleton width="60%" height="0.75rem" />
|
|
159
|
+
|
|
160
|
+
<!-- Author -->
|
|
161
|
+
<div class="author">
|
|
162
|
+
<MazSkeleton shape="circle" size="2rem" />
|
|
163
|
+
<MazSkeleton width="100px" height="0.75rem" />
|
|
164
|
+
</div>
|
|
165
|
+
</div>
|
|
166
|
+
</template>
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## List skeleton example
|
|
170
|
+
|
|
171
|
+
Create a list loading placeholder.
|
|
172
|
+
|
|
173
|
+
```vue
|
|
174
|
+
<script lang="ts" setup>
|
|
175
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
176
|
+
</script>
|
|
177
|
+
|
|
178
|
+
<template>
|
|
179
|
+
<div class="list-skeleton">
|
|
180
|
+
<div v-for="i in 4" :key="i" class="list-item">
|
|
181
|
+
<MazSkeleton shape="square" size="2.5rem" rounded-size="md" />
|
|
182
|
+
<div class="content">
|
|
183
|
+
<MazSkeleton width="70%" height="0.75rem" />
|
|
184
|
+
<MazSkeleton width="50%" height="0.625rem" />
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
</template>
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Accessibility
|
|
192
|
+
|
|
193
|
+
The component includes proper accessibility attributes:
|
|
194
|
+
- `role="status"` to indicate loading state
|
|
195
|
+
- `aria-live="polite"` for screen reader announcements
|
|
196
|
+
- Customizable `aria-label` and `loading-text` props
|
|
197
|
+
|
|
198
|
+
```vue
|
|
199
|
+
<script lang="ts" setup>
|
|
200
|
+
import MazSkeleton from 'maz-ui/components/MazSkeleton'
|
|
201
|
+
</script>
|
|
202
|
+
|
|
203
|
+
<template>
|
|
204
|
+
<MazSkeleton
|
|
205
|
+
shape="circle"
|
|
206
|
+
size="3rem"
|
|
207
|
+
aria-label="Loading user avatar"
|
|
208
|
+
loading-text="Please wait while loading..."
|
|
209
|
+
/>
|
|
210
|
+
</template>
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## MazSkeleton API
|
|
214
|
+
|
|
215
|
+
`import MazSkeleton from 'maz-ui/components/MazSkeleton'`
|
|
216
|
+
|
|
217
|
+
### Props
|
|
218
|
+
|
|
219
|
+
- `shape` (`"square" | "circle" | "rectangle"`, default: `"rectangle"`): Skeleton shape type.
|
|
220
|
+
- `size` (`` `${number}rem` | `${number}px` | `${number}em` | `${number}vw` | `${number}vh` | `${number}vmin` | `${number}vmax` | `${number}%` | `${number}ch` | `${number}cm` | `${number}mm` | `${number}in` | `${number}ex` | `${number}pc` | `${number... ``, default: `"1rem"`): Size with units (ex: '2rem', '40px', '3em').
|
|
221
|
+
- `width` (`` `${number}rem` | `${number}px` | `${number}em` | `${number}vw` | `${number}vh` | `${number}vmin` | `${number}vmax` | `${number}%` | `${number}ch` | `${number}cm` | `${number}mm` | `${number}in` | `${number}ex` | `${number}pc` | `${number... ``): Custom width.
|
|
222
|
+
- `height` (`` `${number}rem` | `${number}px` | `${number}em` | `${number}vw` | `${number}vh` | `${number}vmin` | `${number}vmax` | `${number}%` | `${number}ch` | `${number}cm` | `${number}mm` | `${number}in` | `${number}ex` | `${number}pc` | `${number... ``): Custom height.
|
|
223
|
+
- `animated` (`boolean`, default: `true`): Disable animation.
|
|
224
|
+
- `rounded-size` (`MazRoundedSize`, default: `'md'`): Controls the border radius. Values: `'none'`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'full'` (non exhaustive).
|
|
225
|
+
- `aria-label` (`string`, default: `'skeleton.ariaLabel' (translations)`): Accessibility label.
|
|
226
|
+
- `loading-text` (`string`, default: `'skeleton.loadingText' (translations)`): Loading text for accessibility.
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazSlider"
|
|
3
|
+
description: "MazSlider is a standalone component that replaces the standard html input range with a beautiful design system. Many options like multiple cursors and values, colors, sizes and logarithmic/exponential values are available"
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-slider"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazSlider
|
|
9
|
+
|
|
10
|
+
> MazSlider is a standalone component that replaces the standard html input range with a beautiful design system. Many options like multiple cursors and values, colors, sizes and logarithmic/exponential values are available
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazSlider from 'maz-ui/components/MazSlider'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-slider
|
|
16
|
+
|
|
17
|
+
> Before use it, you should install the MazUi plugin in your project, follow instructions in [Getting Started](../guide/getting-started.md)
|
|
18
|
+
|
|
19
|
+
## Basic usage
|
|
20
|
+
|
|
21
|
+
```vue
|
|
22
|
+
<script lang="ts" setup>
|
|
23
|
+
import MazSlider from 'maz-ui/components/MazSlider'
|
|
24
|
+
import { ref } from 'vue'
|
|
25
|
+
const sliderValue = ref(50)
|
|
26
|
+
</script>
|
|
27
|
+
|
|
28
|
+
<template>
|
|
29
|
+
<MazSlider v-model="sliderValue" />
|
|
30
|
+
</template>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Options
|
|
34
|
+
|
|
35
|
+
### Step
|
|
36
|
+
|
|
37
|
+
```html
|
|
38
|
+
<MazSlider v-model="value" :step="10" class="vp-raw" />
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Multiple sliders & labels
|
|
42
|
+
|
|
43
|
+
```vue
|
|
44
|
+
<script lang="ts" setup>
|
|
45
|
+
import MazSlider from 'maz-ui/components/MazSlider'
|
|
46
|
+
import { ref } from 'vue'
|
|
47
|
+
const multipleSilders = ref([25, 50, 75])
|
|
48
|
+
const multipleSildersLabels = ['Small', 'Middle', 'Big']
|
|
49
|
+
</script>
|
|
50
|
+
|
|
51
|
+
<template>
|
|
52
|
+
<MazSlider v-model="multipleSilders" :labels="multipleSildersLabels" />
|
|
53
|
+
</template>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Sizes & colors
|
|
57
|
+
|
|
58
|
+
```vue
|
|
59
|
+
<script lang="ts" setup>
|
|
60
|
+
import MazSlider from 'maz-ui/components/MazSlider'
|
|
61
|
+
import { ref } from 'vue'
|
|
62
|
+
const multipleSilders = ref([25, 50, 75])
|
|
63
|
+
const multipleSildersLabels = ['Small', 'Middle', 'Big']
|
|
64
|
+
</script>
|
|
65
|
+
|
|
66
|
+
<template>
|
|
67
|
+
<MazSlider
|
|
68
|
+
v-model="multipleSilders"
|
|
69
|
+
:labels="multipleSildersLabels"
|
|
70
|
+
color="secondary"
|
|
71
|
+
size="1.5rem"
|
|
72
|
+
/>
|
|
73
|
+
|
|
74
|
+
<MazSlider
|
|
75
|
+
v-model="multipleSilders"
|
|
76
|
+
:labels="multipleSildersLabels"
|
|
77
|
+
color="destructive"
|
|
78
|
+
size="1.2rem"
|
|
79
|
+
/>
|
|
80
|
+
|
|
81
|
+
<MazSlider
|
|
82
|
+
v-model="multipleSilders"
|
|
83
|
+
:labels="multipleSildersLabels"
|
|
84
|
+
color="success"
|
|
85
|
+
size="12px"
|
|
86
|
+
/>
|
|
87
|
+
|
|
88
|
+
<MazSlider
|
|
89
|
+
v-model="multipleSilders"
|
|
90
|
+
:labels="multipleSildersLabels"
|
|
91
|
+
color="info"
|
|
92
|
+
size="10px"
|
|
93
|
+
/>
|
|
94
|
+
</template>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Logarithmic/exponential
|
|
98
|
+
|
|
99
|
+
```vue
|
|
100
|
+
<script lang="ts" setup>
|
|
101
|
+
import MazSlider from 'maz-ui/components/MazSlider'
|
|
102
|
+
import { ref } from 'vue'
|
|
103
|
+
const logSilders = ref([50, 10000, 30000, 45000])
|
|
104
|
+
const logSildersLabels: ['Micro', 'Small', 'Middle', 'Big']
|
|
105
|
+
</script>
|
|
106
|
+
|
|
107
|
+
<template>
|
|
108
|
+
<MazSlider
|
|
109
|
+
v-model="logSilders"
|
|
110
|
+
:labels="logSildersLabels"
|
|
111
|
+
:min="50"
|
|
112
|
+
:max="50000"
|
|
113
|
+
logs
|
|
114
|
+
/>
|
|
115
|
+
</template>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## hide dividers & cursor animation
|
|
119
|
+
|
|
120
|
+
> Each sections between cursors has the same color
|
|
121
|
+
>
|
|
122
|
+
> Component don't have animation on cursor
|
|
123
|
+
|
|
124
|
+
```vue
|
|
125
|
+
<script lang="ts" setup>
|
|
126
|
+
import MazSlider from 'maz-ui/components/MazSlider'
|
|
127
|
+
import { ref } from 'vue'
|
|
128
|
+
const multipleSilders = ref([25, 50, 75])
|
|
129
|
+
</script>
|
|
130
|
+
|
|
131
|
+
<template>
|
|
132
|
+
<MazSlider
|
|
133
|
+
v-model="multipleSilders"
|
|
134
|
+
:divider="false"
|
|
135
|
+
:cursor-anim="false"
|
|
136
|
+
/>
|
|
137
|
+
</template>
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## Accessibility
|
|
141
|
+
|
|
142
|
+
Each cursor is a `slider` with `aria-valuenow`, `aria-valuemin`, `aria-valuemax` and `aria-valuetext` when `labels` are set.
|
|
143
|
+
|
|
144
|
+
**Keyboard**: ← / ↓ and → / ↑ move by one `step`, Page Down / Page Up by ten steps, Home / End to the lowest / highest value allowed for the cursor (a cursor never passes its neighbours).
|
|
145
|
+
|
|
146
|
+
## MazSlider API
|
|
147
|
+
|
|
148
|
+
`import MazSlider from 'maz-ui/components/MazSlider'`
|
|
149
|
+
|
|
150
|
+
### Props
|
|
151
|
+
|
|
152
|
+
- `model-value` (`number | number[] | null`, required, `v-model`): Array of cursors values.
|
|
153
|
+
- `labels` (`string[]`): array of cursors label.
|
|
154
|
+
- `min` (`number`, default: `0`): min value of sliders.
|
|
155
|
+
- `max` (`number`, default: `100`): max value of sliders.
|
|
156
|
+
- `step` (`number`, default: `1`): step value for slider increments.
|
|
157
|
+
- `size` (`` `${number}rem` | `${number}px` | `${number}em` | `${number}vw` | `${number}vh` | `${number}vmin` | `${number}vmax` | `${number}%` | `${number}ch` | `${number}cm` | `${number}mm` | `${number}in` | `${number}ex` | `${number}pc` | `${number... ``): height size of slider bar.
|
|
158
|
+
- `divider` (`boolean`, default: `true`): remove div in different colors.
|
|
159
|
+
- `log` (`boolean`, default: `false`): become a logarithmic slider (exponential).
|
|
160
|
+
- `color` (`"primary" | "secondary" | "accent" | "info" | "success" | "warning" | "destructive" | "contrast" | "transparent"`, default: `"primary"`): main slider color.
|
|
161
|
+
- `cursor-anim` (`boolean`, default: `true`): disables cursor animation when active.
|
|
162
|
+
|
|
163
|
+
### Events
|
|
164
|
+
|
|
165
|
+
- `@update:model-value` (payload: `any[`)
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazSpinner"
|
|
3
|
+
description: "MazSpinner is a standalone component that replaces the standard html input checkbox. Color options are available."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-spinner"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazSpinner
|
|
9
|
+
|
|
10
|
+
> MazSpinner is a standalone component that replaces the standard html input checkbox. Color options are available.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazSpinner from 'maz-ui/components/MazSpinner'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-spinner
|
|
16
|
+
|
|
17
|
+
## Basic usage
|
|
18
|
+
|
|
19
|
+
```vue
|
|
20
|
+
<script>
|
|
21
|
+
import MazSpinner from 'maz-ui/components/MazSpinner'
|
|
22
|
+
</script>
|
|
23
|
+
|
|
24
|
+
<template>
|
|
25
|
+
<MazSpinner />
|
|
26
|
+
</template>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Options
|
|
30
|
+
|
|
31
|
+
### Colors
|
|
32
|
+
|
|
33
|
+
Choose the color of the spinner
|
|
34
|
+
|
|
35
|
+
By default the color is `theme`
|
|
36
|
+
|
|
37
|
+
```vue
|
|
38
|
+
<MazSpinner color="primary" />
|
|
39
|
+
|
|
40
|
+
<MazSpinner color="secondary" />
|
|
41
|
+
|
|
42
|
+
<MazSpinner color="destructive" />
|
|
43
|
+
|
|
44
|
+
<MazSpinner color="warning" />
|
|
45
|
+
|
|
46
|
+
<MazSpinner color="success" />
|
|
47
|
+
|
|
48
|
+
<MazSpinner color="info" />
|
|
49
|
+
|
|
50
|
+
<MazSpinner color="accent" />
|
|
51
|
+
|
|
52
|
+
<MazSpinner color="contrast" />
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Sizes
|
|
56
|
+
|
|
57
|
+
Choose the size of the spinner
|
|
58
|
+
|
|
59
|
+
The default size is `2em`
|
|
60
|
+
|
|
61
|
+
```vue
|
|
62
|
+
<MazSpinner size="1em" />
|
|
63
|
+
|
|
64
|
+
<MazSpinner size="2em" />
|
|
65
|
+
|
|
66
|
+
<MazSpinner size="3em" />
|
|
67
|
+
|
|
68
|
+
<MazSpinner size="4em" />
|
|
69
|
+
|
|
70
|
+
<MazSpinner size="5em" />
|
|
71
|
+
|
|
72
|
+
<MazSpinner size="6em" />
|
|
73
|
+
|
|
74
|
+
<MazSpinner size="7em" />
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## MazSpinner API
|
|
78
|
+
|
|
79
|
+
`import MazSpinner from 'maz-ui/components/MazSpinner'`
|
|
80
|
+
|
|
81
|
+
### Props
|
|
82
|
+
|
|
83
|
+
- `size` (`` `${number}rem` | `${number}px` | `${number}em` | `${number}vw` | `${number}vh` | `${number}vmin` | `${number}vmax` | `${number}%` | `${number}ch` | `${number}cm` | `${number}mm` | `${number}in` | `${number}ex` | `${number}pc` | `${number... ``, default: `"2em"`): The size of the spinner.
|
|
84
|
+
- `color` (`"primary" | "secondary" | "accent" | "info" | "success" | "warning" | "destructive" | "contrast" | "transparent"`, default: `"theme"`): The color of the spinner.
|