@maz-ui/mcp 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/README.md +61 -228
- package/bin/maz-ui-mcp.mjs +2 -5
- package/dist/cli.d.mts +7 -0
- package/dist/cli.d.ts +7 -0
- package/dist/cli.mjs +14 -0
- package/dist/index.d.mts +340 -0
- package/dist/index.d.ts +340 -0
- package/dist/index.mjs +14 -0
- package/dist/shared/mcp.DzqVbCaL.mjs +2346 -0
- 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/{src/components → components}/maz-alert.md +31 -164
- 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/{src/components → components}/maz-badge.md +26 -67
- package/docs/components/maz-bottom-sheet.md +257 -0
- package/docs/{src/components → components}/maz-btn-group.md +26 -189
- package/docs/{src/components → components}/maz-btn.md +60 -245
- package/docs/components/maz-card-spotlight.md +84 -0
- package/docs/{src/components → components}/maz-card.md +67 -192
- package/docs/components/maz-carousel.md +153 -0
- package/docs/{src/components → components}/maz-chart.md +17 -161
- 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/{src/components → components}/maz-code-highlight.md +15 -93
- package/docs/components/maz-container.md +241 -0
- package/docs/{src/components → components}/maz-date-picker.md +85 -454
- 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/{src/components → components}/maz-dropzone.md +80 -221
- 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/{src/components → components}/maz-icon.md +32 -83
- 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/{src/components → components}/maz-input.md +74 -221
- 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/{src/components → components}/maz-markdown-editor.md +72 -125
- package/docs/components/maz-pagination.md +82 -0
- package/docs/components/maz-popover.md +794 -0
- package/docs/{src/components → components}/maz-pull-to-refresh.md +59 -45
- package/docs/components/maz-radio-buttons.md +313 -0
- package/docs/components/maz-radio.md +119 -0
- package/docs/{src/components → components}/maz-read-more.md +31 -122
- package/docs/components/maz-reading-progress-bar.md +96 -0
- package/docs/{src/components → components}/maz-select-country.md +80 -340
- package/docs/{src/components → components}/maz-select.md +76 -206
- 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/{src/components → components}/maz-sidebar.md +117 -329
- package/docs/{src/components → components}/maz-skeleton.md +27 -156
- package/docs/{src/components → components}/maz-slider.md +33 -66
- package/docs/components/maz-spinner.md +84 -0
- package/docs/{src/components → components}/maz-stepper.md +43 -185
- 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/{src/components → components}/maz-tabs.md +89 -126
- 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/{src/components → components}/maz-window-mockup.md +38 -105
- 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/{src/composables → composables}/use-display-names.md +12 -59
- package/docs/{src/composables → composables}/use-drag.md +14 -68
- package/docs/{src/composables → composables}/use-form-validator.md +22 -696
- package/docs/{src/composables → composables}/use-idle-timeout.md +13 -97
- package/docs/{src/composables → composables}/use-pull-to-refresh.md +14 -7
- package/docs/{src/composables → composables}/use-reading-time.md +20 -56
- package/docs/composables/use-string-matching.md +41 -0
- package/docs/{src/composables → composables}/use-swipe.md +14 -81
- package/docs/{src/composables → composables}/use-timer.md +12 -38
- package/docs/composables/use-toast.md +50 -0
- package/docs/{src/composables → composables}/use-user-visibility.md +14 -56
- package/docs/composables/use-wait.md +50 -0
- package/docs/composables/use-window-size.md +25 -0
- package/docs/{src/directives → directives}/click-outside.md +13 -99
- package/docs/{src/directives → directives}/fullscreen-img.md +10 -28
- package/docs/{src/directives → directives}/lazy-img.md +14 -49
- package/docs/{src/directives → directives}/tooltip.md +12 -217
- package/docs/{src/directives → directives}/zoom-img.md +11 -38
- package/docs/{src/ecosystem → ecosystem}/eslint-config.md +37 -29
- package/docs/ecosystem/icons/icon-set.md +25 -0
- package/docs/{src/ecosystem → ecosystem}/icons/index.md +22 -16
- package/docs/ecosystem/mcp.md +165 -0
- package/docs/{src/ecosystem → ecosystem}/node/exec-promise.md +12 -6
- package/docs/ecosystem/node/index.md +53 -0
- package/docs/{src/ecosystem → ecosystem}/node/logger.md +12 -6
- package/docs/{src/ecosystem → ecosystem}/node/print-banner.md +12 -4
- package/docs/ecosystem/node/setup-agents.md +102 -0
- package/docs/{src/ecosystem → ecosystem}/nuxt.md +46 -19
- package/docs/{src/ecosystem → ecosystem}/stylelint-config.md +33 -25
- package/docs/{src/ecosystem → ecosystem}/themes.md +72 -235
- package/docs/{src/ecosystem → ecosystem}/translations.md +25 -23
- package/docs/ecosystem/utils/camel-case.md +37 -0
- package/docs/ecosystem/utils/capitalize.md +37 -0
- package/docs/{src/ecosystem → ecosystem}/utils/check-availability.md +14 -8
- package/docs/{src/ecosystem → ecosystem}/utils/cookie.md +18 -12
- package/docs/ecosystem/utils/country-code-to-unicode-flag.md +128 -0
- package/docs/{src/ecosystem → ecosystem}/utils/currency.md +12 -26
- package/docs/{src/ecosystem → ecosystem}/utils/date.md +10 -24
- package/docs/ecosystem/utils/debounce-callback.md +44 -0
- package/docs/{src/ecosystem → ecosystem}/utils/debounce-id.md +14 -8
- package/docs/{src/ecosystem → ecosystem}/utils/debounce.md +14 -8
- package/docs/ecosystem/utils/fetch-locale-ip.md +39 -0
- package/docs/{src/ecosystem → ecosystem}/utils/format-json.md +11 -5
- package/docs/{src/ecosystem → ecosystem}/utils/format-phone-number.md +12 -6
- package/docs/ecosystem/utils/get-browser-locale.md +35 -0
- package/docs/ecosystem/utils/get-country-flag-url.md +67 -0
- package/docs/{src/ecosystem → ecosystem}/utils/get-error-message.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/idle-timeout.md +15 -9
- package/docs/{src/ecosystem → ecosystem}/utils/index.md +10 -13
- package/docs/{src/ecosystem → ecosystem}/utils/is-client.md +11 -5
- package/docs/{src/ecosystem → ecosystem}/utils/is-equal.md +14 -8
- package/docs/{src/ecosystem → ecosystem}/utils/is-ios.md +12 -6
- package/docs/ecosystem/utils/is-server.md +37 -0
- package/docs/ecosystem/utils/is-standalone-mode.md +49 -0
- package/docs/{src/ecosystem → ecosystem}/utils/kebab-case.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/normalize-string.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/number.md +10 -24
- package/docs/{src/ecosystem → ecosystem}/utils/pascal-case.md +11 -5
- package/docs/{src/ecosystem → ecosystem}/utils/prevent-ios-input-zoom.md +14 -8
- package/docs/{src/ecosystem → ecosystem}/utils/script-loader.md +16 -8
- package/docs/{src/ecosystem → ecosystem}/utils/sleep.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/snake-case.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/swipe-handler.md +14 -8
- package/docs/{src/ecosystem → ecosystem}/utils/textarea-autogrow.md +12 -6
- package/docs/{src/ecosystem → ecosystem}/utils/throttle-id.md +13 -7
- package/docs/{src/ecosystem → ecosystem}/utils/throttle.md +14 -8
- package/docs/ecosystem/utils/truthy-filter.md +37 -0
- package/docs/{src/ecosystem → ecosystem}/utils/types/deep-key-of.md +11 -5
- package/docs/{src/ecosystem → ecosystem}/utils/types/deep-partial.md +10 -4
- package/docs/ecosystem/utils/types/deep-required.md +45 -0
- package/docs/ecosystem/utils/types/flatten-object-keys.md +50 -0
- package/docs/{src/ecosystem → ecosystem}/utils/types/generic-instance-type.md +10 -4
- package/docs/{src/ecosystem → ecosystem}/utils/types/infer-maybe-ref.md +10 -4
- package/docs/ecosystem/utils/upper-first.md +38 -0
- package/docs/{src/ecosystem → ecosystem}/utils/user-visibility.md +12 -6
- package/docs/guide/ai-agents.md +237 -0
- package/docs/{src/guide → guide}/browser-support.md +22 -15
- package/docs/{src/guide → guide}/getting-started.md +34 -139
- package/docs/{src/guide → guide}/global-defaults.md +12 -11
- package/docs/{src/guide → guide}/maz-ui-provider.md +17 -16
- package/docs/{src/guide → guide}/migration-v5.md +95 -88
- package/docs/{src/guide → guide}/resolvers.md +33 -100
- package/docs/guide/tailwind.md +483 -0
- package/docs/{src/guide → guide}/vue.md +33 -39
- package/docs/manifest.json +1 -0
- package/docs/{src/plugins → plugins}/aos.md +20 -55
- package/docs/{src/plugins → plugins}/dialog.md +14 -161
- 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 +84 -22
- package/dist/mcp.d.mts +0 -153
- package/dist/mcp.d.ts +0 -153
- package/dist/mcp.mjs +0 -1511
- package/docs/generated-docs/maz-accordion.doc.md +0 -21
- package/docs/generated-docs/maz-alert.doc.md +0 -20
- package/docs/generated-docs/maz-animated-counter.doc.md +0 -17
- package/docs/generated-docs/maz-animated-element.doc.md +0 -14
- package/docs/generated-docs/maz-animated-text.doc.md +0 -17
- package/docs/generated-docs/maz-avatar.doc.md +0 -45
- package/docs/generated-docs/maz-backdrop.doc.md +0 -55
- package/docs/generated-docs/maz-badge.doc.md +0 -16
- package/docs/generated-docs/maz-bottom-sheet.doc.md +0 -24
- package/docs/generated-docs/maz-btn-group.doc.md +0 -20
- package/docs/generated-docs/maz-btn.doc.md +0 -33
- package/docs/generated-docs/maz-card-spotlight.doc.md +0 -16
- package/docs/generated-docs/maz-card.doc.md +0 -39
- package/docs/generated-docs/maz-carousel.doc.md +0 -17
- package/docs/generated-docs/maz-chart.doc.md +0 -10
- package/docs/generated-docs/maz-checkbox.doc.md +0 -33
- package/docs/generated-docs/maz-checklist.doc.md +0 -30
- package/docs/generated-docs/maz-circular-progress-bar.doc.md +0 -27
- package/docs/generated-docs/maz-code-highlight.doc.md +0 -11
- package/docs/generated-docs/maz-container.doc.md +0 -26
- package/docs/generated-docs/maz-date-picker.doc.md +0 -56
- package/docs/generated-docs/maz-dialog-confirm.doc.md +0 -24
- package/docs/generated-docs/maz-dialog.doc.md +0 -22
- package/docs/generated-docs/maz-drawer.doc.md +0 -25
- package/docs/generated-docs/maz-dropdown.doc.md +0 -45
- package/docs/generated-docs/maz-dropzone.doc.md +0 -82
- package/docs/generated-docs/maz-expand-animation.doc.md +0 -12
- package/docs/generated-docs/maz-fullscreen-loader.doc.md +0 -13
- package/docs/generated-docs/maz-gallery.doc.md +0 -17
- package/docs/generated-docs/maz-icon.doc.md +0 -16
- package/docs/generated-docs/maz-input-code.doc.md +0 -25
- package/docs/generated-docs/maz-input-number.doc.md +0 -33
- package/docs/generated-docs/maz-input-phone-number.doc.md +0 -62
- package/docs/generated-docs/maz-input-price.doc.md +0 -26
- package/docs/generated-docs/maz-input-tags.doc.md +0 -24
- package/docs/generated-docs/maz-input.doc.md +0 -54
- package/docs/generated-docs/maz-lazy-img.doc.md +0 -49
- package/docs/generated-docs/maz-link.doc.md +0 -31
- package/docs/generated-docs/maz-loading-bar.doc.md +0 -6
- package/docs/generated-docs/maz-markdown-editor.doc.md +0 -65
- package/docs/generated-docs/maz-pagination.doc.md +0 -21
- package/docs/generated-docs/maz-popover.doc.md +0 -79
- package/docs/generated-docs/maz-pull-to-refresh.doc.md +0 -50
- package/docs/generated-docs/maz-radio-buttons.doc.md +0 -34
- package/docs/generated-docs/maz-radio.doc.md +0 -33
- package/docs/generated-docs/maz-read-more.doc.md +0 -18
- package/docs/generated-docs/maz-reading-progress-bar.doc.md +0 -18
- package/docs/generated-docs/maz-select-country.doc.md +0 -45
- package/docs/generated-docs/maz-select.doc.md +0 -32
- package/docs/generated-docs/maz-sidebar-content.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar-footer.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar-group.doc.md +0 -11
- package/docs/generated-docs/maz-sidebar-header.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar-menu-button.doc.md +0 -27
- package/docs/generated-docs/maz-sidebar-menu-item.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar-menu-sub.doc.md +0 -16
- package/docs/generated-docs/maz-sidebar-menu.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar-separator.doc.md +0 -0
- package/docs/generated-docs/maz-sidebar-trigger.doc.md +0 -5
- package/docs/generated-docs/maz-sidebar.doc.md +0 -36
- package/docs/generated-docs/maz-skeleton.doc.md +0 -12
- package/docs/generated-docs/maz-slider.doc.md +0 -20
- package/docs/generated-docs/maz-spinner.doc.md +0 -6
- package/docs/generated-docs/maz-stepper.doc.md +0 -30
- package/docs/generated-docs/maz-switch.doc.md +0 -31
- package/docs/generated-docs/maz-table-cell.doc.md +0 -5
- package/docs/generated-docs/maz-table-row.doc.md +0 -12
- package/docs/generated-docs/maz-table-title.doc.md +0 -5
- package/docs/generated-docs/maz-table-virtualizer.doc.md +0 -20
- package/docs/generated-docs/maz-table.doc.md +0 -72
- package/docs/generated-docs/maz-tabs-bar.doc.md +0 -29
- package/docs/generated-docs/maz-tabs-content-item.doc.md +0 -11
- package/docs/generated-docs/maz-tabs-content.doc.md +0 -5
- package/docs/generated-docs/maz-tabs.doc.md +0 -20
- package/docs/generated-docs/maz-textarea.doc.md +0 -46
- package/docs/generated-docs/maz-ticker.doc.md +0 -25
- package/docs/generated-docs/maz-timeline.doc.md +0 -32
- package/docs/generated-docs/maz-ui-provider.doc.md +0 -12
- package/docs/generated-docs/maz-window-mockup.doc.md +0 -23
- package/docs/src/blog/v4.md +0 -276
- package/docs/src/blog/v5.md +0 -184
- package/docs/src/changelog.md +0 -7
- package/docs/src/components/index.md +0 -8
- package/docs/src/components/maz-accordion.md +0 -80
- package/docs/src/components/maz-animated-counter.md +0 -124
- package/docs/src/components/maz-animated-element.md +0 -36
- package/docs/src/components/maz-animated-text.md +0 -36
- package/docs/src/components/maz-avatar.md +0 -227
- package/docs/src/components/maz-backdrop.md +0 -250
- package/docs/src/components/maz-bottom-sheet.md +0 -533
- package/docs/src/components/maz-card-spotlight.md +0 -163
- package/docs/src/components/maz-carousel.md +0 -231
- package/docs/src/components/maz-checkbox.md +0 -168
- package/docs/src/components/maz-checklist.md +0 -414
- package/docs/src/components/maz-circular-progress-bar.md +0 -145
- package/docs/src/components/maz-container.md +0 -363
- package/docs/src/components/maz-dialog-confirm.md +0 -240
- package/docs/src/components/maz-dialog.md +0 -164
- package/docs/src/components/maz-drawer.md +0 -181
- package/docs/src/components/maz-dropdown.md +0 -691
- package/docs/src/components/maz-expand-animation.md +0 -99
- package/docs/src/components/maz-fullscreen-loader.md +0 -58
- package/docs/src/components/maz-gallery.md +0 -85
- package/docs/src/components/maz-input-code.md +0 -61
- package/docs/src/components/maz-input-number.md +0 -81
- package/docs/src/components/maz-input-phone-number.md +0 -942
- package/docs/src/components/maz-input-price.md +0 -67
- package/docs/src/components/maz-input-tags.md +0 -114
- package/docs/src/components/maz-lazy-img.md +0 -88
- package/docs/src/components/maz-link.md +0 -178
- package/docs/src/components/maz-loading-bar.md +0 -26
- package/docs/src/components/maz-pagination.md +0 -79
- package/docs/src/components/maz-popover.md +0 -1416
- package/docs/src/components/maz-radio-buttons.md +0 -462
- package/docs/src/components/maz-radio.md +0 -142
- package/docs/src/components/maz-reading-progress-bar.md +0 -74
- package/docs/src/components/maz-spinner.md +0 -93
- package/docs/src/components/maz-switch.md +0 -92
- package/docs/src/components/maz-table.md +0 -732
- package/docs/src/components/maz-textarea.md +0 -400
- package/docs/src/components/maz-ticker.md +0 -692
- package/docs/src/components/maz-timeline.md +0 -478
- package/docs/src/composables/use-aos.md +0 -34
- package/docs/src/composables/use-breakpoints.md +0 -35
- package/docs/src/composables/use-dialog.md +0 -88
- package/docs/src/composables/use-string-matching.md +0 -63
- package/docs/src/composables/use-toast.md +0 -71
- package/docs/src/composables/use-wait.md +0 -62
- package/docs/src/composables/use-window-size.md +0 -18
- package/docs/src/ecosystem/icons/icon-set.md +0 -123
- package/docs/src/ecosystem/mcp.md +0 -210
- package/docs/src/ecosystem/node/index.md +0 -53
- package/docs/src/ecosystem/utils/camel-case.md +0 -31
- package/docs/src/ecosystem/utils/capitalize.md +0 -50
- package/docs/src/ecosystem/utils/country-code-to-unicode-flag.md +0 -213
- package/docs/src/ecosystem/utils/debounce-callback.md +0 -38
- package/docs/src/ecosystem/utils/fetch-locale-ip.md +0 -33
- package/docs/src/ecosystem/utils/get-browser-locale.md +0 -29
- package/docs/src/ecosystem/utils/get-country-flag-url.md +0 -156
- package/docs/src/ecosystem/utils/is-server.md +0 -31
- package/docs/src/ecosystem/utils/is-standalone-mode.md +0 -43
- package/docs/src/ecosystem/utils/truthy-filter.md +0 -31
- package/docs/src/ecosystem/utils/types/deep-required.md +0 -39
- package/docs/src/ecosystem/utils/types/flatten-object-keys.md +0 -44
- package/docs/src/ecosystem/utils/upper-first.md +0 -32
- package/docs/src/guide/cli.md +0 -144
- package/docs/src/guide/migration-v4.md +0 -925
- package/docs/src/guide/tailwind.md +0 -158
- package/docs/src/index.md +0 -603
- package/docs/src/made-with-maz-ui.md +0 -58
- package/docs/src/plugins/toast.md +0 -349
- package/docs/src/plugins/wait.md +0 -109
- package/docs/src/theme-editor.md +0 -21
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Icons reference
|
|
2
|
+
|
|
3
|
+
> The 861 icons of `@maz-ui/icons`. Use them instead of inline SVG or another icon library.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```vue
|
|
8
|
+
<script setup lang="ts">
|
|
9
|
+
import { MazTrash } from '@maz-ui/icons/static/MazTrash' // one icon, tree-shakable
|
|
10
|
+
import { MazXMark } from '@maz-ui/icons/lazy/MazXMark' // lazy-loaded async component
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<template>
|
|
14
|
+
<MazTrash class="size-5 text-destructive" />
|
|
15
|
+
<MazBtn :start-icon="MazTrash" color="destructive">Delete</MazBtn>
|
|
16
|
+
</template>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
- Barrel import: `import { MazTrash, LazyMazTrash } from '@maz-ui/icons'`. Raw SVG string: `import { MazTrash } from '@maz-ui/icons/raw/MazTrash'`.
|
|
20
|
+
- Auto-import with unplugin-vue-components: `import { MazIconsResolver } from '@maz-ui/icons/resolvers'`.
|
|
21
|
+
- maz-ui components accept icons as props (`start-icon`, `end-icon`, `icon`...): pass the component itself, not a string.
|
|
22
|
+
- Size and color come from CSS: `class="size-5 text-primary"` (icons use `currentColor`).
|
|
23
|
+
|
|
24
|
+
## Interface icons (329)
|
|
25
|
+
|
|
26
|
+
Heroicons-based outline icons (`MazTrash`, `MazXMark`, `MazMagnifyingGlass`...)
|
|
27
|
+
|
|
28
|
+
MazAcademicCap, MazAdjustmentsHorizontal, MazAdjustmentsVertical, MazArchiveBox, MazArchiveBoxArrowDown, MazArchiveBoxXMark, MazArrowDown, MazArrowDownCircle, MazArrowDownLeft, MazArrowDownOnSquare, MazArrowDownOnSquareStack, MazArrowDownRight, MazArrowDownTray, MazArrowLeft, MazArrowLeftCircle, MazArrowLeftEndOnRectangle, MazArrowLeftOnRectangle, MazArrowLeftStartOnRectangle, MazArrowLongDown, MazArrowLongLeft, MazArrowLongRight, MazArrowLongUp, MazArrowPath, MazArrowPathRoundedSquare, MazArrowRight, MazArrowRightCircle, MazArrowRightEndOnRectangle, MazArrowRightOnRectangle, MazArrowRightStartOnRectangle, MazArrowSmallDown, MazArrowSmallLeft, MazArrowSmallRight, MazArrowSmallUp, MazArrowsPointingIn, MazArrowsPointingOut, MazArrowsRightLeft, MazArrowsUpDown, MazArrowTopRightOnSquare, MazArrowTrendingDown, MazArrowTrendingUp, MazArrowTurnDownLeft, MazArrowTurnDownRight, MazArrowTurnLeftDown, MazArrowTurnLeftUp, MazArrowTurnRightDown, MazArrowTurnRightUp, MazArrowTurnUpLeft, MazArrowTurnUpRight, MazArrowUp, MazArrowUpCircle, MazArrowUpLeft, MazArrowUpOnSquare, MazArrowUpOnSquareStack, MazArrowUpRight, MazArrowUpTray, MazArrowUturnDown, MazArrowUturnLeft, MazArrowUturnRight, MazArrowUturnUp, MazAtSymbol, MazBackspace, MazBackward, MazBanknotes, MazBars2, MazBars3, MazBars3BottomLeft, MazBars3BottomRight, MazBars3CenterLeft, MazBars4, MazBarsArrowDown, MazBarsArrowUp, MazBattery0, MazBattery100, MazBattery50, MazBeaker, MazBell, MazBellAlert, MazBellSlash, MazBellSnooze, MazBold, MazBolt, MazBoltSlash, MazBookmark, MazBookmarkSlash, MazBookmarkSquare, MazBookOpen, MazBriefcase, MazBugAnt, MazBuildingLibrary, MazBuildingOffice, MazBuildingOffice2, MazBuildingStorefront, MazCake, MazCalculator, MazCalendar, MazCalendarDateRange, MazCalendarDays, MazCamera, MazChartBar, MazChartBarSquare, MazChartPie, MazChatBubbleBottomCenter, MazChatBubbleBottomCenterText, MazChatBubbleLeft, MazChatBubbleLeftEllipsis, MazChatBubbleLeftRight, MazChatBubbleOvalLeft, MazChatBubbleOvalLeftEllipsis, MazCheck, MazCheckBadge, MazCheckCircle, MazChevronDoubleDown, MazChevronDoubleLeft, MazChevronDoubleRight, MazChevronDoubleUp, MazChevronDown, MazChevronLeft, MazChevronRight, MazChevronUp, MazChevronUpDown, MazCircleStack, MazClipboard, MazClipboardDocument, MazClipboardDocumentCheck, MazClipboardDocumentList, MazClock, MazCloud, MazCloudArrowDown, MazCloudArrowUp, MazCodeBracket, MazCodeBracketSquare, MazCog, MazCog6Tooth, MazCog8Tooth, MazCommandLine, MazComputerDesktop, MazCpuChip, MazCreditCard, MazCube, MazCubeTransparent, MazCurrencyBangladeshi, MazCurrencyDollar, MazCurrencyEuro, MazCurrencyPound, MazCurrencyRupee, MazCurrencyYen, MazCursorArrowRays, MazCursorArrowRipple, MazDevicePhoneMobile, MazDeviceTablet, MazDivide, MazDocumentArrowDown, MazDocumentArrowUp, MazDocumentChartBar, MazDocumentCheck, MazDocumentCurrencyBangladeshi, MazDocumentCurrencyDollar, MazDocumentCurrencyEuro, MazDocumentCurrencyPound, MazDocumentCurrencyRupee, MazDocumentCurrencyYen, MazDocumentDuplicate, MazDocumentIcon, MazDocumentMagnifyingGlass, MazDocumentMinus, MazDocumentPlus, MazDocumentText, MazEllipsisHorizontal, MazEllipsisHorizontalCircle, MazEllipsisVertical, MazEnvelope, MazEnvelopeOpen, MazEquals, MazExclamationCircle, MazExclamationTriangle, MazEye, MazEyeDropper, MazEyeSlash, MazFaceFrown, MazFaceSmile, MazFilm, MazFingerPrint, MazFire, MazFlag, MazFolder, MazFolderArrowDown, MazFolderMinus, MazFolderOpen, MazFolderPlus, MazFork, MazForward, MazFunnel, MazGif, MazGift, MazGiftTop, MazGithub, MazGlobeAlt, MazGlobeAmericas, MazGlobeAsiaAustralia, MazGlobeEuropeAfrica, MazH1, MazH2, MazH3, MazHandRaised, MazHandThumbDown, MazHandThumbUp, MazHashtag, MazHeart, MazHome, MazHomeModern, MazIdentification, MazInbox, MazInboxArrowDown, MazInboxStack, MazInformationCircle, MazItalic, MazKey, MazLanguage, MazLifebuoy, MazLightBulb, MazLinkIcon, MazLinkSlash, MazListBullet, MazLockClosed, MazLockOpen, MazMagnifyingGlass, MazMagnifyingGlassCircle, MazMagnifyingGlassMinus, MazMagnifyingGlassPlus, MazMapIcon, MazMapPin, MazMegaphone, MazMicrophone, MazMinus, MazMinusCircle, MazMinusSmall, MazMoon, MazMusicalNote, MazNewspaper, MazNoImage, MazNoSymbol, MazNumberedList, MazPaintBrush, MazPaperAirplane, MazPaperClip, MazPause, MazPauseCircle, MazPencil, MazPencilSquare, MazPercentBadge, MazPhone, MazPhoneArrowDownLeft, MazPhoneArrowUpRight, MazPhoneXMark, MazPhoto, MazPlay, MazPlayCircle, MazPlayPause, MazPlus, MazPlusCircle, MazPlusSmall, MazPower, MazPresentationChartBar, MazPresentationChartLine, MazPrinter, MazPuzzlePiece, MazQrCode, MazQuestionMarkCircle, MazQueueList, MazQuote, MazRadioIcon, MazReceiptPercent, MazReceiptRefund, MazRectangleGroup, MazRectangleStack, MazRocketLaunch, MazRss, MazScale, MazScissors, MazServer, MazServerStack, MazShare, MazShieldCheck, MazShieldExclamation, MazShoppingBag, MazShoppingCart, MazSignal, MazSignalSlash, MazSlash, MazSparkles, MazSpeakerWave, MazSpeakerXMark, MazSquare2Stack, MazSquare3Stack3d, MazSquares2x2, MazSquaresPlus, MazStar, MazStarSolid, MazStop, MazStopCircle, MazStrikethrough, MazSun, MazSwatch, MazTableCells, MazTag, MazTelevision, MazTicket, MazTrash, MazTrophy, MazTruck, MazUnderline, MazUser, MazUserCircle, MazUserGroup, MazUserMinus, MazUserPlus, MazUsers, MazVariable, MazVideoCamera, MazVideoCameraSlash, MazViewColumns, MazViewfinderCircle, MazWallet, MazWifi, MazWindowIcon, MazWrench, MazWrenchScrewdriver, MazXCircle, MazXMark
|
|
29
|
+
|
|
30
|
+
## Logos (20)
|
|
31
|
+
|
|
32
|
+
Brand and file-type logos
|
|
33
|
+
|
|
34
|
+
MazLogoAndroid, MazLogoApple, MazLogoCsv, MazLogoFacebook, MazLogoHtml, MazLogoInstagram, MazLogoJs, MazLogoJson, MazLogoLinkedin, MazLogoMarkdown, MazLogoNpm, MazLogoProperties, MazLogoReact, MazLogoTwitter, MazLogoTxt, MazLogoTypescript, MazLogoVue, MazLogoXliff, MazLogoXls, MazLogoXml
|
|
35
|
+
|
|
36
|
+
## Country flags (3x2) (256)
|
|
37
|
+
|
|
38
|
+
`MazFlag` + ISO 3166-1 alpha-2 code in uppercase (`MazFlagFR`, `MazFlagUS`)
|
|
39
|
+
|
|
40
|
+
MazFlagAC, MazFlagAD, MazFlagAE, MazFlagAF, MazFlagAG, MazFlagAI, MazFlagAL, MazFlagAM, MazFlagAO, MazFlagAQ, MazFlagAR, MazFlagAS, MazFlagAT, MazFlagAU, MazFlagAW, MazFlagAX, MazFlagAZ, MazFlagBA, MazFlagBB, MazFlagBD, MazFlagBE, MazFlagBF, MazFlagBG, MazFlagBH, MazFlagBI, MazFlagBJ, MazFlagBL, MazFlagBM, MazFlagBN, MazFlagBO, MazFlagBQ, MazFlagBR, MazFlagBS, MazFlagBT, MazFlagBV, MazFlagBW, MazFlagBY, MazFlagBZ, MazFlagCA, MazFlagCC, MazFlagCD, MazFlagCF, MazFlagCG, MazFlagCH, MazFlagCI, MazFlagCK, MazFlagCL, MazFlagCM, MazFlagCN, MazFlagCO, MazFlagCR, MazFlagCU, MazFlagCV, MazFlagCW, MazFlagCX, MazFlagCY, MazFlagCZ, MazFlagDE, MazFlagDJ, MazFlagDK, MazFlagDM, MazFlagDO, MazFlagDZ, MazFlagEC, MazFlagEE, MazFlagEG, MazFlagEH, MazFlagER, MazFlagES, MazFlagET, MazFlagEU, MazFlagFI, MazFlagFJ, MazFlagFK, MazFlagFM, MazFlagFO, MazFlagFR, MazFlagGA, MazFlagGB, MazFlagGD, MazFlagGE, MazFlagGEAB, MazFlagGEOS, MazFlagGF, MazFlagGG, MazFlagGH, MazFlagGI, MazFlagGL, MazFlagGM, MazFlagGN, MazFlagGP, MazFlagGQ, MazFlagGR, MazFlagGS, MazFlagGT, MazFlagGU, MazFlagGW, MazFlagGY, MazFlagHK, MazFlagHM, MazFlagHN, MazFlagHR, MazFlagHT, MazFlagHU, MazFlagIC, MazFlagID, MazFlagIE, MazFlagIL, MazFlagIM, MazFlagIN, MazFlagIO, MazFlagIQ, MazFlagIR, MazFlagIS, MazFlagIT, MazFlagJE, MazFlagJM, MazFlagJO, MazFlagJP, MazFlagKE, MazFlagKG, MazFlagKH, MazFlagKI, MazFlagKM, MazFlagKN, MazFlagKP, MazFlagKR, MazFlagKW, MazFlagKY, MazFlagKZ, MazFlagLA, MazFlagLB, MazFlagLC, MazFlagLI, MazFlagLK, MazFlagLR, MazFlagLS, MazFlagLT, MazFlagLU, MazFlagLV, MazFlagLY, MazFlagMA, MazFlagMC, MazFlagMD, MazFlagME, MazFlagMF, MazFlagMG, MazFlagMH, MazFlagMK, MazFlagML, MazFlagMM, MazFlagMN, MazFlagMO, MazFlagMP, MazFlagMQ, MazFlagMR, MazFlagMS, MazFlagMT, MazFlagMU, MazFlagMV, MazFlagMW, MazFlagMX, MazFlagMY, MazFlagMZ, MazFlagNA, MazFlagNC, MazFlagNE, MazFlagNF, MazFlagNG, MazFlagNI, MazFlagNL, MazFlagNO, MazFlagNP, MazFlagNR, MazFlagNU, MazFlagNZ, MazFlagOM, MazFlagPA, MazFlagPE, MazFlagPF, MazFlagPG, MazFlagPH, MazFlagPK, MazFlagPL, MazFlagPM, MazFlagPN, MazFlagPR, MazFlagPS, MazFlagPT, MazFlagPW, MazFlagPY, MazFlagQA, MazFlagRE, MazFlagRO, MazFlagRS, MazFlagRU, MazFlagRW, MazFlagSA, MazFlagSB, MazFlagSC, MazFlagSD, MazFlagSE, MazFlagSG, MazFlagSH, MazFlagSI, MazFlagSJ, MazFlagSK, MazFlagSL, MazFlagSM, MazFlagSN, MazFlagSO, MazFlagSR, MazFlagSS, MazFlagST, MazFlagSV, MazFlagSX, MazFlagSY, MazFlagSZ, MazFlagTA, MazFlagTC, MazFlagTD, MazFlagTF, MazFlagTG, MazFlagTH, MazFlagTJ, MazFlagTK, MazFlagTL, MazFlagTM, MazFlagTN, MazFlagTO, MazFlagTR, MazFlagTT, MazFlagTV, MazFlagTW, MazFlagTZ, MazFlagUA, MazFlagUG, MazFlagUM, MazFlagUS, MazFlagUY, MazFlagUZ, MazFlagVA, MazFlagVC, MazFlagVE, MazFlagVG, MazFlagVI, MazFlagVN, MazFlagVU, MazFlagWF, MazFlagWS, MazFlagXK, MazFlagYE, MazFlagYT, MazFlagZA, MazFlagZM, MazFlagZW
|
|
41
|
+
|
|
42
|
+
## Country flags (1x1) (256)
|
|
43
|
+
|
|
44
|
+
`MazFlagSquare` + ISO code (`MazFlagSquareFR`)
|
|
45
|
+
|
|
46
|
+
MazFlagSquareAC, MazFlagSquareAD, MazFlagSquareAE, MazFlagSquareAF, MazFlagSquareAG, MazFlagSquareAI, MazFlagSquareAL, MazFlagSquareAM, MazFlagSquareAO, MazFlagSquareAQ, MazFlagSquareAR, MazFlagSquareAS, MazFlagSquareAT, MazFlagSquareAU, MazFlagSquareAW, MazFlagSquareAX, MazFlagSquareAZ, MazFlagSquareBA, MazFlagSquareBB, MazFlagSquareBD, MazFlagSquareBE, MazFlagSquareBF, MazFlagSquareBG, MazFlagSquareBH, MazFlagSquareBI, MazFlagSquareBJ, MazFlagSquareBL, MazFlagSquareBM, MazFlagSquareBN, MazFlagSquareBO, MazFlagSquareBQ, MazFlagSquareBR, MazFlagSquareBS, MazFlagSquareBT, MazFlagSquareBV, MazFlagSquareBW, MazFlagSquareBY, MazFlagSquareBZ, MazFlagSquareCA, MazFlagSquareCC, MazFlagSquareCD, MazFlagSquareCF, MazFlagSquareCG, MazFlagSquareCH, MazFlagSquareCI, MazFlagSquareCK, MazFlagSquareCL, MazFlagSquareCM, MazFlagSquareCN, MazFlagSquareCO, MazFlagSquareCR, MazFlagSquareCU, MazFlagSquareCV, MazFlagSquareCW, MazFlagSquareCX, MazFlagSquareCY, MazFlagSquareCZ, MazFlagSquareDE, MazFlagSquareDJ, MazFlagSquareDK, MazFlagSquareDM, MazFlagSquareDO, MazFlagSquareDZ, MazFlagSquareEC, MazFlagSquareEE, MazFlagSquareEG, MazFlagSquareEH, MazFlagSquareER, MazFlagSquareES, MazFlagSquareET, MazFlagSquareEU, MazFlagSquareFI, MazFlagSquareFJ, MazFlagSquareFK, MazFlagSquareFM, MazFlagSquareFO, MazFlagSquareFR, MazFlagSquareGA, MazFlagSquareGB, MazFlagSquareGD, MazFlagSquareGE, MazFlagSquareGEAB, MazFlagSquareGEOS, MazFlagSquareGF, MazFlagSquareGG, MazFlagSquareGH, MazFlagSquareGI, MazFlagSquareGL, MazFlagSquareGM, MazFlagSquareGN, MazFlagSquareGP, MazFlagSquareGQ, MazFlagSquareGR, MazFlagSquareGS, MazFlagSquareGT, MazFlagSquareGU, MazFlagSquareGW, MazFlagSquareGY, MazFlagSquareHK, MazFlagSquareHM, MazFlagSquareHN, MazFlagSquareHR, MazFlagSquareHT, MazFlagSquareHU, MazFlagSquareIC, MazFlagSquareID, MazFlagSquareIE, MazFlagSquareIL, MazFlagSquareIM, MazFlagSquareIN, MazFlagSquareIO, MazFlagSquareIQ, MazFlagSquareIR, MazFlagSquareIS, MazFlagSquareIT, MazFlagSquareJE, MazFlagSquareJM, MazFlagSquareJO, MazFlagSquareJP, MazFlagSquareKE, MazFlagSquareKG, MazFlagSquareKH, MazFlagSquareKI, MazFlagSquareKM, MazFlagSquareKN, MazFlagSquareKP, MazFlagSquareKR, MazFlagSquareKW, MazFlagSquareKY, MazFlagSquareKZ, MazFlagSquareLA, MazFlagSquareLB, MazFlagSquareLC, MazFlagSquareLI, MazFlagSquareLK, MazFlagSquareLR, MazFlagSquareLS, MazFlagSquareLT, MazFlagSquareLU, MazFlagSquareLV, MazFlagSquareLY, MazFlagSquareMA, MazFlagSquareMC, MazFlagSquareMD, MazFlagSquareME, MazFlagSquareMF, MazFlagSquareMG, MazFlagSquareMH, MazFlagSquareMK, MazFlagSquareML, MazFlagSquareMM, MazFlagSquareMN, MazFlagSquareMO, MazFlagSquareMP, MazFlagSquareMQ, MazFlagSquareMR, MazFlagSquareMS, MazFlagSquareMT, MazFlagSquareMU, MazFlagSquareMV, MazFlagSquareMW, MazFlagSquareMX, MazFlagSquareMY, MazFlagSquareMZ, MazFlagSquareNA, MazFlagSquareNC, MazFlagSquareNE, MazFlagSquareNF, MazFlagSquareNG, MazFlagSquareNI, MazFlagSquareNL, MazFlagSquareNO, MazFlagSquareNP, MazFlagSquareNR, MazFlagSquareNU, MazFlagSquareNZ, MazFlagSquareOM, MazFlagSquarePA, MazFlagSquarePE, MazFlagSquarePF, MazFlagSquarePG, MazFlagSquarePH, MazFlagSquarePK, MazFlagSquarePL, MazFlagSquarePM, MazFlagSquarePN, MazFlagSquarePR, MazFlagSquarePS, MazFlagSquarePT, MazFlagSquarePW, MazFlagSquarePY, MazFlagSquareQA, MazFlagSquareRE, MazFlagSquareRO, MazFlagSquareRS, MazFlagSquareRU, MazFlagSquareRW, MazFlagSquareSA, MazFlagSquareSB, MazFlagSquareSC, MazFlagSquareSD, MazFlagSquareSE, MazFlagSquareSG, MazFlagSquareSH, MazFlagSquareSI, MazFlagSquareSJ, MazFlagSquareSK, MazFlagSquareSL, MazFlagSquareSM, MazFlagSquareSN, MazFlagSquareSO, MazFlagSquareSR, MazFlagSquareSS, MazFlagSquareST, MazFlagSquareSV, MazFlagSquareSX, MazFlagSquareSY, MazFlagSquareSZ, MazFlagSquareTA, MazFlagSquareTC, MazFlagSquareTD, MazFlagSquareTF, MazFlagSquareTG, MazFlagSquareTH, MazFlagSquareTJ, MazFlagSquareTK, MazFlagSquareTL, MazFlagSquareTM, MazFlagSquareTN, MazFlagSquareTO, MazFlagSquareTR, MazFlagSquareTT, MazFlagSquareTV, MazFlagSquareTW, MazFlagSquareTZ, MazFlagSquareUA, MazFlagSquareUG, MazFlagSquareUM, MazFlagSquareUS, MazFlagSquareUY, MazFlagSquareUZ, MazFlagSquareVA, MazFlagSquareVC, MazFlagSquareVE, MazFlagSquareVG, MazFlagSquareVI, MazFlagSquareVN, MazFlagSquareVU, MazFlagSquareWF, MazFlagSquareWS, MazFlagSquareXK, MazFlagSquareYE, MazFlagSquareYT, MazFlagSquareZA, MazFlagSquareZM, MazFlagSquareZW
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# Tailwind CSS theme reference
|
|
2
|
+
|
|
3
|
+
> Every Tailwind utility, variant and CSS variable provided by the maz-ui 5.0.1-beta.0 theme. Generated from the `maz-ui/tailwindcss/*.css` sources: it is always in sync with the installed version.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```css
|
|
8
|
+
/* your Tailwind entry, e.g. app/assets/css/main.css */
|
|
9
|
+
@import 'tailwindcss';
|
|
10
|
+
@import 'maz-ui/tailwindcss/theme.css';
|
|
11
|
+
@import 'maz-ui/tailwindcss/utilities.css';
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
- Use the classes **without prefix**: `bg-primary`, `rounded-md`, `tab-m:flex`. The `maz:` prefix you may see in the library sources is internal to maz-ui and does not exist in your project.
|
|
15
|
+
- Every value is a runtime CSS variable driven by the active `@maz-ui/themes` preset: switching preset or color mode restyles every utility without rebuild.
|
|
16
|
+
- See `guide/tailwind.md` to extend the theme (custom colors, fonts, animations, variants).
|
|
17
|
+
|
|
18
|
+
### Entry points
|
|
19
|
+
|
|
20
|
+
| Import | Content |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| `maz-ui/tailwindcss/theme.css` | Every theme token (colors, spacing, radius, breakpoints, shadows, z-index, typography, component surfaces, dark variant) |
|
|
23
|
+
| `maz-ui/tailwindcss/utilities.css` | maz-ui custom utilities (flex-center, padded-container, cap-f, disabled-*...) |
|
|
24
|
+
| `maz-ui/tailwindcss/theme-colors.css` | Colors only |
|
|
25
|
+
| `maz-ui/tailwindcss/theme-spacing.css` | Spacing scale only |
|
|
26
|
+
| `maz-ui/tailwindcss/theme-radius.css` | Border radius only |
|
|
27
|
+
| `maz-ui/tailwindcss/theme-breakpoints.css` | Breakpoints only |
|
|
28
|
+
| `maz-ui/tailwindcss/theme-shadows.css` | Shadows only |
|
|
29
|
+
| `maz-ui/tailwindcss/theme-z-index.css` | z-index scale only |
|
|
30
|
+
| `maz-ui/tailwindcss/theme-typography.css` | Fonts, border width, durations and easings only |
|
|
31
|
+
| `maz-ui/tailwindcss/theme-components.css` | bg-container and bg-input surfaces only |
|
|
32
|
+
| `maz-ui/tailwindcss/theme-variants.css` | `dark:` variant wired to the `.dark` class only |
|
|
33
|
+
|
|
34
|
+
## Colors
|
|
35
|
+
|
|
36
|
+
Each color works with every color utility (bg-, text-, border-, ring-, outline-, fill-, stroke-, divide-, from-, via-, to-, decoration-, placeholder-, accent-, caret-, shadow-) and with opacity modifiers (`bg-primary/50`). Colors are light/dark aware (`light-dark()`): **do not add `dark:` overrides for theme colors**.
|
|
37
|
+
|
|
38
|
+
| Color | Utilities | Foreground | Scale | CSS variable | Use for |
|
|
39
|
+
| --- | --- | --- | --- | --- | --- |
|
|
40
|
+
| `primary` | `bg-primary` `text-primary` `border-primary` | `text-primary-foreground` | `-50` to `-950` | `--maz-primary` | Brand primary: main actions, links, focus |
|
|
41
|
+
| `secondary` | `bg-secondary` `text-secondary` `border-secondary` | `text-secondary-foreground` | `-50` to `-950` | `--maz-secondary` | Brand secondary |
|
|
42
|
+
| `accent` | `bg-accent` `text-accent` `border-accent` | `text-accent-foreground` | `-50` to `-950` | `--maz-accent` | Brand accent, highlights |
|
|
43
|
+
| `destructive` | `bg-destructive` `text-destructive` `border-destructive` | `text-destructive-foreground` | `-50` to `-950` | `--maz-destructive` | Error / danger state, destructive actions |
|
|
44
|
+
| `success` | `bg-success` `text-success` `border-success` | `text-success-foreground` | `-50` to `-950` | `--maz-success` | Success state |
|
|
45
|
+
| `warning` | `bg-warning` `text-warning` `border-warning` | `text-warning-foreground` | `-50` to `-950` | `--maz-warning` | Warning state |
|
|
46
|
+
| `info` | `bg-info` `text-info` `border-info` | `text-info-foreground` | `-50` to `-950` | `--maz-info` | Informational state |
|
|
47
|
+
| `contrast` | `bg-contrast` `text-contrast` `border-contrast` | `text-contrast-foreground` | `-50` to `-950` | `--maz-contrast` | Neutral high-contrast color (near black in light mode, near white in dark mode) |
|
|
48
|
+
| `surface` | `bg-surface` `text-surface` `border-surface` | - | `-50` to `-950` | `--maz-surface` | Page and container backgrounds |
|
|
49
|
+
| `foreground` | `bg-foreground` `text-foreground` `border-foreground` | - | `-50` to `-950` | `--maz-foreground` | Body text |
|
|
50
|
+
| `divider` | `bg-divider` `text-divider` `border-divider` | - | `-50` to `-950` | `--maz-divider` | Borders and separators |
|
|
51
|
+
| `shadow` | `shadow-shadow/20` `bg-shadow` | - | `-50` to `-950` | `--maz-shadow` | Shadow tint (used by the shadow-* utilities) |
|
|
52
|
+
| `overlay` | `bg-overlay` `bg-overlay/60` | - | `-50` to `-950` | `--maz-overlay` | Backdrops and scrims behind dialogs |
|
|
53
|
+
| `muted` | `bg-muted` `text-muted` `border-muted` | - | `-50` to `-950` | `--maz-muted` | Secondary text, placeholders, disabled content |
|
|
54
|
+
| `container` | `bg-container` | - | - | `--maz-container-bg` | Background of MazCard, MazContainer, MazDialog, MazPopover, MazDrawer... (follows the preset `components.container`) |
|
|
55
|
+
| `input` | `bg-input` | - | - | `--maz-input-bg` | Background of MazInput, MazSelect, MazTextarea, MazCheckbox... (follows the preset `components.input`) |
|
|
56
|
+
|
|
57
|
+
- `-foreground` is the readable text color on top of the base color: `bg-primary text-primary-foreground`.
|
|
58
|
+
- Scales go from light (`-50`) to dark (`-950`), `-500` is the base color. They are derived from the base color in OKLCh, so they follow the preset.
|
|
59
|
+
- Never use the Tailwind default palette (`bg-blue-500`, `text-gray-600`, `bg-white`, `text-black`) nor hard-coded colors (`#fff`, `rgb()`): pick the matching theme color (`bg-surface`, `text-foreground`, `text-muted`, `border-divider`, `bg-primary`...).
|
|
60
|
+
|
|
61
|
+
## Border radius
|
|
62
|
+
|
|
63
|
+
| Utility | Value |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| `rounded-xs` | `var(--maz-rounded-xs)` |
|
|
66
|
+
| `rounded-sm` | `var(--maz-rounded-sm)` |
|
|
67
|
+
| `rounded-md` | `var(--maz-rounded-md)` |
|
|
68
|
+
| `rounded-lg` | `var(--maz-rounded-lg)` |
|
|
69
|
+
| `rounded-xl` | `var(--maz-rounded-xl)` |
|
|
70
|
+
| `rounded-2xl` | `var(--maz-rounded-2xl)` |
|
|
71
|
+
| `rounded-3xl` | `var(--maz-rounded-3xl)` |
|
|
72
|
+
| `rounded` | `var(--maz-rounded-md)` |
|
|
73
|
+
|
|
74
|
+
`rounded-full` and `rounded-none` keep their Tailwind values.
|
|
75
|
+
|
|
76
|
+
## Shadows
|
|
77
|
+
|
|
78
|
+
| Utility | Value |
|
|
79
|
+
| --- | --- |
|
|
80
|
+
| `shadow-xs` | `0 1px 2px 0 color-mix(in srgb, var(--color-elevation) 5%, transparent)` |
|
|
81
|
+
| `shadow-sm` | `var(--maz-shadow-style-sm)` |
|
|
82
|
+
| `shadow-md` | `var(--maz-shadow-style-md)` |
|
|
83
|
+
| `shadow-lg` | `var(--maz-shadow-style-lg)` |
|
|
84
|
+
| `shadow-xl` | `var(--maz-shadow-style-xl)` |
|
|
85
|
+
| `shadow-elevation` | `var(--maz-shadow-style-elevation)` |
|
|
86
|
+
|
|
87
|
+
Use `shadow-elevation` for raised surfaces (cards, popovers, menus).
|
|
88
|
+
|
|
89
|
+
## Spacing
|
|
90
|
+
|
|
91
|
+
`--spacing` is `var(--maz-space)` (`0.25rem` by default): every spacing utility (`p-4`, `gap-2`, `mt-6`, `w-10`, `inset-1`...) is a multiple of the preset `space` token. Use the scale, avoid arbitrary values like `p-[13px]`.
|
|
92
|
+
|
|
93
|
+
## Breakpoints
|
|
94
|
+
|
|
95
|
+
Mobile-first `min-width` variants, added on top of the Tailwind defaults (`sm:` to `2xl:` still work). Prefix them with `max-` for max-width queries (`max-tab-m:hidden`).
|
|
96
|
+
|
|
97
|
+
| Variant | Min width |
|
|
98
|
+
| --- | --- |
|
|
99
|
+
| `mob-s:` | 320px |
|
|
100
|
+
| `mob-m:` | 425px |
|
|
101
|
+
| `mob-l:` | 576px |
|
|
102
|
+
| `tab-s:` | 640px |
|
|
103
|
+
| `tab-m:` | 768px |
|
|
104
|
+
| `tab-l:` | 992px |
|
|
105
|
+
| `lap-s:` | 1024px |
|
|
106
|
+
| `lap-m:` | 1280px |
|
|
107
|
+
| `lap-l:` | 1366px |
|
|
108
|
+
| `lap-xl:` | 1440px |
|
|
109
|
+
| `lap-2xl:` | 1680px |
|
|
110
|
+
| `lap-3xl:` | 1920px |
|
|
111
|
+
|
|
112
|
+
In TypeScript: `import { screens } from 'maz-ui/tailwindcss'`, or the `useBreakpoints` composable.
|
|
113
|
+
|
|
114
|
+
## Typography and motion
|
|
115
|
+
|
|
116
|
+
| Utility | Value |
|
|
117
|
+
| --- | --- |
|
|
118
|
+
| `font-sans` | `var(--maz-font-family)` |
|
|
119
|
+
| `font-mono` | `var(--maz-font-mono-stack)` |
|
|
120
|
+
| `font-display` | `var(--maz-font-display-stack)` |
|
|
121
|
+
| `duration-(--duration-fast)` | `var(--maz-motion-fast, 100ms)` |
|
|
122
|
+
| `duration-(--duration-normal)` | `var(--maz-motion-normal, 200ms)` |
|
|
123
|
+
| `duration-(--duration-slow)` | `var(--maz-motion-slow, 300ms)` |
|
|
124
|
+
| `ease-out` | `var(--maz-easing-out, cubic-bezier(0.4, 0, 0.2, 1))` |
|
|
125
|
+
| `ease-in` | `var(--maz-easing-in, cubic-bezier(0.4, 0, 1, 1))` |
|
|
126
|
+
| `ease-in-out` | `var(--maz-easing-in-out, cubic-bezier(0.4, 0, 0.2, 1))` |
|
|
127
|
+
|
|
128
|
+
- The default border width and the default transition duration and easing also follow the preset.
|
|
129
|
+
- Durations are theme variables, use them with the arbitrary syntax: `transition-colors duration-(--duration-fast)`.
|
|
130
|
+
|
|
131
|
+
## z-index
|
|
132
|
+
|
|
133
|
+
| Utility | Value |
|
|
134
|
+
| --- | --- |
|
|
135
|
+
| `z-1` | `1` |
|
|
136
|
+
| `z-2` | `2` |
|
|
137
|
+
| `z-3` | `3` |
|
|
138
|
+
| `z-4` | `4` |
|
|
139
|
+
| `z-5` | `5` |
|
|
140
|
+
| `z-15` | `15` |
|
|
141
|
+
| `z-25` | `25` |
|
|
142
|
+
| `z-35` | `35` |
|
|
143
|
+
| `z-45` | `45` |
|
|
144
|
+
| `z-75` | `75` |
|
|
145
|
+
| `z-100` | `100` |
|
|
146
|
+
| `z-default-backdrop` | `1050` |
|
|
147
|
+
|
|
148
|
+
## Custom utilities
|
|
149
|
+
|
|
150
|
+
From `maz-ui/tailwindcss/utilities.css`:
|
|
151
|
+
|
|
152
|
+
| Utility | CSS |
|
|
153
|
+
| --- | --- |
|
|
154
|
+
| `flex-center` | `align-items: center; justify-content: center;` |
|
|
155
|
+
| `z-default-backdrop` | `z-index: 1050;` |
|
|
156
|
+
| `padded-container-no-p` | `inline-size: 100%; padding-inline: calc(50% - var(--maz-container-max-width) / 2);` |
|
|
157
|
+
| `padded-container` | `inline-size: 100%; padding-inline: var(--maz-container-padding);` |
|
|
158
|
+
| `cap-f` | `&::first-letter { text-transform: capitalize; }` |
|
|
159
|
+
| `disabled-cursor` | `cursor: var(--maz-disabled-cursor);` |
|
|
160
|
+
| `disabled-opacity` | `opacity: var(--maz-disabled-opacity);` |
|
|
161
|
+
| `disabled-state` | `cursor: var(--maz-disabled-cursor); opacity: var(--maz-disabled-opacity);` |
|
|
162
|
+
|
|
163
|
+
## Variants
|
|
164
|
+
|
|
165
|
+
| Variant | Selector |
|
|
166
|
+
| --- | --- |
|
|
167
|
+
| `dark:` | `&:where(.dark, .dark *)` |
|
|
168
|
+
|
|
169
|
+
`dark:` matches the `.dark` class toggled by `useTheme()` (`darkModeStrategy: 'class'`, the default). Theme colors already adapt to dark mode: keep `dark:` for real layout or content differences.
|
|
170
|
+
|
|
171
|
+
## Layout variables
|
|
172
|
+
|
|
173
|
+
Override them in your CSS (`:root { --maz-container-max-width: 1024px; }`), they drive the `padded-container` utilities:
|
|
174
|
+
|
|
175
|
+
| Variable | Default |
|
|
176
|
+
| --- | --- |
|
|
177
|
+
| `--maz-container-padding-mobile` | `1rem` |
|
|
178
|
+
| `--maz-container-padding-tablet` | `2rem` |
|
|
179
|
+
| `--maz-container-padding-desktop` | `2.5rem` |
|
|
180
|
+
| `--maz-container-padding-value` | `var(--maz-container-padding-mobile)` |
|
|
181
|
+
| `--maz-container-width` | `calc(100% - var(--maz-container-padding-value) * 2)` |
|
|
182
|
+
| `--maz-container-padding` | `calc(50% - var(--maz-container-width) / 2)` |
|
|
183
|
+
| `--maz-container-max-width` | `1440px` |
|
|
184
|
+
|
|
185
|
+
## Vue transitions
|
|
186
|
+
|
|
187
|
+
Transition names shipped in `maz-ui/style.css`, usable with `<Transition name="...">`: `maz-expand`, `maz-scale`, `maz-scale-fade`, `maz-scale-loading`, `maz-slide`, `maz-slideinvert`, `maz-slidevnext`, `maz-slidevprev`, `maz-tags`, `maz-tags-invert`.
|
|
188
|
+
|
|
189
|
+
## CSS variables in custom CSS
|
|
190
|
+
|
|
191
|
+
In `<style>` blocks or plain CSS, use the runtime variables instead of literal values: `var(--maz-primary)`, `var(--maz-surface)`, `var(--maz-foreground)`, `var(--maz-divider)`, `var(--maz-rounded-md)`, `var(--maz-shadow-style-elevation)`, `calc(var(--maz-space) * 4)`, `var(--maz-font-family)`, `var(--maz-easing-out)`. With Tailwind, prefer `@apply` after `@reference "<your tailwind entry>"` in Vue SFC style blocks.
|
package/docs/rules.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "maz-ui rules for AI agents"
|
|
3
|
+
description: "How to use maz-ui and its ecosystem in this project: look-up workflow, components, icons, helpers, Tailwind theme tokens, imports."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# maz-ui rules for AI agents
|
|
7
|
+
|
|
8
|
+
> maz-ui 5.0.1-beta.0 is installed: these rules and the docs in `node_modules/maz-ui/docs` match this version.
|
|
9
|
+
|
|
10
|
+
This project is built with **maz-ui** and its ecosystem (`@maz-ui/themes`, `@maz-ui/icons`, `@maz-ui/utils`, `@maz-ui/translations`, `@maz-ui/nuxt`). Reuse what it provides instead of re-implementing it: most UI elements, helpers, icons and styles you need already exist.
|
|
11
|
+
|
|
12
|
+
### Look it up before you write it
|
|
13
|
+
|
|
14
|
+
Before creating a component, composable, helper, icon or style, check what maz-ui offers:
|
|
15
|
+
|
|
16
|
+
- **MCP server `maz-ui`** (when available): `search_docs` (describe the need: "confirm before delete", "phone input"), `get_component_api` (exact props, events, slots), `find_icons`, `get_theme_tokens` (Tailwind classes), `get_doc`, `review_code`.
|
|
17
|
+
- **Version-matched docs** in `node_modules/maz-ui/docs/` (start with `README.md`; in a monorepo, resolve `maz-ui` from the app package). Read the relevant page before using an API.
|
|
18
|
+
|
|
19
|
+
Never guess an API: only use props, events, slots and imports that are documented.
|
|
20
|
+
|
|
21
|
+
### Components
|
|
22
|
+
|
|
23
|
+
- Use `Maz*` components instead of native elements or hand-made widgets: `MazBtn` (not `<button>`), `MazInput`, `MazSelect`, `MazCheckbox`, `MazSwitch`, `MazTextarea`, `MazDialog`, `MazDialogConfirm`, `MazDrawer`, `MazBottomSheet`, `MazPopover`, `MazDropdown`, `MazTabs`, `MazTable`, `MazCard`, `MazAvatar`, `MazBadge`, `MazAlert`, `MazSkeleton`, `MazSpinner`, `MazDatePicker`, `MazInputPhoneNumber`, `MazDropzone`, `MazStepper`, `MazSidebar`, `MazPagination`...
|
|
24
|
+
- Prop values are typed: colors are `primary | secondary | accent | info | success | warning | destructive | contrast | transparent` (plus `surface` on some components), sizes `mini | xs | sm | md | lg | xl`.
|
|
25
|
+
- Feedback and overlays: `useToast()` for notifications, `useDialog()` or `MazDialogConfirm` for confirmations, `useWait()` for loading states.
|
|
26
|
+
- Forms: `useFormValidator` / `useFormField` with your Standard Schema library (Zod, Valibot, ArkType).
|
|
27
|
+
|
|
28
|
+
### Icons
|
|
29
|
+
|
|
30
|
+
Use `@maz-ui/icons` (860+ icons: `MazTrash`, `MazXMark`, `MazMagnifyingGlass`, `MazFlagFR`, `MazLogoVue`...). Never inline SVG or add another icon library. Pass icon components to icon props: `<MazBtn :start-icon="MazTrash">`.
|
|
31
|
+
|
|
32
|
+
### Helpers and composables
|
|
33
|
+
|
|
34
|
+
Use `@maz-ui/utils` and maz-ui composables instead of lodash, VueUse or hand-written code: `debounce`, `throttle`, `sleep`, `isEqual`, `capitalize`, `formatCurrency`, `formatDate`, `formatNumber`, `formatPhoneNumber`, `getCookie`/`setCookie`, `useBreakpoints`, `useWindowSize`, `useTimer`, `useIdleTimeout`, `useSwipe`, `vClickOutside`, `vTooltip`, `vLazyImg`...
|
|
35
|
+
|
|
36
|
+
### Styling with Tailwind
|
|
37
|
+
|
|
38
|
+
The maz-ui theme is exposed to Tailwind (`@import 'maz-ui/tailwindcss/theme.css'`). Only use its tokens:
|
|
39
|
+
|
|
40
|
+
- Colors: `primary`, `secondary`, `accent`, `info`, `success`, `warning`, `destructive`, `contrast` (each with `-foreground` and `-50` to `-950`), `surface`, `foreground`, `muted`, `divider`, `overlay`, plus `bg-container` and `bg-input`. Example: `bg-surface text-foreground border-divider`, `bg-primary text-primary-foreground`, `text-muted`.
|
|
41
|
+
- Never use the default Tailwind palette (`bg-blue-500`, `text-gray-600`, `bg-white`, `text-black`) nor hard-coded colors (`#fff`, `rgb()`, `bg-[#...]`). Theme colors already adapt to dark mode: do not add `dark:` color overrides.
|
|
42
|
+
- Radius `rounded-*`, shadows `shadow-sm` to `shadow-xl` and `shadow-elevation`, spacing scale (`p-4`, `gap-2`), breakpoints `mob-*`, `tab-*`, `lap-*` (plus `sm` to `2xl`), utilities `flex-center`, `padded-container`.
|
|
43
|
+
- **No `maz:` prefix** in this project: it is internal to the maz-ui library and its documentation.
|
|
44
|
+
- In custom CSS, use the variables: `var(--maz-primary)`, `var(--maz-rounded-md)`, `calc(var(--maz-space) * 4)`.
|
|
45
|
+
|
|
46
|
+
### Theme
|
|
47
|
+
|
|
48
|
+
Brand colors, fonts, radius and spacing come from a `@maz-ui/themes` preset (`definePreset`), not from overrides scattered in CSS. Use `useTheme()` for dark mode and presets (`toggleDarkMode`, `setColorMode`, `updateTheme`), never toggle the `dark` class or store the mode yourself.
|
|
49
|
+
|
|
50
|
+
### Imports
|
|
51
|
+
|
|
52
|
+
- Deep imports: `maz-ui/components/MazBtn`, `maz-ui/composables/useToast`, `maz-ui/directives/vTooltip`, `@maz-ui/utils/helpers/debounce`, `@maz-ui/icons/static/MazTrash`. The `maz-ui` root entry only exports types. Never import from `maz-ui/src` or `maz-ui/dist`.
|
|
53
|
+
- With `@maz-ui/nuxt`, components and composables are auto-imported: do not import them.
|
|
54
|
+
|
|
55
|
+
### Before you finish
|
|
56
|
+
|
|
57
|
+
Run `review_code` (MCP) on the files you changed, or `npx @maz-ui/mcp review <files>`, and fix every finding.
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@maz-ui/mcp",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "5.0.0",
|
|
5
|
-
"description": "
|
|
4
|
+
"version": "5.1.0-beta.0",
|
|
5
|
+
"description": "MCP server and CLI that give AI coding agents the version-matched knowledge of maz-ui and its ecosystem: search, component APIs, icons, Tailwind theme tokens, setup guides and code review",
|
|
6
6
|
"author": "Louis Mazel <me@loicmazuel.com>",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"repository": {
|
|
@@ -12,8 +12,16 @@
|
|
|
12
12
|
"bugs": "https://github.com/LouisMazel/maz-ui/issues",
|
|
13
13
|
"keywords": [
|
|
14
14
|
"maz-ui",
|
|
15
|
-
"
|
|
16
|
-
"
|
|
15
|
+
"mcp",
|
|
16
|
+
"model-context-protocol",
|
|
17
|
+
"ai",
|
|
18
|
+
"agents",
|
|
19
|
+
"claude",
|
|
20
|
+
"cursor",
|
|
21
|
+
"copilot",
|
|
22
|
+
"vue",
|
|
23
|
+
"nuxt",
|
|
24
|
+
"tailwindcss"
|
|
17
25
|
],
|
|
18
26
|
"sideEffects": false,
|
|
19
27
|
"publishConfig": {
|
|
@@ -21,15 +29,14 @@
|
|
|
21
29
|
},
|
|
22
30
|
"exports": {
|
|
23
31
|
".": {
|
|
24
|
-
"types": "./dist/
|
|
25
|
-
"import": "./dist/
|
|
26
|
-
"
|
|
27
|
-
"default": "./dist/mcp.mjs"
|
|
32
|
+
"types": "./dist/index.d.mts",
|
|
33
|
+
"import": "./dist/index.mjs",
|
|
34
|
+
"default": "./dist/index.mjs"
|
|
28
35
|
}
|
|
29
36
|
},
|
|
30
|
-
"main": "./dist/
|
|
31
|
-
"module": "./dist/
|
|
32
|
-
"types": "./dist/
|
|
37
|
+
"main": "./dist/index.mjs",
|
|
38
|
+
"module": "./dist/index.mjs",
|
|
39
|
+
"types": "./dist/index.d.mts",
|
|
33
40
|
"bin": {
|
|
34
41
|
"maz-ui-mcp": "./bin/maz-ui-mcp.mjs"
|
|
35
42
|
},
|
|
@@ -44,32 +51,87 @@
|
|
|
44
51
|
"node": ">=22.12.0"
|
|
45
52
|
},
|
|
46
53
|
"dependencies": {
|
|
54
|
+
"@maz-ui/node": "5.1.0-beta.0",
|
|
47
55
|
"@maz-ui/utils": "5.0.0",
|
|
48
56
|
"@modelcontextprotocol/sdk": "^1.32.1",
|
|
49
|
-
"
|
|
57
|
+
"@vue/compiler-dom": "^3.5.44",
|
|
58
|
+
"minisearch": "^7.2.0",
|
|
59
|
+
"tinyglobby": "^0.2.17",
|
|
60
|
+
"zod": "^4.6.7"
|
|
50
61
|
},
|
|
51
62
|
"devDependencies": {
|
|
52
63
|
"@maz-ui/eslint-config": "5.0.0",
|
|
53
|
-
"@maz-ui/node": "5.0.0",
|
|
54
64
|
"@modelcontextprotocol/inspector": "^2.11.0",
|
|
55
|
-
"
|
|
56
|
-
"prettier": "^3.9.10",
|
|
57
|
-
"ts-node-maintained": "^10.9.6",
|
|
65
|
+
"agent-docs": "5.0.0",
|
|
58
66
|
"tsx": "^4.23.15",
|
|
59
67
|
"unbuild": "^3.6.1"
|
|
60
68
|
},
|
|
61
69
|
"lint-staged": {
|
|
62
70
|
"*.{js,ts,mjs,mts,cjs,md,yml,json}": "cross-env NODE_ENV=production eslint --fix"
|
|
63
71
|
},
|
|
72
|
+
"nx": {
|
|
73
|
+
"targets": {
|
|
74
|
+
"build": {
|
|
75
|
+
"inputs": [
|
|
76
|
+
"production",
|
|
77
|
+
"^production",
|
|
78
|
+
"{workspaceRoot}/apps/docs/src/**/*.md",
|
|
79
|
+
"{workspaceRoot}/apps/docs/.vitepress/mixins/**/*",
|
|
80
|
+
"{workspaceRoot}/tools/agent-docs/src/**/*",
|
|
81
|
+
"{workspaceRoot}/tools/agent-docs/content/**/*",
|
|
82
|
+
"{workspaceRoot}/packages/lib/src/**/*",
|
|
83
|
+
"{workspaceRoot}/packages/icons/src/icon-list.ts",
|
|
84
|
+
"{workspaceRoot}/packages/nuxt/src/module.ts",
|
|
85
|
+
"{workspaceRoot}/packages/utils/src/**/*",
|
|
86
|
+
"{workspaceRoot}/packages/node/src/**/*"
|
|
87
|
+
],
|
|
88
|
+
"outputs": [
|
|
89
|
+
"{projectRoot}/dist",
|
|
90
|
+
"{projectRoot}/docs"
|
|
91
|
+
]
|
|
92
|
+
},
|
|
93
|
+
"test:unit": {
|
|
94
|
+
"inputs": [
|
|
95
|
+
"default",
|
|
96
|
+
"^production",
|
|
97
|
+
"{workspaceRoot}/apps/docs/src/**/*.md",
|
|
98
|
+
"{workspaceRoot}/apps/docs/.vitepress/mixins/**/*",
|
|
99
|
+
"{workspaceRoot}/tools/agent-docs/src/**/*",
|
|
100
|
+
"{workspaceRoot}/tools/agent-docs/content/**/*",
|
|
101
|
+
"{workspaceRoot}/packages/lib/src/**/*",
|
|
102
|
+
"{workspaceRoot}/packages/icons/src/icon-list.ts",
|
|
103
|
+
"{workspaceRoot}/packages/nuxt/src/module.ts",
|
|
104
|
+
"{workspaceRoot}/packages/utils/src/**/*",
|
|
105
|
+
"{workspaceRoot}/packages/node/src/**/*"
|
|
106
|
+
]
|
|
107
|
+
},
|
|
108
|
+
"test:unit:coverage": {
|
|
109
|
+
"inputs": [
|
|
110
|
+
"default",
|
|
111
|
+
"^production",
|
|
112
|
+
"{workspaceRoot}/apps/docs/src/**/*.md",
|
|
113
|
+
"{workspaceRoot}/apps/docs/.vitepress/mixins/**/*",
|
|
114
|
+
"{workspaceRoot}/tools/agent-docs/src/**/*",
|
|
115
|
+
"{workspaceRoot}/tools/agent-docs/content/**/*",
|
|
116
|
+
"{workspaceRoot}/packages/lib/src/**/*",
|
|
117
|
+
"{workspaceRoot}/packages/icons/src/icon-list.ts",
|
|
118
|
+
"{workspaceRoot}/packages/nuxt/src/module.ts",
|
|
119
|
+
"{workspaceRoot}/packages/utils/src/**/*",
|
|
120
|
+
"{workspaceRoot}/packages/node/src/**/*"
|
|
121
|
+
],
|
|
122
|
+
"outputs": [
|
|
123
|
+
"{projectRoot}/coverage"
|
|
124
|
+
]
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
64
128
|
"scripts": {
|
|
65
|
-
"generate:docs": "
|
|
66
|
-
"copy-docs": "tsx scripts/copy-docs.ts",
|
|
67
|
-
"generate:components-docs": "pnpm -F cli cli generate-components-docs",
|
|
129
|
+
"generate:docs": "tsx ../../tools/agent-docs/src/cli.ts --out ./docs",
|
|
68
130
|
"build": "pnpm generate:docs && unbuild",
|
|
69
131
|
"build:watch": "pnpm generate:docs && unbuild --watch",
|
|
70
|
-
"dev": "tsx
|
|
71
|
-
"dev:inspector": "mcp-inspector",
|
|
72
|
-
"preview": "node
|
|
132
|
+
"dev": "tsx scripts/dev.ts",
|
|
133
|
+
"dev:inspector": "mcp-inspector tsx scripts/dev.ts",
|
|
134
|
+
"preview": "node bin/maz-ui-mcp.mjs",
|
|
73
135
|
"lint": "cross-env NODE_ENV=production eslint .",
|
|
74
136
|
"lint:fix": "pnpm lint --fix",
|
|
75
137
|
"typecheck": "tsc --noEmit",
|
package/dist/mcp.d.mts
DELETED
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
interface SectionMetadata {
|
|
3
|
-
title: string;
|
|
4
|
-
level: number;
|
|
5
|
-
content: string;
|
|
6
|
-
}
|
|
7
|
-
interface DocumentMetadata {
|
|
8
|
-
name: string;
|
|
9
|
-
displayName: string;
|
|
10
|
-
type: string;
|
|
11
|
-
description: string;
|
|
12
|
-
tags: string[];
|
|
13
|
-
props?: string[];
|
|
14
|
-
slots?: string[];
|
|
15
|
-
events?: string[];
|
|
16
|
-
sections: SectionMetadata[];
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
type DocumentType = 'component' | 'guide' | 'composable' | 'directive' | 'plugin' | 'util' | 'node';
|
|
20
|
-
interface Document {
|
|
21
|
-
name: string;
|
|
22
|
-
type: DocumentType;
|
|
23
|
-
content: string;
|
|
24
|
-
metadata: DocumentMetadata;
|
|
25
|
-
}
|
|
26
|
-
interface DocumentationDiagnostics {
|
|
27
|
-
components: {
|
|
28
|
-
total: number;
|
|
29
|
-
withManualDoc: number;
|
|
30
|
-
withGeneratedDoc: number;
|
|
31
|
-
withBothDocs: number;
|
|
32
|
-
};
|
|
33
|
-
guides: {
|
|
34
|
-
total: number;
|
|
35
|
-
list: string[];
|
|
36
|
-
};
|
|
37
|
-
composables: {
|
|
38
|
-
total: number;
|
|
39
|
-
list: string[];
|
|
40
|
-
};
|
|
41
|
-
directives: {
|
|
42
|
-
total: number;
|
|
43
|
-
list: string[];
|
|
44
|
-
};
|
|
45
|
-
plugins: {
|
|
46
|
-
total: number;
|
|
47
|
-
list: string[];
|
|
48
|
-
};
|
|
49
|
-
utils: {
|
|
50
|
-
total: number;
|
|
51
|
-
list: string[];
|
|
52
|
-
};
|
|
53
|
-
node: {
|
|
54
|
-
total: number;
|
|
55
|
-
list: string[];
|
|
56
|
-
};
|
|
57
|
-
paths: {
|
|
58
|
-
docsRoot: string;
|
|
59
|
-
componentsDir: string;
|
|
60
|
-
generatedDocsDir: string;
|
|
61
|
-
guidesDir: string;
|
|
62
|
-
composablesDir: string;
|
|
63
|
-
directivesDir: string;
|
|
64
|
-
pluginsDir: string;
|
|
65
|
-
ecosystemDir: string;
|
|
66
|
-
utilsDir: string;
|
|
67
|
-
nodeDir: string;
|
|
68
|
-
iconsDir: string;
|
|
69
|
-
};
|
|
70
|
-
}
|
|
71
|
-
declare class DocumentationService {
|
|
72
|
-
private readonly docsRoot;
|
|
73
|
-
private readonly componentsDir;
|
|
74
|
-
private readonly generatedDocsDir;
|
|
75
|
-
private readonly guidesDir;
|
|
76
|
-
private readonly composablesDir;
|
|
77
|
-
private readonly directivesDir;
|
|
78
|
-
private readonly pluginsDir;
|
|
79
|
-
private readonly ecosystemDir;
|
|
80
|
-
private readonly utilsDir;
|
|
81
|
-
private readonly utilsTypesDir;
|
|
82
|
-
private readonly nodeDir;
|
|
83
|
-
private readonly iconsDir;
|
|
84
|
-
private readonly metadataExtractor;
|
|
85
|
-
constructor();
|
|
86
|
-
private pascalToKebabCase;
|
|
87
|
-
private readMarkdownFile;
|
|
88
|
-
private listMarkdownFiles;
|
|
89
|
-
getComponentDocumentation(componentName: string): string;
|
|
90
|
-
getAllComponents(): string[];
|
|
91
|
-
getGuideDocumentation(guideName: string): string;
|
|
92
|
-
getAllGuides(): string[];
|
|
93
|
-
getComposableDocumentation(composableName: string): string;
|
|
94
|
-
getAllComposables(): string[];
|
|
95
|
-
getDirectiveDocumentation(directiveName: string): string;
|
|
96
|
-
getAllDirectives(): string[];
|
|
97
|
-
getPluginDocumentation(pluginName: string): string;
|
|
98
|
-
getAllPlugins(): string[];
|
|
99
|
-
getUtilDocumentation(utilName: string): string;
|
|
100
|
-
getAllUtils(): string[];
|
|
101
|
-
getNodeDocumentation(nodeName: string): string;
|
|
102
|
-
getAllNode(): string[];
|
|
103
|
-
getAllDocuments(): Document[];
|
|
104
|
-
private buildDocument;
|
|
105
|
-
getOverview(): string;
|
|
106
|
-
searchDocumentation(query: string): string[];
|
|
107
|
-
getDiagnostics(): DocumentationDiagnostics;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* MCP server for Maz-UI documentation
|
|
112
|
-
* Provides robust access to Vue.js components, guides, composables, directives, plugins, utils and node utilities
|
|
113
|
-
* with fuzzy search, comprehensive indexing, and intelligent fallbacks
|
|
114
|
-
*/
|
|
115
|
-
declare class MazUiMcpServer {
|
|
116
|
-
private server;
|
|
117
|
-
private documentationService;
|
|
118
|
-
private unifiedSearchService;
|
|
119
|
-
private documentationIndex;
|
|
120
|
-
constructor();
|
|
121
|
-
getDocumentationService(): DocumentationService;
|
|
122
|
-
/**
|
|
123
|
-
* Build a comprehensive index of all available documentation
|
|
124
|
-
* This helps the AI understand what's available and how to access it
|
|
125
|
-
*/
|
|
126
|
-
private buildDocumentationIndex;
|
|
127
|
-
/**
|
|
128
|
-
* Generate additional search tags based on common patterns
|
|
129
|
-
*/
|
|
130
|
-
private generateSearchTags;
|
|
131
|
-
/**
|
|
132
|
-
* Determine component type for better categorization
|
|
133
|
-
*/
|
|
134
|
-
private getComponentType;
|
|
135
|
-
/**
|
|
136
|
-
* Determine util type for better categorization
|
|
137
|
-
*/
|
|
138
|
-
private getUtilType;
|
|
139
|
-
/**
|
|
140
|
-
* Resolve a document name using intelligent matching:
|
|
141
|
-
* PascalCase (MazBtn), kebab-case (maz-btn), short name (btn), aliases
|
|
142
|
-
*/
|
|
143
|
-
private resolveDocumentName;
|
|
144
|
-
private handleSearch;
|
|
145
|
-
private handleList;
|
|
146
|
-
private handleGetDoc;
|
|
147
|
-
private handleDocNotFound;
|
|
148
|
-
private getDocumentContent;
|
|
149
|
-
private setupHandlers;
|
|
150
|
-
run(): Promise<void>;
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
export { MazUiMcpServer };
|