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,203 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazIcon"
|
|
3
|
+
description: "A flexible icon component that accepts Vue components, raw SVG strings, URLs and data URIs."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-icon"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazIcon
|
|
9
|
+
|
|
10
|
+
> A flexible icon component that accepts Vue components, raw SVG strings, URLs and data URIs.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazIcon from 'maz-ui/components/MazIcon'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-icon
|
|
16
|
+
|
|
17
|
+
**Tip:**
|
|
18
|
+
|
|
19
|
+
Download the bundled icons pack or use [`@maz-ui/icons`](../ecosystem/icons/index.md) for the full set.
|
|
20
|
+
|
|
21
|
+
## How it works
|
|
22
|
+
|
|
23
|
+
Pass an `icon` prop in any of the supported formats - the component detects what it received and renders accordingly:
|
|
24
|
+
|
|
25
|
+
| Input | Example | Use it for |
|
|
26
|
+
| --- | --- | --- |
|
|
27
|
+
| **Vue component** | `import { MazStar } from '@maz-ui/icons/static/MazStar'` | Always-rendered icons that you also want available as a standalone component (`<MazStar />`). |
|
|
28
|
+
| **Raw SVG string** | `import { MazStar } from '@maz-ui/icons/raw/MazStar'` | Always-rendered icons - the lightest format, no Vue component overhead. |
|
|
29
|
+
| **URL or `data:` URI** | `'/icons/star.svg'`, `'data:image/svg+xml,…'` | SVGs hosted in your `public/` folder or external CDN. Fetched and cached on demand. |
|
|
30
|
+
|
|
31
|
+
```vue
|
|
32
|
+
<script setup>
|
|
33
|
+
import MazIcon from 'maz-ui/components/MazIcon'
|
|
34
|
+
import { MazStar } from '@maz-ui/icons/raw/MazStar'
|
|
35
|
+
</script>
|
|
36
|
+
|
|
37
|
+
<template>
|
|
38
|
+
<MazIcon :icon="MazStar" />
|
|
39
|
+
<MazIcon icon="/icons/star.svg" />
|
|
40
|
+
<MazIcon icon="<svg viewBox='0 0 24 24'><path d='M0 0h24v24H0z'/></svg>" />
|
|
41
|
+
</template>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
### Raw SVG (recommended)
|
|
47
|
+
|
|
48
|
+
```vue
|
|
49
|
+
<script lang="ts" setup>
|
|
50
|
+
import { MazStar } from '@maz-ui/icons/raw/MazStar'
|
|
51
|
+
</script>
|
|
52
|
+
|
|
53
|
+
<template>
|
|
54
|
+
<MazIcon :icon="MazStar" />
|
|
55
|
+
</template>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### URL (fetched at runtime)
|
|
59
|
+
|
|
60
|
+
Place your SVG file in your `public/` folder, then point `icon` to its path. The component caches the fetched payload and shares it across instances.
|
|
61
|
+
|
|
62
|
+
```vue
|
|
63
|
+
<MazIcon icon="/academic-cap.svg" />
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Vue component
|
|
67
|
+
|
|
68
|
+
```vue
|
|
69
|
+
<script lang="ts" setup>
|
|
70
|
+
import { MazStar } from '@maz-ui/icons/static/MazStar'
|
|
71
|
+
</script>
|
|
72
|
+
|
|
73
|
+
<template>
|
|
74
|
+
<MazIcon :icon="MazStar" />
|
|
75
|
+
</template>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Fallback
|
|
79
|
+
|
|
80
|
+
When the URL fetch fails, an `error` event is emitted and `MazIcon` switches to the `fallback` prop (same shape as `icon`). If neither resolves, the bundled `MazQuestionMarkCircle` is rendered.
|
|
81
|
+
|
|
82
|
+
```vue
|
|
83
|
+
<MazIcon icon="/missing.svg" :fallback="MazStar" @error="onIconError" />
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Sizing
|
|
87
|
+
|
|
88
|
+
### Predefined sizes (`'xs' | 'sm' | 'md' | 'lg' | 'xl'`)
|
|
89
|
+
|
|
90
|
+
```vue
|
|
91
|
+
<script lang="ts" setup>
|
|
92
|
+
import { MazStar } from '@maz-ui/icons/raw/MazStar'
|
|
93
|
+
</script>
|
|
94
|
+
|
|
95
|
+
<template>
|
|
96
|
+
<MazIcon v-for="size in ['xs', 'sm', 'md', 'lg', 'xl']" :key="size" :size="size" :icon="MazStar" />
|
|
97
|
+
</template>
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Custom size (any CSS length)
|
|
101
|
+
|
|
102
|
+
Allowed units: `px`, `em`, `rem`, `%`, `vw`, `vh`, `cm`, `mm`, `in`, `pt`, `pc`, `ex`.
|
|
103
|
+
|
|
104
|
+
```vue
|
|
105
|
+
<MazIcon size="0.5em" :icon="MazStar" />
|
|
106
|
+
<MazIcon size="1em" :icon="MazStar" />
|
|
107
|
+
<MazIcon size="24px" :icon="MazStar" />
|
|
108
|
+
<MazIcon size="4rem" :icon="MazStar" />
|
|
109
|
+
<MazIcon size="8rem" :icon="MazStar" />
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Accessibility
|
|
113
|
+
|
|
114
|
+
By default `MazIcon` is rendered as decorative (`aria-hidden="true"`, no `role`). Provide an `aria-label` (either on `<MazIcon>` or in `svgAttributes`) to expose it to assistive tech - `role="img"` is set automatically and `aria-hidden` is dropped.
|
|
115
|
+
|
|
116
|
+
```vue
|
|
117
|
+
<MazIcon :icon="MazStar" aria-label="Favorite" />
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## RTL flipping
|
|
121
|
+
|
|
122
|
+
Set `flip-icon-for-rtl` on directional icons (chevrons, arrows). The icon is mirrored horizontally when the document direction is `rtl` and rendered unchanged otherwise.
|
|
123
|
+
|
|
124
|
+
```vue
|
|
125
|
+
<MazIcon :icon="MazChevronRight" flip-icon-for-rtl />
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Custom SVG attributes
|
|
129
|
+
|
|
130
|
+
Inject extra attributes onto the rendered `<svg>` (or onto the inlined raw SVG) via `svg-attributes`:
|
|
131
|
+
|
|
132
|
+
```vue
|
|
133
|
+
<MazIcon :icon="MazStar" :svg-attributes="{ 'data-testid': 'star', fill: 'currentColor' }" />
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## SSR
|
|
137
|
+
|
|
138
|
+
Components, raw SVG strings and SVG `data:` URIs (e.g. a small `?url` import inlined by Vite) are always part of the server HTML, without any request.
|
|
139
|
+
|
|
140
|
+
The server never waits for the network to render a URL icon:
|
|
141
|
+
|
|
142
|
+
- once the server has the SVG in its cache, it inlines it;
|
|
143
|
+
- otherwise, it renders an empty placeholder reserving the icon box and fetches the SVG in the background for the next renders. The client loads the icon in the placeholder.
|
|
144
|
+
|
|
145
|
+
A relative URL (`/icons/star.svg`, from your `public/` directory) can only be fetched by the server with an absolute base URL, see below.
|
|
146
|
+
|
|
147
|
+
## Base URL for relative URLs
|
|
148
|
+
|
|
149
|
+
Prefix every relative URL icon by providing a base URL via Vue's `provide`. An absolute base also lets the server fetch them:
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
import { createApp } from 'vue'
|
|
153
|
+
|
|
154
|
+
const app = createApp(App)
|
|
155
|
+
app.provide('mazIconPath', 'https://cdn.your-app.com')
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
In Nuxt, set `mazUi.general.defaultMazIconPath` in `nuxt.config` and `@maz-ui/nuxt` wires the provide for you.
|
|
159
|
+
|
|
160
|
+
## Forwarding `MazIconProps` from a consumer
|
|
161
|
+
|
|
162
|
+
Most icon-aware components in maz-ui (`MazBtn`, `MazInput`, `MazLink`, `MazContainer`, `MazDropdown`) accept a flexible icon prop on their `startIcon`, `endIcon`, `icon` or `dropdownIcon` slots. You can pass either a bare value (the same shape as `MazIcon`'s `icon` prop) or a full `MazIconProps` object when you need fine-grained control:
|
|
163
|
+
|
|
164
|
+
```html
|
|
165
|
+
<!-- bare value - common case -->
|
|
166
|
+
<MazBtn :start-icon="MazStar" />
|
|
167
|
+
<MazBtn start-icon="/icons/star.svg" />
|
|
168
|
+
|
|
169
|
+
<!-- full props object - override size, set a title, flip for RTL, etc. -->
|
|
170
|
+
<MazBtn
|
|
171
|
+
:start-icon="{
|
|
172
|
+
icon: MazStar,
|
|
173
|
+
size: 'xl',
|
|
174
|
+
title: 'Favorite',
|
|
175
|
+
flipIconForRtl: true,
|
|
176
|
+
}"
|
|
177
|
+
/>
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
The consuming component still derives sensible defaults (e.g. icon size from the button's `size` prop), and the values you set in the props object override those defaults.
|
|
181
|
+
|
|
182
|
+
## All bundled icons
|
|
183
|
+
|
|
184
|
+
This pack is the Heroicons set plus a few additions specific to maz-ui.
|
|
185
|
+
|
|
186
|
+
Source: [Heroicons](https://heroicons.com/) - see also the [icon set page](../ecosystem/icons/icon-set.md).
|
|
187
|
+
|
|
188
|
+
## MazIcon API
|
|
189
|
+
|
|
190
|
+
`import MazIcon from 'maz-ui/components/MazIcon'`
|
|
191
|
+
|
|
192
|
+
### Props
|
|
193
|
+
|
|
194
|
+
- `icon` (`MazIconValue`): The icon to render. Accepts: - A Vue component (e.g. `import { MazStar } from '@maz-ui/icons/static/MazStar'`) - A URL or `data:` URI to a `.svg` file (`'/icons/star.svg'`, `'data:image/svg+xml,…'`) - A raw SVG string (`'<svg viewBox="0 0 24 24">…</svg>'`) The component detects the format and renders accordingly.
|
|
195
|
+
- `fallback` (`MazIconValue`, default: `MazQuestionMarkCircle`): Fallback icon used when: - `icon` is not provided - `icon` is a URL that fails to load or returns invalid SVG Same shape as `icon`. Defaults to the imported `MazQuestionMarkCircle` if neither `icon` nor `fallback` resolves to anything renderable.
|
|
196
|
+
- `size` (`MazIconSize`): Predefined keyword (`'xs' | 'sm' | 'md' | 'lg' | 'xl'`) or any CSS length.
|
|
197
|
+
- `title` (`string`): Sets a `<title>` element inside the SVG for screen-reader accessibility.
|
|
198
|
+
- `svg-attributes` (`Record<string, string | number>`): Extra attributes to merge onto the rendered `<svg>` root.
|
|
199
|
+
- `flip-icon-for-rtl` (`boolean`, default: `false`): Mirror the icon horizontally when the document direction is RTL. Useful for directional icons (chevrons, arrows). Renders unchanged in LTR.
|
|
200
|
+
|
|
201
|
+
### Events
|
|
202
|
+
|
|
203
|
+
- `@error` (payload: `error: Error`): Emitted when an SVG fails to fetch or parse - useful for telemetry / fallback UI.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazInputCode"
|
|
3
|
+
description: "This component creates a customizable input code field with features like dynamic code length, alpha character support, and styling based on states (error, success, warning). The code handles input events, keydown actions, and pasting. Overall, it offers a responsive and visually appealing solution for entering verification codes."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-input-code"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazInputCode
|
|
9
|
+
|
|
10
|
+
> This component creates a customizable input code field with features like dynamic code length, alpha character support, and styling based on states (error, success, warning). The code handles input events, keydown actions, and pasting. Overall, it offers a responsive and visually appealing solution for entering verification codes.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazInputCode from 'maz-ui/components/MazInputCode'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-input-code
|
|
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
|
+
`v-model=""`
|
|
22
|
+
|
|
23
|
+
```vue
|
|
24
|
+
<script lang="ts" setup>
|
|
25
|
+
import MazInputCode from 'maz-ui/components/MazInputCode'
|
|
26
|
+
|
|
27
|
+
const code = ref()
|
|
28
|
+
</script>
|
|
29
|
+
|
|
30
|
+
<template>
|
|
31
|
+
<MazInputCode v-model="code" />
|
|
32
|
+
</template>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Size
|
|
36
|
+
|
|
37
|
+
```html
|
|
38
|
+
<MazInputCode v-model="code" size="mini" />
|
|
39
|
+
<MazInputCode v-model="code" size="xs" />
|
|
40
|
+
<MazInputCode v-model="code" size="sm" />
|
|
41
|
+
<MazInputCode v-model="code" size="lg" />
|
|
42
|
+
<MazInputCode v-model="code" size="xl" />
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Disabled
|
|
46
|
+
|
|
47
|
+
```html
|
|
48
|
+
<MazInputCode v-model="code" disabled />
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## MazInputCode API
|
|
52
|
+
|
|
53
|
+
`import MazInputCode from 'maz-ui/components/MazInputCode'`
|
|
54
|
+
|
|
55
|
+
### Props
|
|
56
|
+
|
|
57
|
+
- `model-value` (`T`, `v-model`): The value of the component (v-model).
|
|
58
|
+
- `code-length` (`number`, default: `4`): The length of the code.
|
|
59
|
+
- `type` (`"number" | "text"`, default: `"text"`): The type of the input field.
|
|
60
|
+
- `accept-alpha` (`boolean`, default: `false`): Whether to accept alpha characters.
|
|
61
|
+
- `required` (`boolean`, default: `false`): Whether the input is required.
|
|
62
|
+
- `disabled` (`boolean`, default: `false`): Whether the input is disabled.
|
|
63
|
+
- `error` (`boolean`, default: `false`): Whether there is an error with the input.
|
|
64
|
+
- `success` (`boolean`, default: `false`): Whether the input is successful.
|
|
65
|
+
- `warning` (`boolean`, default: `false`): Whether there is a warning with the input.
|
|
66
|
+
- `size` (`MazInputCodeSize`, default: `"md"`): The size of the component.
|
|
67
|
+
- `color` (`"primary" | "secondary" | "accent" | "info" | "success" | "warning" | "destructive" | "contrast" | "transparent"`, default: `"primary"`): The color of the component.
|
|
68
|
+
- `hint` (`string`): The hint text to display below the input.
|
|
69
|
+
|
|
70
|
+
### Events
|
|
71
|
+
|
|
72
|
+
- `@update:model-value` (payload: `value?: T | undefined`): Update the model value.
|
|
73
|
+
- `@completed` (payload: `value: void`): Emitted when all inputs are set.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "MazInputNumber"
|
|
3
|
+
description: "MazInputNumber is a number input component with increment and decrement buttons for user-friendly input. Customizable size, disabled state, and limit values."
|
|
4
|
+
package: "maz-ui"
|
|
5
|
+
url: "https://maz-ui.com/components/maz-input-number"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# MazInputNumber
|
|
9
|
+
|
|
10
|
+
> MazInputNumber is a number input component with increment and decrement buttons for user-friendly input. Customizable size, disabled state, and limit values.
|
|
11
|
+
|
|
12
|
+
- Package: `maz-ui`
|
|
13
|
+
- Import: `import MazInputNumber from 'maz-ui/components/MazInputNumber'`
|
|
14
|
+
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
|
|
15
|
+
- Web: https://maz-ui.com/components/maz-input-number
|
|
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 MazInputNumber from 'maz-ui/components/MazInputNumber'
|
|
24
|
+
import { ref } from 'vue'
|
|
25
|
+
const numberValue = ref(2)
|
|
26
|
+
</script>
|
|
27
|
+
|
|
28
|
+
<template>
|
|
29
|
+
<MazInputNumber
|
|
30
|
+
v-model="numberValue"
|
|
31
|
+
placeholder="Enter number"
|
|
32
|
+
:min="5"
|
|
33
|
+
:step="5"
|
|
34
|
+
:max="10000"
|
|
35
|
+
color="secondary"
|
|
36
|
+
style="min-width: 200px"
|
|
37
|
+
/>
|
|
38
|
+
</template>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## No buttons
|
|
42
|
+
|
|
43
|
+
You can remove the buttons with the props `hide-buttons`
|
|
44
|
+
|
|
45
|
+
```html
|
|
46
|
+
<MazInputNumber v-model="numberValue" placeholder="Enter number" hide-buttons />
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## MazInputNumber API
|
|
50
|
+
|
|
51
|
+
`import MazInputNumber from 'maz-ui/components/MazInputNumber'`
|
|
52
|
+
|
|
53
|
+
### Props
|
|
54
|
+
|
|
55
|
+
- `id` (`string`): The id of the input.
|
|
56
|
+
- `model-value` (`number`, `v-model`): The value of the component (v-model).
|
|
57
|
+
- `disabled` (`boolean`, default: `false`): Whether the input number is disabled or not.
|
|
58
|
+
- `max` (`number`, default: `Number.POSITIVE_INFINITY`): The maximum value allowed for the input number.
|
|
59
|
+
- `min` (`number`, default: `Number.NEGATIVE_INFINITY`): The minimum value allowed for the input number.
|
|
60
|
+
- `step` (`number`, default: `1`): The step value for incrementing or decrementing the input number.
|
|
61
|
+
- `size` (`"xs" | "sm" | "md" | "lg" | "xl" | "mini"`, default: `'md'`): The size of the input number component.
|
|
62
|
+
- `hide-buttons` (`boolean`, default: `false`): Whether to hide the increment and decrement buttons or not.
|
|
63
|
+
- `text-center` (`boolean`, default: `true`): Whether to center the text inside the input or not.
|
|
64
|
+
- `inputmode` (`"none" | "text" | "search" | "url" | "email" | "tel" | "numeric" | "decimal"`, default: `"numeric"`): The inputmode attribute for the input.
|
|
65
|
+
- `block` (`boolean`): The input will be displayed in full width.
|
|
66
|
+
- `error` (`boolean`, default: `false`): Will display the input in error state.
|
|
67
|
+
- `hint` (`string`): The hint text to display below the input.
|
|
68
|
+
- `success` (`boolean`, default: `false`): Will display the input in success state.
|
|
69
|
+
- `warning` (`boolean`, default: `false`): Will display the input in warning state.
|
|
70
|
+
- `input-props` (`MazInputProps<MazInputValue>`): The props for the input component.
|
|
71
|
+
- `top-label` (`string`): Static label displayed above the input field. Unlike the floating label, this remains fixed.
|
|
72
|
+
|
|
73
|
+
### Events
|
|
74
|
+
|
|
75
|
+
- `@update:model-value` (payload: `value?: number | undefined`): Emitted when the input value change
|
|
76
|
+
- `@click` (payload: `value: Event`): Emitted input is clicked
|
|
77
|
+
- `@blur` (payload: `value: Event`): Emitted when the input is blurred
|
|
78
|
+
- `@change` (payload: `value: Event`): Emitted when the value change
|
|
79
|
+
- `@focus` (payload: `value: Event`): Emitted when the input is focused
|