maz-ui 5.1.0-beta.0 → 5.1.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.
Files changed (79) hide show
  1. package/dist/assets/{MazBtn.B1l5ztwQ.css → MazBtn.CQZ0x6EA.css} +1 -1
  2. package/dist/chunks/{MazBtn.DF6uWDj3.js → MazBtn.D-Tj7I_e.js} +2 -2
  3. package/dist/chunks/{MazDropzone.Dez5j0WP.js → MazDropzone.BaPph4gM.js} +1 -1
  4. package/dist/chunks/{MazInputTags.C8VNuiEY.js → MazInputTags.B8Qp88Pt.js} +1 -1
  5. package/dist/chunks/{MazMarkdownEditor.BYpR5wF5.js → MazMarkdownEditor.ENw_RcQf.js} +1 -1
  6. package/dist/chunks/{MazPagination.CO3G0QRM.js → MazPagination.C9xcws2r.js} +1 -1
  7. package/dist/chunks/{MazPickerCalendarGrid.CpcqhEfy.js → MazPickerCalendarGrid.5VBnk7xS.js} +1 -1
  8. package/dist/chunks/{MazTabsBar.Wqbm-4CQ.js → MazTabsBar.B9f5DxPw.js} +1 -1
  9. package/dist/components/MazBtn.js +1 -1
  10. package/dist/components/MazBtn.vue.d.ts +1 -1
  11. package/dist/components/MazDatePicker/MazPickerCalendarMonth/MazPickerCalendarGrid.js +1 -1
  12. package/dist/components/MazDatePicker/MazPickerCalendarMonth/MazPickerCalendarMonth.js +1 -1
  13. package/dist/components/MazDatePicker/MazPickerCalendarSwitcher.js +1 -1
  14. package/dist/components/MazDatePicker/MazPickerMonthSwitcher.js +1 -1
  15. package/dist/components/MazDatePicker/MazPickerShortcuts.js +1 -1
  16. package/dist/components/MazDatePicker/MazPickerTime.js +1 -1
  17. package/dist/components/MazDatePicker/MazPickerYearSwitcher.js +1 -1
  18. package/dist/components/MazDropzone.js +1 -1
  19. package/dist/components/MazInputTags.js +1 -1
  20. package/dist/components/MazMarkdownEditor.js +1 -1
  21. package/dist/components/MazPagination.js +1 -1
  22. package/dist/components/MazTabsBar.js +1 -1
  23. package/dist/components/index.js +6 -6
  24. package/docs/README.md +37 -37
  25. package/docs/agents/agents-md.md +4 -4
  26. package/docs/agents/claude-rule.md +4 -4
  27. package/docs/components/maz-accordion.md +2 -0
  28. package/docs/components/maz-btn-group.md +1 -0
  29. package/docs/components/maz-btn.md +3 -1
  30. package/docs/components/maz-card-spotlight.md +2 -2
  31. package/docs/components/maz-circular-progress-bar.md +2 -2
  32. package/docs/components/maz-drawer.md +3 -2
  33. package/docs/components/maz-fullscreen-loader.md +2 -2
  34. package/docs/components/maz-input-number.md +1 -1
  35. package/docs/components/maz-input-phone-number.md +1 -1
  36. package/docs/components/maz-input.md +1 -1
  37. package/docs/components/maz-loading-bar.md +2 -2
  38. package/docs/components/maz-pagination.md +2 -2
  39. package/docs/components/maz-pull-to-refresh.md +1 -1
  40. package/docs/components/maz-radio.md +2 -2
  41. package/docs/components/maz-select-country.md +2 -2
  42. package/docs/components/maz-sidebar-content.md +2 -2
  43. package/docs/components/maz-sidebar-footer.md +2 -2
  44. package/docs/components/maz-sidebar-group.md +2 -2
  45. package/docs/components/maz-sidebar-header.md +2 -2
  46. package/docs/components/maz-sidebar-menu-button.md +2 -2
  47. package/docs/components/maz-sidebar-menu-item.md +2 -2
  48. package/docs/components/maz-sidebar-menu-sub.md +2 -2
  49. package/docs/components/maz-sidebar-menu.md +2 -2
  50. package/docs/components/maz-sidebar-separator.md +2 -2
  51. package/docs/components/maz-sidebar-trigger.md +2 -2
  52. package/docs/components/maz-spinner.md +2 -2
  53. package/docs/components/maz-stepper.md +5 -0
  54. package/docs/components/maz-table-cell.md +2 -2
  55. package/docs/components/maz-table-row.md +2 -2
  56. package/docs/components/maz-table-title.md +2 -2
  57. package/docs/components/maz-table-virtualizer.md +2 -2
  58. package/docs/components/maz-tabs-bar.md +2 -2
  59. package/docs/components/maz-tabs-content-item.md +2 -2
  60. package/docs/components/maz-tabs-content.md +2 -2
  61. package/docs/components/maz-ui-provider.md +2 -2
  62. package/docs/composables/use-aos.md +2 -2
  63. package/docs/composables/use-breakpoints.md +2 -2
  64. package/docs/composables/use-toast.md +2 -2
  65. package/docs/composables/use-user-visibility.md +4 -4
  66. package/docs/composables/use-wait.md +2 -2
  67. package/docs/directives/fullscreen-img.md +4 -4
  68. package/docs/ecosystem/icons/icon-set.md +4 -4
  69. package/docs/ecosystem/icons/index.md +4 -4
  70. package/docs/ecosystem/mcp.md +1 -1
  71. package/docs/ecosystem/nuxt.md +5 -1
  72. package/docs/ecosystem/translations.md +2 -2
  73. package/docs/ecosystem/utils/country-code-to-unicode-flag.md +2 -2
  74. package/docs/guide/ai-agents.md +26 -5
  75. package/docs/guide/tailwind.md +25 -1
  76. package/docs/manifest.json +1 -1
  77. package/docs/reference/tailwind-tokens.md +1 -1
  78. package/docs/rules.md +5 -3
  79. package/package.json +2 -2
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "MazFullscreenLoader"
3
- description: "MazFullscreenLoader is a standalone component"
3
+ description: "MazFullscreenLoader covers the whole page with a backdrop and a spinner to block the interface during a global loading"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/components/maz-fullscreen-loader"
6
6
  ---
