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,301 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazStepper"
|
|
3
|
+
description: "MazStepper is a standalone UI component customizable, reactive for intuitive step-by-step navigation. Ideal for guiding users through forms, workflows, or checkout processes."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-stepper"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazStepper
|
|
9
|
+
|
|
10
|
+
> MazStepper is a standalone UI component customizable, reactive for intuitive step-by-step navigation. Ideal for guiding users through forms, workflows, or checkout processes.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazStepper from 'maz-ui/components/MazStepper'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-stepper
|
|
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
|
+
**Details: View code**
|
|
22
|
+
|
|
23
|
+
```vue
|
|
24
|
+
<template>
|
|
25
|
+
<MazStepper auto-validate-steps>
|
|
26
|
+
<template #title-1>
|
|
27
|
+
Sign-In
|
|
28
|
+
</template>
|
|
29
|
+
<template #subtitle-1>
|
|
30
|
+
You should be signed in to continue
|
|
31
|
+
</template>
|
|
32
|
+
<template #title-info-1>
|
|
33
|
+
Required
|
|
34
|
+
</template>
|
|
35
|
+
<template #content-1="{ nextStep }">
|
|
36
|
+
<form @submit.prevent="nextStep">
|
|
37
|
+
<MazInput v-model="email" label="E-mail" type="email" autocomplete="new-email" name="new-email" />
|
|
38
|
+
<br />
|
|
39
|
+
<MazInput v-model="password" label="password" type="password" autocomplete="new-password" name="new-password" />
|
|
40
|
+
<br />
|
|
41
|
+
<MazBtn type="submit">
|
|
42
|
+
Sign-In
|
|
43
|
+
</MazBtn>
|
|
44
|
+
</form>
|
|
45
|
+
</template>
|
|
46
|
+
|
|
47
|
+
<template #title-2>
|
|
48
|
+
Delivery address
|
|
49
|
+
</template>
|
|
50
|
+
<template #subtitle-2>
|
|
51
|
+
Where should we deliver your package?
|
|
52
|
+
</template>
|
|
53
|
+
<template #title-info-2>
|
|
54
|
+
{{ address }}
|
|
55
|
+
</template>
|
|
56
|
+
<template #content-2="{ nextStep, previousStep }">
|
|
57
|
+
<MazInput v-model="address" label="Delivery address" />
|
|
58
|
+
<br />
|
|
59
|
+
<MazBtn @click="previousStep" color="secondary">
|
|
60
|
+
Previous
|
|
61
|
+
</MazBtn>
|
|
62
|
+
<br />
|
|
63
|
+
<br />
|
|
64
|
+
<MazBtn @click="nextStep">
|
|
65
|
+
Validate
|
|
66
|
+
</MazBtn>
|
|
67
|
+
</template>
|
|
68
|
+
|
|
69
|
+
<template #title-3>
|
|
70
|
+
Checkout
|
|
71
|
+
</template>
|
|
72
|
+
<template #subtitle-3>
|
|
73
|
+
Provide credit card
|
|
74
|
+
</template>
|
|
75
|
+
<template #content-3="{ nextStep, previousStep }">
|
|
76
|
+
<MazInput label="Credit card number" type="number" />
|
|
77
|
+
<br />
|
|
78
|
+
<MazBtn @click="previousStep" color="secondary">
|
|
79
|
+
Previous
|
|
80
|
+
</MazBtn>
|
|
81
|
+
<br />
|
|
82
|
+
<br />
|
|
83
|
+
<MazBtn @click="nextStep">
|
|
84
|
+
Payment
|
|
85
|
+
</MazBtn>
|
|
86
|
+
</template>
|
|
87
|
+
</MazStepper>
|
|
88
|
+
</template>
|
|
89
|
+
|
|
90
|
+
<script lang="ts" setup>
|
|
91
|
+
import { ref } from 'vue'
|
|
92
|
+
|
|
93
|
+
const email = ref()
|
|
94
|
+
const password = ref()
|
|
95
|
+
const address = ref('20 Cooper Square')
|
|
96
|
+
</script>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Use `step` property instead of slots
|
|
100
|
+
|
|
101
|
+
Instead of using slots, you can provide its data with the `steps` property
|
|
102
|
+
|
|
103
|
+
You can use html in all properties
|
|
104
|
+
|
|
105
|
+
```vue{3-8}
|
|
106
|
+
<template>
|
|
107
|
+
<MazStepper
|
|
108
|
+
:steps="[
|
|
109
|
+
{ title: 'Title 1', subtitle: 'Subtitle 1', titleInfo: 'Info 1', content: 'Content 1' },
|
|
110
|
+
{ title: 'Title 2', subtitle: '<span class="text-primary">Subtitle 2</span>', titleInfo: 'Info 2', content: 'Content 2' },
|
|
111
|
+
{ title: 'Title 3', subtitle: 'Subtitle 3', titleInfo: 'Info 3', content: 'Content 3' },
|
|
112
|
+
{ title: 'Title 4', subtitle: 'Subtitle 4', titleInfo: 'Info 4', content: 'Content 4' },
|
|
113
|
+
]"
|
|
114
|
+
/>
|
|
115
|
+
</template>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Replace default step point
|
|
119
|
+
|
|
120
|
+
```vue{8-10}
|
|
121
|
+
<template>
|
|
122
|
+
<MazStepper
|
|
123
|
+
:steps="[
|
|
124
|
+
{ title: 'Title 1', subtitle: 'Subtitle 1', titleInfo: 'Info 1', content: 'Content 1' },
|
|
125
|
+
{ title: 'Title 2', subtitle: 'Subtitle 2', titleInfo: 'Info 2', content: 'Content 2' },
|
|
126
|
+
]"
|
|
127
|
+
>
|
|
128
|
+
<template #point="{ step }">
|
|
129
|
+
<div class="bg-red-500 p-1 size-8 rounded flex flex-center">{{ step }}</div>
|
|
130
|
+
</template>
|
|
131
|
+
</MazStepper>
|
|
132
|
+
</template>
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Set step states programmatically
|
|
136
|
+
|
|
137
|
+
You can set differents state with its style to each step with the property `step`
|
|
138
|
+
|
|
139
|
+
States available: `'success' | 'warning' | 'error' | 'disabled'`
|
|
140
|
+
|
|
141
|
+
You should respect order of steps in the array:
|
|
142
|
+
|
|
143
|
+
```vue{4-9}
|
|
144
|
+
<template>
|
|
145
|
+
<MazStepper
|
|
146
|
+
v-model="currentStep"
|
|
147
|
+
:steps="[
|
|
148
|
+
{ disabled: true },
|
|
149
|
+
{ success: true },
|
|
150
|
+
{ warning: true, disabled: true },
|
|
151
|
+
{ error: true },
|
|
152
|
+
]"
|
|
153
|
+
>
|
|
154
|
+
<template #title-1> Title 1 </template>
|
|
155
|
+
<template #title-info-1> Disabled </template>
|
|
156
|
+
<template #content-1> Content 1 </template>
|
|
157
|
+
|
|
158
|
+
<template #title-2> Title 2 </template>
|
|
159
|
+
<template #title-info-2> Success </template>
|
|
160
|
+
<template #content-2> Content 2 </template>
|
|
161
|
+
|
|
162
|
+
<template #title-3> Title 3 </template>
|
|
163
|
+
<template #title-info-3> Warning & Disabled </template>
|
|
164
|
+
<template #content-3> Content 3 </template>
|
|
165
|
+
|
|
166
|
+
<template #title-4> Title 4 </template>
|
|
167
|
+
<template #title-info-4> Error </template>
|
|
168
|
+
<template #content-4> Content 4 </template>
|
|
169
|
+
</MazStepper>
|
|
170
|
+
</template>
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Auto validate steps
|
|
174
|
+
|
|
175
|
+
You can use the prop option:
|
|
176
|
+
|
|
177
|
+
- `auto-validate-steps`
|
|
178
|
+
|
|
179
|
+
Then all previous steps then the current and then the validated state
|
|
180
|
+
|
|
181
|
+
**Tip:**
|
|
182
|
+
|
|
183
|
+
Click on the first or third step to see the validated steps changes:
|
|
184
|
+
|
|
185
|
+
```vue{4}
|
|
186
|
+
<template>
|
|
187
|
+
<MazStepper
|
|
188
|
+
v-model="currentStep"
|
|
189
|
+
auto-validate-steps
|
|
190
|
+
color="secondary"
|
|
191
|
+
>
|
|
192
|
+
<template #title-1> Step 1 </template>
|
|
193
|
+
<template #content-1> Content 1 </template>
|
|
194
|
+
|
|
195
|
+
<template #title-2> Step 2 </template>
|
|
196
|
+
<template #content-2> Content 2 </template>
|
|
197
|
+
|
|
198
|
+
<template #title-3> Step 3 </template>
|
|
199
|
+
<template #content-3> Content 3 </template>
|
|
200
|
+
</MazStepper>
|
|
201
|
+
</template>
|
|
202
|
+
|
|
203
|
+
<script setup lang="ts">
|
|
204
|
+
import { ref } from 'vue'
|
|
205
|
+
const currentStep = ref(2)
|
|
206
|
+
</script>
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## Auto disabled next or/and previous steps
|
|
210
|
+
|
|
211
|
+
To not allow your users to go to the next steps, you can use the following prop options:
|
|
212
|
+
|
|
213
|
+
- `disabled-previous-steps`
|
|
214
|
+
- `disabled-next-steps`
|
|
215
|
+
|
|
216
|
+
**Tip:**
|
|
217
|
+
|
|
218
|
+
Try to click on first and third steps
|
|
219
|
+
|
|
220
|
+
```vue{4,5}
|
|
221
|
+
<template>
|
|
222
|
+
<MazStepper
|
|
223
|
+
:model-value="2"
|
|
224
|
+
disabled-previous-steps
|
|
225
|
+
disabled-next-steps
|
|
226
|
+
>
|
|
227
|
+
<template #title-1> Step 1 </template>
|
|
228
|
+
<template #content-1> Content 1 </template>
|
|
229
|
+
|
|
230
|
+
<template #title-2> Step 2 </template>
|
|
231
|
+
<template #content-2> Content 2 </template>
|
|
232
|
+
|
|
233
|
+
<template #title-3> Step 3 </template>
|
|
234
|
+
<template #content-3> Content 3 </template>
|
|
235
|
+
</MazStepper>
|
|
236
|
+
</template>
|
|
237
|
+
|
|
238
|
+
<script setup lang="ts">
|
|
239
|
+
import { ref } from 'vue'
|
|
240
|
+
const currentStep = ref(2)
|
|
241
|
+
</script>
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## All steps opened & success
|
|
245
|
+
|
|
246
|
+
To open and validate all steps, you can use the following prop options:
|
|
247
|
+
|
|
248
|
+
- `all-steps-validated`
|
|
249
|
+
- `all-steps-opened`
|
|
250
|
+
|
|
251
|
+
## Can close steps
|
|
252
|
+
|
|
253
|
+
Use the property `can-close-steps` to let the user be able to close each step on click
|
|
254
|
+
|
|
255
|
+
**Tip:**
|
|
256
|
+
|
|
257
|
+
Click on step titles to toggle content
|
|
258
|
+
|
|
259
|
+
## Types
|
|
260
|
+
|
|
261
|
+
`step` property model
|
|
262
|
+
|
|
263
|
+
```ts
|
|
264
|
+
type Steps = Array<{
|
|
265
|
+
title?: string
|
|
266
|
+
subtitle?: string
|
|
267
|
+
titleInfo?: string
|
|
268
|
+
disabled?: boolean
|
|
269
|
+
error?: boolean
|
|
270
|
+
success?: boolean
|
|
271
|
+
warning?: boolean
|
|
272
|
+
}>
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
## Accessibility
|
|
276
|
+
|
|
277
|
+
Each step header is a button exposing the current step (`aria-current="step"`) and its open state (`aria-expanded`), and controls its content (`aria-controls`), labelled by the header. The ids are unique per instance.
|
|
278
|
+
|
|
279
|
+
## MazStepper API
|
|
280
|
+
|
|
281
|
+
`import MazStepper from 'maz-ui/components/MazStepper'`
|
|
282
|
+
|
|
283
|
+
### Props
|
|
284
|
+
|
|
285
|
+
- `model-value` (`number`, `v-model`): The current step.
|
|
286
|
+
- `steps` (`MazStepperStep[]`): The steps.
|
|
287
|
+
- `color` (`"primary" | "secondary" | "accent" | "info" | "success" | "warning" | "destructive" | "contrast" | "transparent"`, default: `"primary"`): The color of the stepper.
|
|
288
|
+
- `disabled-next-steps` (`boolean`): Disable the next steps.
|
|
289
|
+
- `disabled-previous-steps` (`boolean`): Disable the previous steps.
|
|
290
|
+
- `auto-validate-steps` (`boolean`): Auto validate the steps.
|
|
291
|
+
- `all-steps-opened` (`boolean`): Open all steps.
|
|
292
|
+
- `all-steps-validated` (`boolean`): Validate all steps.
|
|
293
|
+
- `can-close-steps` (`boolean`): Allow to close the steps.
|
|
294
|
+
|
|
295
|
+
### Events
|
|
296
|
+
|
|
297
|
+
- `@update:model-value` (payload: `value: number`)
|
|
298
|
+
|
|
299
|
+
### Slots
|
|
300
|
+
|
|
301
|
+
- `#point` Bindings: `step: number`.
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazSwitch"
|
|
3
|
+
description: "MazSwitch 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-switch"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazSwitch
|
|
9
|
+
|
|
10
|
+
> MazSwitch is a standalone component that replaces the standard html input checkbox. Color options are available.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazSwitch from 'maz-ui/components/MazSwitch'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-switch
|
|
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
|
+
```vue
|
|
20
|
+
<template>
|
|
21
|
+
<MazSwitch
|
|
22
|
+
v-for="color in colors"
|
|
23
|
+
v-model="switchValue"
|
|
24
|
+
:color="color"
|
|
25
|
+
:name="color"
|
|
26
|
+
:key="color"
|
|
27
|
+
/>
|
|
28
|
+
|
|
29
|
+
<p>Disabled</p>
|
|
30
|
+
|
|
31
|
+
<MazSwitch
|
|
32
|
+
v-model="switchValue"
|
|
33
|
+
name="disabled"
|
|
34
|
+
disabled
|
|
35
|
+
>
|
|
36
|
+
{{ color }}
|
|
37
|
+
</MazSwitch>
|
|
38
|
+
</template>
|
|
39
|
+
|
|
40
|
+
<script lang="ts" setup>
|
|
41
|
+
import { ref } from 'vue'
|
|
42
|
+
import MazSwitch from 'maz-ui/components/MazSwitch'
|
|
43
|
+
|
|
44
|
+
const switchValue = ref(false)
|
|
45
|
+
const switchValueDisabled = ref(false)
|
|
46
|
+
|
|
47
|
+
const colors = [
|
|
48
|
+
'primary',
|
|
49
|
+
'secondary',
|
|
50
|
+
'info',
|
|
51
|
+
'success',
|
|
52
|
+
'warning',
|
|
53
|
+
'destructive',
|
|
54
|
+
'accent',
|
|
55
|
+
'contrast',
|
|
56
|
+
]
|
|
57
|
+
</script>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## MazSwitch API
|
|
61
|
+
|
|
62
|
+
`import MazSwitch from 'maz-ui/components/MazSwitch'`
|
|
63
|
+
|
|
64
|
+
### Props
|
|
65
|
+
|
|
66
|
+
- `model-value` (`boolean`, default: `false`, `v-model`): The model value of the switch.
|
|
67
|
+
- `id` (`string`): The id of the switch.
|
|
68
|
+
- `disabled` (`boolean`): If the switch is disabled.
|
|
69
|
+
- `name` (`string`): The name of the switch.
|
|
70
|
+
- `label` (`string`): Text label.
|
|
71
|
+
- `color` (`"primary" | "secondary" | "accent" | "info" | "success" | "warning" | "destructive" | "contrast" | "transparent"`, default: `"primary"`): The color of the switch.
|
|
72
|
+
- `error` (`boolean`): Whether there is an error with the input.
|
|
73
|
+
- `success` (`boolean`): Whether the input is successful.
|
|
74
|
+
- `warning` (`boolean`): Whether there is a warning with the input.
|
|
75
|
+
- `hint` (`string`): The hint text to display below the input.
|
|
76
|
+
|
|
77
|
+
### Events
|
|
78
|
+
|
|
79
|
+
- `@update:model-value` (payload: `value: boolean`): Emitted when the model value changes
|
|
80
|
+
- `@blur` (payload: `value: FocusEvent`): Emitted when the switch lost focus
|
|
81
|
+
- `@change` (payload: `value: boolean`): Emitted when the model value changes
|
|
82
|
+
- `@focus` (payload: `value: FocusEvent`): Emitted when the switch is focused
|
|
83
|
+
|
|
84
|
+
### Slots
|
|
85
|
+
|
|
86
|
+
- `#default`: The label of the switch Bindings: `value: boolean` (The value of the switch).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazTableCell"
|
|
3
|
+
description: "MazTableCell is a building block of MazTable."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MazTableCell
|
|
8
|
+
|
|
9
|
+
> MazTableCell is a building block of MazTable.
|
|
10
|
+
|
|
11
|
+
- Package: `maz-ui`
|
|
12
|
+
- Import: `import MazTableCell from 'maz-ui/components/MazTableCell'`
|
|
13
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
14
|
+
|
|
15
|
+
Used inside [MazTable](./maz-table.md): read its page for complete examples.
|
|
16
|
+
|
|
17
|
+
## MazTableCell API
|
|
18
|
+
|
|
19
|
+
`import MazTableCell from 'maz-ui/components/MazTableCell'`
|
|
20
|
+
|
|
21
|
+
### Props
|
|
22
|
+
|
|
23
|
+
No props.
|
|
24
|
+
|
|
25
|
+
### Slots
|
|
26
|
+
|
|
27
|
+
- `#default`
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazTableRow"
|
|
3
|
+
description: "MazTableRow is a building block of MazTable."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MazTableRow
|
|
8
|
+
|
|
9
|
+
> MazTableRow is a building block of MazTable.
|
|
10
|
+
|
|
11
|
+
- Package: `maz-ui`
|
|
12
|
+
- Import: `import MazTableRow from 'maz-ui/components/MazTableRow'`
|
|
13
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
14
|
+
|
|
15
|
+
Used inside [MazTable](./maz-table.md): read its page for complete examples.
|
|
16
|
+
|
|
17
|
+
## MazTableRow API
|
|
18
|
+
|
|
19
|
+
`import MazTableRow from 'maz-ui/components/MazTableRow'`
|
|
20
|
+
|
|
21
|
+
### Props
|
|
22
|
+
|
|
23
|
+
- `hoverable` (`boolean`, default: `true`): Override hoverable of table props.
|
|
24
|
+
- `is-head` (`boolean`, default: `false`): If true, the row is a head row.
|
|
25
|
+
|
|
26
|
+
### Slots
|
|
27
|
+
|
|
28
|
+
- `#default`
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazTableTitle"
|
|
3
|
+
description: "MazTableTitle is a building block of MazTable."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MazTableTitle
|
|
8
|
+
|
|
9
|
+
> MazTableTitle is a building block of MazTable.
|
|
10
|
+
|
|
11
|
+
- Package: `maz-ui`
|
|
12
|
+
- Import: `import MazTableTitle from 'maz-ui/components/MazTableTitle'`
|
|
13
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
14
|
+
|
|
15
|
+
Used inside [MazTable](./maz-table.md): read its page for complete examples.
|
|
16
|
+
|
|
17
|
+
## MazTableTitle API
|
|
18
|
+
|
|
19
|
+
`import MazTableTitle from 'maz-ui/components/MazTableTitle'`
|
|
20
|
+
|
|
21
|
+
### Props
|
|
22
|
+
|
|
23
|
+
No props.
|
|
24
|
+
|
|
25
|
+
### Slots
|
|
26
|
+
|
|
27
|
+
- `#default`
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazTableVirtualizer"
|
|
3
|
+
description: "MazTableVirtualizer component."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MazTableVirtualizer
|
|
8
|
+
|
|
9
|
+
> MazTableVirtualizer component.
|
|
10
|
+
|
|
11
|
+
- Package: `maz-ui`
|
|
12
|
+
- Import: `import MazTableVirtualizer from 'maz-ui/components/MazTableVirtualizer'`
|
|
13
|
+
|
|
14
|
+
## MazTableVirtualizer API
|
|
15
|
+
|
|
16
|
+
`import MazTableVirtualizer from 'maz-ui/components/MazTableVirtualizer'`
|
|
17
|
+
|
|
18
|
+
### Props
|
|
19
|
+
|
|
20
|
+
- `count` (`number`, required): Total number of rows to virtualize.
|
|
21
|
+
- `scroll-element` (`HTMLElement | null`, default: `null`): Scrollable viewport element the virtualizer observes.
|
|
22
|
+
- `estimate-size` (`number`, default: `44`): Fixed per-row height used to place rows and size the spacers.
|
|
23
|
+
- `overscan` (`number`, default: `10`): Rows rendered outside the viewport on each side.
|
|
24
|
+
|
|
25
|
+
### Events
|
|
26
|
+
|
|
27
|
+
- `@change` (payload: `window: MazTableVirtualWindow`)
|
|
28
|
+
|
|
29
|
+
### Slots
|
|
30
|
+
|
|
31
|
+
- `#default`
|