@maz-ui/mcp 5.2.0-beta.0 → 5.2.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/docs/components/maz-alert.md +1 -1
- package/docs/components/maz-bottom-sheet.md +1 -1
- package/docs/components/maz-btn.md +3 -3
- package/docs/components/maz-container.md +2 -2
- package/docs/components/maz-dropdown.md +1 -1
- package/docs/components/maz-dropzone.md +1 -1
- package/docs/components/maz-icon.md +2 -2
- package/docs/components/maz-input.md +2 -2
- package/docs/components/maz-link.md +2 -2
- package/docs/components/maz-sidebar-menu-button.md +1 -1
- package/docs/components/maz-sidebar-menu-sub.md +1 -1
- package/docs/components/maz-sidebar.md +2 -2
- package/docs/manifest.json +1 -1
- package/package.json +5 -5
|
@@ -227,7 +227,7 @@ You can use either title, content, or both.
|
|
|
227
227
|
|
|
228
228
|
- `title` (`string`): Title of the alert.
|
|
229
229
|
- `content` (`string`): Content of the alert.
|
|
230
|
-
- `icon` (`
|
|
230
|
+
- `icon` (`any`): Icon of the alert - can be a component or icon name string.
|
|
231
231
|
- `hide-icon` (`boolean`, default: `false`): Hide the icon.
|
|
232
232
|
- `color` (`MazAlertColor`, default: `"info"`): Color of the alert. Values: `'success'`, `'warning'`, `'destructive'`, `'info'`, `'primary'`, `'secondary'`, `'accent'`, `'contrast'` (non exhaustive).
|
|
233
233
|
- `icon-size` (`MazIconSize`, default: `"md"`): Size of the icon.
|
|
@@ -217,7 +217,7 @@ The bottom sheet is a modal `dialog` labelled by its `title` and described by it
|
|
|
217
217
|
|
|
218
218
|
- `model-value` (`boolean`, `v-model`): Modal's model value.
|
|
219
219
|
- `title` (`string`): Title of the bottom sheet in the header.
|
|
220
|
-
- `icon` (`
|
|
220
|
+
- `icon` (`any`): Icon displayed on the left of the header. Accepts an icon value or a full `MazIconProps` object.
|
|
221
221
|
- `max-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... ``, default: `"40rem"`): Bottom sheet's max-width, applied from the tablet breakpoint and up (full-width below).
|
|
222
222
|
- `hide-close-button` (`boolean`, default: `false`): Remove the close button in the header.
|
|
223
223
|
- `hide-header` (`boolean`, default: `false`): Remove the whole header.
|
|
@@ -406,9 +406,9 @@ When `to` attribute is provided, the component automatically becomes a `<RouterL
|
|
|
406
406
|
- `loading` (`boolean`, default: `false`): Enable the button loader.
|
|
407
407
|
- `disabled` (`boolean`, default: `false`): Disable the button.
|
|
408
408
|
- `fab` (`boolean`, default: `false`): If true, the button will have a fab style.
|
|
409
|
-
- `icon` (`
|
|
410
|
-
- `start-icon` (`
|
|
411
|
-
- `end-icon` (`
|
|
409
|
+
- `icon` (`any`): The icon to display in the fab variant. Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) for the common case, or a full `MazIconProps` object for fine-grained control (size, title, svgAttributes, fallback, flipIconForRtl, …).
|
|
410
|
+
- `start-icon` (`any`): The icon to display on the inline-start edge (left in LTR, right in RTL). Accepts a bare value or a full `MazIconProps` object.
|
|
411
|
+
- `end-icon` (`any`): The icon to display on the inline-end edge (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object.
|
|
412
412
|
- `padding` (`boolean`, default: `true`): Apply the padding of the button, set it to `false` to remove it.
|
|
413
413
|
- `justify` (`"center" | "end" | "start" | "space-between" | "space-around" | "space-evenly"`, default: `"center"`): Choose how the elements are aligned in the button.
|
|
414
414
|
- `active` (`boolean`, default: `false`): If true, the button will have an active state.
|
|
@@ -226,8 +226,8 @@ Use the `header` slot to fully customize the header, or use `title`, `icon-start
|
|
|
226
226
|
- `rounded-size` (`MazRoundedSize`, default: `'md'`): Size of the rounded. Values: `'none'`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'full'` (non exhaustive).
|
|
227
227
|
- `transparent` (`boolean`, default: `false`): Remove background color.
|
|
228
228
|
- `overflow-hidden` (`boolean`, default: `true`): Hide overflow.
|
|
229
|
-
- `start-icon` (`
|
|
230
|
-
- `end-icon` (`
|
|
229
|
+
- `start-icon` (`any`): Icon displayed on the inline-start edge of the header (left in LTR, right in RTL). Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object.
|
|
230
|
+
- `end-icon` (`any`): Icon displayed on the inline-end edge of the header (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object.
|
|
231
231
|
- `icon-size` (`MazIconSize`, default: `"md"`): Size of the icon.
|
|
232
232
|
- `block` (`boolean`, default: `false`): Display the container in full width.
|
|
233
233
|
- `content-class` (`string`): Additional class to add to the content wrapper.
|
|
@@ -376,7 +376,7 @@ The trigger button exposes the menu state (`aria-haspopup="menu"`, `aria-expande
|
|
|
376
376
|
- `menu-panel-class` (`ClassValue`): Additional CSS classes to apply to the dropdown menu panel Useful for customizing the dropdown appearance (background, border, etc.).
|
|
377
377
|
- `menu-panel-style` (`StyleValue`): Inline styles to apply to the dropdown menu panel Useful for custom styling. You may use `!important` to override default styles.
|
|
378
378
|
- `block` (`boolean`, default: `false`): Makes the dropdown button expand to full width of its container.
|
|
379
|
-
- `dropdown-icon` (`
|
|
379
|
+
- `dropdown-icon` (`any`): Icon to use instead of the default chevron for the dropdown indicator Custom icon to display in place of the default chevron. Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object.
|
|
380
380
|
- `dropdown-icon-animation` (`boolean`, default: `true`): Controls whether the dropdown icon rotates when the dropdown is opened.
|
|
381
381
|
- `size` (`"xs" | "sm" | "md" | "lg" | "xl" | "mini"`, default: `'md'`): Size of the dropdown button.
|
|
382
382
|
- `transition` (`string`, default: `"scale-pop"`): Transition to use when the dropdown is opened or closed. Values: `'scale-pop'`, `'scale-fade'`, `'string'` (non exhaustive).
|
|
@@ -355,8 +355,8 @@ Customize the upload request using `uploadUrl`, `requestOptions` and `transformB
|
|
|
355
355
|
|
|
356
356
|
### Events
|
|
357
357
|
|
|
358
|
-
- `@add` (payload: `value: File`): Event emitted when a file is added to the dropzone
|
|
359
358
|
- `@error` (payload: `values: { files: File[] | null; event: DragEvent | null; code: MazDropzoneErrorCode; }`): Event emitted when an error occurs
|
|
359
|
+
- `@add` (payload: `value: File`): Event emitted when a file is added to the dropzone
|
|
360
360
|
- `@drop` (payload: `values: { files: File[] | null; event: DragEvent; }`): Event emitted when files are dropped in the dropzone
|
|
361
361
|
- `@update:modelValue` (payload: `value: MazDropzoneFileData[]`)
|
|
362
362
|
- `@enter` (payload: `values: { files: File[] | null; event: DragEvent; }`): Event emitted when dragged files enter the dropzone
|
|
@@ -191,8 +191,8 @@ Source: [Heroicons](https://heroicons.com/) - see also the [icon set page](../ec
|
|
|
191
191
|
|
|
192
192
|
### Props
|
|
193
193
|
|
|
194
|
-
- `icon` (`
|
|
195
|
-
- `fallback` (`
|
|
194
|
+
- `icon` (`any`): 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` (`any`, 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
196
|
- `size` (`MazIconSize`): Predefined keyword (`'xs' | 'sm' | 'md' | 'lg' | 'xl'`) or any CSS length.
|
|
197
197
|
- `title` (`string`): Sets a `<title>` element inside the SVG for screen-reader accessibility.
|
|
198
198
|
- `svg-attributes` (`Record<string, string | number>`): Extra attributes to merge onto the rendered `<svg>` root.
|
|
@@ -310,8 +310,8 @@ Use the attribute `rounded-size` with a value in `'none' | 'sm' | 'md' | 'lg' |
|
|
|
310
310
|
- `debounce` (`number | boolean`, default: `false`): Enables input debouncing to limit the frequency of value updates. When true, uses 500ms delay. When a number, uses that value as delay in milliseconds.
|
|
311
311
|
- `auto-focus` (`boolean`, default: `false`): Automatically focuses the input when the component mounts.
|
|
312
312
|
- `border-active` (`boolean`, default: `false`): When true, shows the colored border immediately instead of only on focus.
|
|
313
|
-
- `start-icon` (`
|
|
314
|
-
- `end-icon` (`
|
|
313
|
+
- `start-icon` (`any`): Icon displayed on the inline-start edge of the input (left in LTR, right in RTL). Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object for fine-grained control (size, title, svgAttributes, fallback, …).
|
|
314
|
+
- `end-icon` (`any`): Icon displayed on the inline-end edge of the input (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object.
|
|
315
315
|
- `rounded-size` (`MazRoundedSize`, default: `'md'`): Controls the border radius of the input component. Values: `'none'`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'full'` (non exhaustive).
|
|
316
316
|
- `block` (`boolean`): Makes the input expand to the full width of its container.
|
|
317
317
|
- `name` (`string`): The name of the input field. Used for form submission and validation.
|
|
@@ -134,8 +134,8 @@ If no `to` or `href` is provided, the component will be a `button` by default. Y
|
|
|
134
134
|
- `underline` (`boolean`, default: `false`): Add an underline to the link.
|
|
135
135
|
- `underline-hover` (`boolean`, default: `true`): Add an underline only on hover.
|
|
136
136
|
- `auto-external` (`boolean`, default: `true`): Add an external icon to the link if target is '_blank'.
|
|
137
|
-
- `start-icon` (`
|
|
138
|
-
- `end-icon` (`
|
|
137
|
+
- `start-icon` (`any`): Icon displayed on the inline-start edge (left in LTR, right in RTL). Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object for fine-grained control.
|
|
138
|
+
- `end-icon` (`any`): Icon displayed on the inline-end edge (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object.
|
|
139
139
|
- `disabled` (`boolean`, default: `false`): The disabled state of the link if the component is a button.
|
|
140
140
|
|
|
141
141
|
### Slots
|
|
@@ -22,7 +22,7 @@ Used inside [MazSidebar](./maz-sidebar.md): read its page for complete examples.
|
|
|
22
22
|
|
|
23
23
|
- `to` (`string | Record<string, unknown>`): Route for router-link navigation.
|
|
24
24
|
- `href` (`string`): URL for anchor navigation.
|
|
25
|
-
- `icon` (`
|
|
25
|
+
- `icon` (`any`): Icon to display before the label. Accepts a bare icon value (Vue component, raw SVG string, URL) or a full `MazIconProps` object for fine-grained control (size, title, fallback, …).
|
|
26
26
|
- `label` (`string`): Label text.
|
|
27
27
|
- `badge` (`MazSidebarMenuButtonBadge`): Badge content. Pass a `string`/`number` for a simple primary badge, or a full `MazBadgeProps` object (with optional `text`) to customise color, size, outlined, ….
|
|
28
28
|
- `tooltip` (`string`): Tooltip text. When provided, shows a tooltip on hover via the `v-tooltip` directive.
|
|
@@ -21,7 +21,7 @@ Used inside [MazSidebar](./maz-sidebar.md): read its page for complete examples.
|
|
|
21
21
|
### Props
|
|
22
22
|
|
|
23
23
|
- `label` (`string`): Label for the sub-menu trigger button.
|
|
24
|
-
- `icon` (`
|
|
24
|
+
- `icon` (`any`): Icon to display before the label. Accepts a bare icon value (Vue component, raw SVG string, URL) or a full `MazIconProps` object for fine-grained control.
|
|
25
25
|
- `default-open` (`boolean`, default: `false`): Whether the sub-menu is open by default.
|
|
26
26
|
|
|
27
27
|
### Slots
|
|
@@ -455,7 +455,7 @@ Customize the sidebar width using these CSS custom properties (also settable via
|
|
|
455
455
|
|
|
456
456
|
- `to` (`string | Record<string, unknown>`): Route for router-link navigation.
|
|
457
457
|
- `href` (`string`): URL for anchor navigation.
|
|
458
|
-
- `icon` (`
|
|
458
|
+
- `icon` (`any`): Icon to display before the label. Accepts a bare icon value (Vue component, raw SVG string, URL) or a full `MazIconProps` object for fine-grained control (size, title, fallback, …).
|
|
459
459
|
- `label` (`string`): Label text.
|
|
460
460
|
- `badge` (`MazSidebarMenuButtonBadge`): Badge content. Pass a `string`/`number` for a simple primary badge, or a full `MazBadgeProps` object (with optional `text`) to customise color, size, outlined, ….
|
|
461
461
|
- `tooltip` (`string`): Tooltip text. When provided, shows a tooltip on hover via the `v-tooltip` directive.
|
|
@@ -482,7 +482,7 @@ Customize the sidebar width using these CSS custom properties (also settable via
|
|
|
482
482
|
### Props
|
|
483
483
|
|
|
484
484
|
- `label` (`string`): Label for the sub-menu trigger button.
|
|
485
|
-
- `icon` (`
|
|
485
|
+
- `icon` (`any`): Icon to display before the label. Accepts a bare icon value (Vue component, raw SVG string, URL) or a full `MazIconProps` object for fine-grained control.
|
|
486
486
|
- `default-open` (`boolean`, default: `false`): Whether the sub-menu is open by default.
|
|
487
487
|
|
|
488
488
|
### Slots
|