7
7
 
8
8
  # MazFullscreenLoader
9
9
 
10
- > MazFullscreenLoader is a standalone component
10
+ > MazFullscreenLoader covers the whole page with a backdrop and a spinner to block the interface during a global loading
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import MazFullscreenLoader from 'maz-ui/components/MazFullscreenLoader'`
@@ -61,7 +61,7 @@ You can remove the buttons with the props `hide-buttons`
61
61
  - `size` (`"xs" | "sm" | "md" | "lg" | "xl" | "mini"`, default: `'md'`): The size of the input number component.
62
62
  - `hide-buttons` (`boolean`, default: `false`): Whether to hide the increment and decrement buttons or not.
63
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.
64
+ - `inputmode` (`"text" | "none" | "search" | "url" | "email" | "tel" | "numeric" | "decimal"`, default: `"numeric"`): The inputmode attribute for the input.
65
65
  - `block` (`boolean`): The input will be displayed in full width.
66
66
  - `error` (`boolean`, default: `false`): Will display the input in error state.
67
67
  - `hint` (`string`): The hint text to display below the input.
@@ -518,7 +518,7 @@ interface MazInputPhoneNumberData {
518
518
  - `block` (`boolean`, default: `false`): The input will be displayed in full width.
519
519
  - `orientation` (`"row" | "col" | "responsive"`, default: `"responsive"`): Orientation of the inputs in the component.
520
520
  - `country-select-attributes` (`Record<string, unknown>`, default: `{ name: "country", autocomplete: "off", style: { width: "14rem", }, }`): Meta attributes of the country input.
521
- - `phone-input-attributes` (`(Record<string, unknown> & { name: string; inputmode: "none" | "text" | "search" | "url" | "email" | "tel" | "numeric" | "decimal" | undefined; autocomplete: string; })`, default: `{ name: "phone", autocomplete: "tel", inputmode: "tel", }`): Meta attributes of the phone number input.
521
+ - `phone-input-attributes` (`(Record<string, unknown> & { name: string; inputmode: "text" | "none" | "search" | "url" | "email" | "tel" | "numeric" | "decimal" | undefined; autocomplete: string; })`, default: `{ name: "phone", autocomplete: "tel", inputmode: "tel", }`): Meta attributes of the phone number input.
522
522
  - `assistive-text` (`string`): Helper text displayed below the input to provide additional context or validation feedback.
523
523
  - `hint` (`string`): Alternative text that replaces the label when provided. Useful for contextual hints.
524
524
 
@@ -305,7 +305,7 @@ Use the attribute `rounded-size` with a value in `'none' | 'sm' | 'md' | 'lg' |
305
305
  - `hint` (`string`): Alternative text that replaces the label when provided. Useful for contextual hints.
306
306
  - `input-classes` (`string`): Additional CSS classes to apply specifically to the input wrapper element.
307
307
  - `border` (`boolean`, default: `true`): Controls whether the input has a visible border. Set to false for borderless inputs.
308
- - `inputmode` (`"none" | "text" | "search" | "url" | "email" | "tel" | "numeric" | "decimal"`, default: `"text"`): HTML inputmode attribute that provides hints for virtual keyboards on mobile devices.
308
+ - `inputmode` (`"text" | "none" | "search" | "url" | "email" | "tel" | "numeric" | "decimal"`, default: `"text"`): HTML inputmode attribute that provides hints for virtual keyboards on mobile devices.
309
309
  - `size` (`"xs" | "sm" | "md" | "lg" | "xl" | "mini"`): Controls the height and text size of the input component.
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.
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "MazLoadingBar"
3
- description: "MazLoadingBar is a standalone component"
3
+ description: "MazLoadingBar is an indeterminate progress bar to show that something is loading, typically at the top of a page or a container"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/components/maz-loading-bar"
6
6
  ---
7
7
 
8
8
  # MazLoadingBar
9
9
 
10
- > MazLoadingBar is a standalone component
10
+ > MazLoadingBar is an indeterminate progress bar to show that something is loading, typically at the top of a page or a container
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import MazLoadingBar from 'maz-ui/components/MazLoadingBar'`
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "MazPagination"
3
- description: "MazPagination is a standalone component"
3
+ description: "MazPagination lets users navigate between the pages of a list or a table, with first, previous, next and last buttons and the current page in v-model"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/components/maz-pagination"
6
6
  ---
7
7
 
8
8
  # MazPagination
9
9
 
10
- > MazPagination is a standalone component
10
+ > MazPagination lets users navigate between the pages of a list or a table, with first, previous, next and last buttons and the current page in v-model
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import MazPagination from 'maz-ui/components/MazPagination'`
@@ -202,9 +202,9 @@ Need a different indicator, or a gesture on an element without wrapping it? Use
202
202
 
203
203
  ### Events
204
204
 
205
+ - `@start`: Emitted when the refresh starts
205
206
  - `@loaded`: Emitted when `onRefresh` resolved
206
207
  - `@error` (payload: `error: unknown`): Emitted when `onRefresh` threw or rejected
207
- - `@start`: Emitted when the refresh starts
208
208
  - `@response` (payload: `response: unknown`): Emitted with the value resolved by `onRefresh`
209
209
  - `@finish`: Emitted when the refresh ends, after `loaded` or `error`
210
210
 
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "MazRadio"
3
- description: "MazRadio is a standalone component"
3
+ description: "MazRadio is a radio input with a label, colors and sizes to pick one value among several options; see MazRadioButtons for a ready-made group"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/components/maz-radio"
6
6
  ---
7
7
 
8
8
  # MazRadio
9
9
 
10
- > MazRadio is a standalone component
10
+ > MazRadio is a radio input with a label, colors and sizes to pick one value among several options; see MazRadioButtons for a ready-made group
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import MazRadio from 'maz-ui/components/MazRadio'`
@@ -479,10 +479,10 @@ This ensures consistent internationalization across your application while provi
479
479
  - `codes-type` (`CodesType`, default: `defined by displayNamesOptions.type (if 'region', 'country' is used, otherwise 'iso')`): Codes type. Values: `'iso'`, `'bcp'`, `'country'`, `'all'` (non exhaustive).
480
480
  - `open` (`boolean`, default: `false`): Open the select.
481
481
  - `model-value` (`Option["code"]`, `v-model`): The value of the select.
482
- - `disabled` (`boolean`): Disable the component.
483
482
  - `block` (`boolean`): The input will be displayed in full width.
484
- - `placeholder` (`string`): The placeholder of the select.
483
+ - `disabled` (`boolean`): Disable the component.
485
484
  - `required` (`boolean`): Make the input required in the form.
485
+ - `placeholder` (`string`): The placeholder of the select.
486
486
  - `label` (`string`): The label of the select.
487
487
  - `search-function` (`((query: string, options: Option[]) => Option[] | undefined)`): Replace the default search function to provide a custom search function.
488
488
  - `transition` (`string`, default: `'scale-fade'`): The transition name of the panel list options.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarContent"
3
- description: "MazSidebarContent component."
3
+ description: "Scrollable main area of MazSidebar that holds the groups and the menus."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarContent
8
8
 
9
- > MazSidebarContent component.
9
+ > Scrollable main area of MazSidebar that holds the groups and the menus.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarContent from 'maz-ui/components/MazSidebarContent'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarFooter"
3
- description: "MazSidebarFooter component."
3
+ description: "Bottom area of MazSidebar, for the user menu or secondary actions."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarFooter
8
8
 
9
- > MazSidebarFooter component.
9
+ > Bottom area of MazSidebar, for the user menu or secondary actions.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarFooter from 'maz-ui/components/MazSidebarFooter'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarGroup"
3
- description: "MazSidebarGroup is a building block of MazSidebar."
3
+ description: "Titled and optionally collapsible section of MazSidebar that groups menus."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarGroup
8
8
 
9
- > MazSidebarGroup is a building block of MazSidebar.
9
+ > Titled and optionally collapsible section of MazSidebar that groups menus.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarGroup from 'maz-ui/components/MazSidebarGroup'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarHeader"
3
- description: "MazSidebarHeader component."
3
+ description: "Top area of MazSidebar, for the logo, the name of the app or a workspace switcher."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarHeader
8
8
 
9
- > MazSidebarHeader component.
9
+ > Top area of MazSidebar, for the logo, the name of the app or a workspace switcher.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarHeader from 'maz-ui/components/MazSidebarHeader'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarMenuButton"
3
- description: "MazSidebarMenuButton is a building block of MazSidebar."
3
+ description: "Navigation button or link of a MazSidebar menu item, with icon, label, badge, and a tooltip when the sidebar is collapsed."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarMenuButton
8
8
 
9
- > MazSidebarMenuButton is a building block of MazSidebar.
9
+ > Navigation button or link of a MazSidebar menu item, with icon, label, badge, and a tooltip when the sidebar is collapsed.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarMenuButton from 'maz-ui/components/MazSidebarMenuButton'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarMenuItem"
3
- description: "MazSidebarMenuItem component."
3
+ description: "Item of a MazSidebarMenu: wraps a MazSidebarMenuButton and its optional MazSidebarMenuSub."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarMenuItem
8
8
 
9
- > MazSidebarMenuItem component.
9
+ > Item of a MazSidebarMenu: wraps a MazSidebarMenuButton and its optional MazSidebarMenuSub.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarMenuItem from 'maz-ui/components/MazSidebarMenuItem'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarMenuSub"
3
- description: "MazSidebarMenuSub is a building block of MazSidebar."
3
+ description: "Nested submenu of a MazSidebar menu item."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarMenuSub
8
8
 
9
- > MazSidebarMenuSub is a building block of MazSidebar.
9
+ > Nested submenu of a MazSidebar menu item.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarMenuSub from 'maz-ui/components/MazSidebarMenuSub'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarMenu"
3
- description: "MazSidebarMenu component."
3
+ description: "List of navigation items of MazSidebar."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarMenu
8
8
 
9
- > MazSidebarMenu component.
9
+ > List of navigation items of MazSidebar.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarMenu from 'maz-ui/components/MazSidebarMenu'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarSeparator"
3
- description: "MazSidebarSeparator component."
3
+ description: "Divider between the sections of MazSidebar."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarSeparator
8
8
 
9
- > MazSidebarSeparator component.
9
+ > Divider between the sections of MazSidebar.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarSeparator from 'maz-ui/components/MazSidebarSeparator'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazSidebarTrigger"
3
- description: "MazSidebarTrigger component."
3
+ description: "Button that opens, closes or collapses MazSidebar."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazSidebarTrigger
8
8
 
9
- > MazSidebarTrigger component.
9
+ > Button that opens, closes or collapses MazSidebar.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazSidebarTrigger from 'maz-ui/components/MazSidebarTrigger'`
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "MazSpinner"
3
- description: "MazSpinner is a standalone component that replaces the standard html input checkbox. Color options are available."
3
+ description: "MazSpinner is an animated loading indicator with the colors and sizes of the theme, to show that a content or an action is loading"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/components/maz-spinner"
6
6
  ---
7
7
 
8
8
  # MazSpinner
9
9
 
10
- > MazSpinner is a standalone component that replaces the standard html input checkbox. Color options are available.
10
+ > MazSpinner is an animated loading indicator with the colors and sizes of the theme, to show that a content or an action is loading
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import MazSpinner from 'maz-ui/components/MazSpinner'`
@@ -299,3 +299,8 @@ Each step header is a button exposing the current step (`aria-current="step"`) a
299
299
  ### Slots
300
300
 
301
301
  - `#point` Bindings: `step: number`.
302
+ - `#icon-{step}`: One slot per `step`: `#icon-<step>`.
303
+ - `#title-{step}`: One slot per `step`: `#title-<step>`.
304
+ - `#subtitle-{step}`: One slot per `step`: `#subtitle-<step>`.
305
+ - `#title-info-{step}`: One slot per `step`: `#title-info-<step>`.
306
+ - `#content-{step}`: One slot per `step`: `#content-<step>`.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTableCell"
3
- description: "MazTableCell is a building block of MazTable."
3
+ description: "Cell of a MazTableRow, with the size and padding of MazTable."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTableCell
8
8
 
9
- > MazTableCell is a building block of MazTable.
9
+ > Cell of a MazTableRow, with the size and padding of MazTable.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTableCell from 'maz-ui/components/MazTableCell'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTableRow"
3
- description: "MazTableRow is a building block of MazTable."
3
+ description: "Row of MazTable, when you write the rows by hand in its default slot."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTableRow
8
8
 
9
- > MazTableRow is a building block of MazTable.
9
+ > Row of MazTable, when you write the rows by hand in its default slot.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTableRow from 'maz-ui/components/MazTableRow'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTableTitle"
3
- description: "MazTableTitle is a building block of MazTable."
3
+ description: "Header cell of MazTable, when you write the header by hand."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTableTitle
8
8
 
9
- > MazTableTitle is a building block of MazTable.
9
+ > Header cell of MazTable, when you write the header by hand.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTableTitle from 'maz-ui/components/MazTableTitle'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTableVirtualizer"
3
- description: "MazTableVirtualizer component."
3
+ description: "Renderless provider loaded on demand by MazTable to virtualize long lists of rows."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTableVirtualizer
8
8
 
9
- > MazTableVirtualizer component.
9
+ > Renderless provider loaded on demand by MazTable to virtualize long lists of rows.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTableVirtualizer from 'maz-ui/components/MazTableVirtualizer'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTabsBar"
3
- description: "MazTabsBar is a building block of MazTabs."
3
+ description: "Bar of tab buttons of MazTabs."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTabsBar
8
8
 
9
- > MazTabsBar is a building block of MazTabs.
9
+ > Bar of tab buttons of MazTabs.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTabsBar from 'maz-ui/components/MazTabsBar'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTabsContentItem"
3
- description: "MazTabsContentItem is a building block of MazTabs."
3
+ description: "Panel of MazTabs displayed when its tab is active."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTabsContentItem
8
8
 
9
- > MazTabsContentItem is a building block of MazTabs.
9
+ > Panel of MazTabs displayed when its tab is active.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTabsContentItem from 'maz-ui/components/MazTabsContentItem'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazTabsContent"
3
- description: "MazTabsContent is a building block of MazTabs."
3
+ description: "Container of the tab panels of MazTabs."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazTabsContent
8
8
 
9
- > MazTabsContent is a building block of MazTabs.
9
+ > Container of the tab panels of MazTabs.
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazTabsContent from 'maz-ui/components/MazTabsContent'`
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: "MazUiProvider"
3
- description: "MazUiProvider component."
3
+ description: "Component alternative to the MazUi plugin: provides the theme, the translations and the default props of maz-ui to its subtree (lazy loaded pages, scoped themes)."
4
4
  package: "maz-ui"
5
5
  ---
6
6
 
7
7
  # MazUiProvider
8
8
 
9
- > MazUiProvider component.
9
+ > Component alternative to the MazUi plugin: provides the theme, the translations and the default props of maz-ui to its subtree (lazy loaded pages, scoped themes).
10
10
 
11
11
  - Package: `maz-ui`
12
12
  - Import: `import MazUiProvider from 'maz-ui/components/MazUiProvider'`
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "useAos"
3
- description: "Vue composable for handling aos plugin in your components"
3
+ description: "Vue composable to access the AOS plugin instance (animations on scroll) in your components, to refresh or trigger the animations"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/composables/use-aos"
6
6
  ---
7
7
 
8
8
  # useAos
9
9
 
10
- > Vue composable for handling aos plugin in your components
10
+ > Vue composable to access the AOS plugin instance (animations on scroll) in your components, to refresh or trigger the animations
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import { useAos } from 'maz-ui/composables/useAos'`
@@ -1,11 +1,11 @@
1
1
  ---
2
- title: "useWindowSize"
2
+ title: "useBreakpoints"
3
3
  description: "This composable extends the functionality of the useWindowSize composable to manage responsive breakpoints"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/composables/use-breakpoints"
6
6
  ---
7
7
 
8
- # useWindowSize
8
+ # useBreakpoints
9
9
 
10
10
  > This composable extends the functionality of the useWindowSize composable to manage responsive breakpoints
11
11
 
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "useToast"
3
- description: "Vue composable for handling toast plugin in your components"
3
+ description: "Vue composable to display toast notifications (info, success, warning, error, with actions and buttons) from your components, through the toast plugin"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/composables/use-toast"
6
6
  ---
7
7
 
8
8
  # useToast
9
9
 
10
- > Vue composable for handling toast plugin in your components
10
+ > Vue composable to display toast notifications (info, success, warning, error, with actions and buttons) from your components, through the toast plugin
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import { useToast } from 'maz-ui/composables/useToast'`
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "user-visibility"
3
- description: "Plugin to see and manage the user page visibility"
2
+ title: "useUserVisibility"
3
+ description: "Vue composable to know whether the user is looking at the page (Page Visibility API), with an optional delay before considering them away"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/composables/use-user-visibility"
6
6
  ---
7
7
 
8
- # user-visibility
8
+ # useUserVisibility
9
9
 
10
- > Plugin to see and manage the user page visibility
10
+ > Vue composable to know whether the user is looking at the page (Page Visibility API), with an optional delay before considering them away
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import { useUserVisibility } from 'maz-ui/composables/useUserVisibility'`
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: "useWait"
3
- description: "Vue composable for handling wait plugins"
3
+ description: "Vue composable to manage loading states (start, stop, check) in your components, through the wait plugin and the MazFullscreenLoader"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/composables/use-wait"
6
6
  ---
7
7
 
8
8
  # useWait
9
9
 
10
- > Vue composable for handling wait plugins
10
+ > Vue composable to manage loading states (start, stop, check) in your components, through the wait plugin and the MazFullscreenLoader
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import { useWait } from 'maz-ui/composables/useWait'`
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "v-fullscreen-img"
3
- description: "Displays images fullscreen on click"
2
+ title: "vFullscreenImg"
3
+ description: "vFullscreenImg is a Vue directive that opens an image in fullscreen on click, with zoom and navigation between the images of a group"
4
4
  package: "maz-ui"
5
5
  url: "https://maz-ui.com/directives/fullscreen-img"
6
6
  ---
7
7
 
8
- # v-fullscreen-img
8
+ # vFullscreenImg
9
9
 
10
- > Displays images fullscreen on click
10
+ > vFullscreenImg is a Vue directive that opens an image in fullscreen on click, with zoom and navigation between the images of a group
11
11
 
12
12
  - Package: `maz-ui`
13
13
  - Import: `import { vFullscreenImg } from 'maz-ui/directives/vFullscreenImg'`
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "IconSet"
3
- description: ""
2
+ title: "Icon Set"
3
+ description: "Search and copy the 860+ icons of @maz-ui/icons, with the naming convention and the static, lazy and raw imports of each icon"
4
4
  package: "@maz-ui/icons"
5
5
  url: "https://maz-ui.com/ecosystem/icons/icon-set"
6
6
  ---
7
7
 
8
- # IconSet
8
+ # Icon Set
9
9
 
10
- >
10
+ > Search and copy the 860+ icons of @maz-ui/icons, with the naming convention and the static, lazy and raw imports of each icon
11
11
 
12
12
  - Package: `@maz-ui/icons`
13
13
  - Web: https://maz-ui.com/ecosystem/icons/icon-set
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Icons"
3
- description: ""
2
+ title: "@maz-ui/icons"
3
+ description: "The @maz-ui/icons package provides 860+ SVG icons (interface icons, brand logos, country flags) as tree-shakable Vue components, lazy components or raw SVG strings"
4
4
  package: "@maz-ui/icons"
5
5
  url: "https://maz-ui.com/ecosystem/icons/"
6
6
  ---
7
7
 
8
- # Icons
8
+ # @maz-ui/icons
9
9
 
10
- >
10
+ > The @maz-ui/icons package provides 860+ SVG icons (interface icons, brand logos, country flags) as tree-shakable Vue components, lazy components or raw SVG strings
11
11
 
12
12
  - Package: `@maz-ui/icons`
13
13
  - Import: `import { MazCheck } from '@maz-ui/icons/static/MazCheck'` or `import { MazIconsResolver } from '@maz-ui/icons/resolvers'`
@@ -23,7 +23,7 @@ It registers the server and writes the maz-ui rules for the agents of your proje
23
23
  | `search_docs` | Find what maz-ui provides for a need, described in plain words ("user avatar with initials", "confirm before delete", "debounce search") or by name. Understands the vocabulary of other libraries ("modal", "snackbar", "combobox") |
24
24
  | `get_component_api` | Exact API of up to 10 components: props with types, defaults and accepted values, `v-model`, events with payload, slots with bindings, exposed methods |
25
25
  | `find_icons` | Icons of `@maz-ui/icons` by meaning ("delete", "settings", "france flag") with their imports |
26
- | `get_theme_tokens` | Every Tailwind class and CSS variable of the maz-ui theme: colors, radius, shadows, spacing, breakpoints, fonts, z-index, utilities |
26
+ | `get_theme_tokens` | The theme of your project (preset values, `@theme` tokens, variants, utilities, read from your files) and every Tailwind class and CSS variable of the maz-ui theme: colors, radius, shadows, spacing, breakpoints, fonts, z-index, utilities |
27
27
  | `get_doc` | Any documentation page by id or name (`components/maz-btn`, `useToast`, `guide/tailwind`), whole or by sections |
28
28
  | `list_docs` | Catalog of the components, composables, directives, plugins, helpers, packages and guides |
29
29
  | `get_setup_guide` | Installation steps for Vue or Nuxt, with or without Tailwind |
@@ -447,17 +447,21 @@ const agents = {
447
447
  rules: false,
448
448
  // 'claude' | 'agents-md' | 'cursor' | 'vscode' (default: the detected agents)
449
449
  targets: ['claude', 'agents-md'],
450
+ // Folder where the files are written, relative to the Nuxt app (default: the root of the workspace)
451
+ dir: '../..',
450
452
  }
451
453
  // agents: true enables mcp and rules, agents: false disables everything
452
454
  ```
453
455
 
456
+ In a monorepo, the files are written at the **root of the workspace** (`workspaceDir` of Nuxt), where your agents start, not in the Nuxt app: a single `.mcp.json` serves every app. Set `dir` to choose another folder.
457
+
454
458
  The module runs in development only (never in CI nor in tests), only for the agents it detects in the project (`.claude/`, `CLAUDE.md`, `.mcp.json`, `.cursor/`, `.vscode/mcp.json`, `.github/copilot-instructions.md`, `AGENTS.md`, `.codex/`, `.windsurf/`...), and keeps the files up to date when you upgrade maz-ui:
455
459
 
456
460
  - `.mcp.json`, `.cursor/mcp.json`, `.vscode/mcp.json`: a `maz-ui` server entry, added only when no maz-ui MCP server is already registered
457
461
  - with `rules: true`, `.claude/rules/maz-ui.md`: a Claude Code rule (skipped when Claude reads `AGENTS.md`, i.e. without `CLAUDE.md`)
458
462
  - with `rules: true`, `AGENTS.md`: a section delimited by `<!-- BEGIN:maz-ui -->` and `<!-- END:maz-ui -->`, read by Codex, Cursor, Copilot, Windsurf...
459
463
 
460
- It never overwrites a file it does not own: your `CLAUDE.md`, your own rules and the other MCP servers are left untouched. Commit the generated files to share them with your team. See the [AI agents guide](../guide/ai-agents.md) for details.
464
+ It never overwrites a file it does not own: your `CLAUDE.md`, your own rules and the other MCP servers are left untouched, and an existing `maz-ui` server entry (for example pinned to a version) is kept as is. Commit the generated files to share them with your team (check that `.claude/` is not in your `.gitignore`). See the [AI agents guide](../guide/ai-agents.md) for details.
461
465
 
462
466
  ## Advanced Theming
463
467