@maz-ui/mcp 5.0.1-beta.0 → 5.1.0-beta.1
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 +16 -0
- package/dist/index.d.mts +345 -0
- package/dist/index.d.ts +345 -0
- package/dist/index.mjs +16 -0
- package/dist/shared/mcp.DseFuKdl.mjs +2968 -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 +78 -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 +27 -189
- package/docs/{src/components → components}/maz-btn.md +62 -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 +107 -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 +48 -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 +21 -15
- 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 +50 -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 +239 -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 +507 -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 +59 -0
- package/package.json +86 -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
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: useToast
|
|
3
|
-
description: Vue composable for handling toast plugin in your components
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
::: warning
|
|
11
|
-
You must install [toast plugin](./../plugins/toast.md#install) before use it
|
|
12
|
-
:::
|
|
13
|
-
|
|
14
|
-
::: tip
|
|
15
|
-
More info about [toast plugin](./../plugins/toast.md) in its documentation
|
|
16
|
-
:::
|
|
17
|
-
|
|
18
|
-
## Usage
|
|
19
|
-
|
|
20
|
-
```vue
|
|
21
|
-
<script lang="ts" setup>
|
|
22
|
-
import { useToast } from 'maz-ui/composables'
|
|
23
|
-
|
|
24
|
-
const toast = useToast()
|
|
25
|
-
|
|
26
|
-
toast.info('info message', {
|
|
27
|
-
button: {
|
|
28
|
-
onClick: () => toast.success('clicked'),
|
|
29
|
-
text: 'Click me',
|
|
30
|
-
closeToast: true
|
|
31
|
-
}
|
|
32
|
-
})
|
|
33
|
-
toast.success('success message', {
|
|
34
|
-
button: {
|
|
35
|
-
href: '/composables/use-toast',
|
|
36
|
-
text: 'Follow me',
|
|
37
|
-
closeToast: true,
|
|
38
|
-
}
|
|
39
|
-
})
|
|
40
|
-
toast.warning('warning message')
|
|
41
|
-
toast.error('error message')
|
|
42
|
-
</script>
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
<script lang="ts" setup>
|
|
46
|
-
import { onMounted } from 'vue'
|
|
47
|
-
import { useToast } from 'maz-ui/composables/useToast'
|
|
48
|
-
|
|
49
|
-
const toast = useToast()
|
|
50
|
-
|
|
51
|
-
onMounted(() => {
|
|
52
|
-
toast.info('info message', {
|
|
53
|
-
button: {
|
|
54
|
-
onClick: () => toast.success('clicked'),
|
|
55
|
-
text: 'Click me',
|
|
56
|
-
closeToast: true
|
|
57
|
-
}
|
|
58
|
-
})
|
|
59
|
-
toast.success('success message', {
|
|
60
|
-
button: {
|
|
61
|
-
href: '/composables/use-toast',
|
|
62
|
-
text: 'Follow me',
|
|
63
|
-
closeToast: true,
|
|
64
|
-
}
|
|
65
|
-
})
|
|
66
|
-
toast.warning('warning message')
|
|
67
|
-
toast.error('error message')
|
|
68
|
-
toast.message('message')
|
|
69
|
-
})
|
|
70
|
-
|
|
71
|
-
</script>
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: useWait
|
|
3
|
-
description: Vue composable for handling wait plugins
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
::: warning
|
|
11
|
-
You must install the [wait plugin](./../plugins/wait.md#install) before using it
|
|
12
|
-
:::
|
|
13
|
-
|
|
14
|
-
::: tip
|
|
15
|
-
More info about the [wait plugin](./../plugins/wait.md) in its documentation
|
|
16
|
-
:::
|
|
17
|
-
|
|
18
|
-
## Usage
|
|
19
|
-
|
|
20
|
-
<MazFullscreenLoader v-if="wait.isLoading('MAIN_LOADER')">
|
|
21
|
-
Loading
|
|
22
|
-
</MazFullscreenLoader>
|
|
23
|
-
<p v-else> Loaded </p>
|
|
24
|
-
|
|
25
|
-
```vue
|
|
26
|
-
<script lang="ts" setup>
|
|
27
|
-
import { sleep } from '@maz-ui/utils'
|
|
28
|
-
import { useWait } from 'maz-ui/composables'
|
|
29
|
-
import { onMounted } from 'vue'
|
|
30
|
-
|
|
31
|
-
const wait = useWait()
|
|
32
|
-
|
|
33
|
-
onMounted(async () => {
|
|
34
|
-
wait.start('MAIN_LOADER')
|
|
35
|
-
await sleep(2000)
|
|
36
|
-
wait.stop('MAIN_LOADER')
|
|
37
|
-
})
|
|
38
|
-
</script>
|
|
39
|
-
|
|
40
|
-
<template>
|
|
41
|
-
<MazFullscreenLoader v-if="wait.isLoading('MAIN_LOADER')">
|
|
42
|
-
Loading
|
|
43
|
-
</MazFullscreenLoader>
|
|
44
|
-
<p v-else>
|
|
45
|
-
Loaded
|
|
46
|
-
</p>
|
|
47
|
-
</template>
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
<script lang="ts" setup>
|
|
51
|
-
import { onMounted } from 'vue'
|
|
52
|
-
import { sleep } from '@maz-ui/utils'
|
|
53
|
-
import { useWait } from 'maz-ui/composables/useWait'
|
|
54
|
-
|
|
55
|
-
const wait = useWait()
|
|
56
|
-
|
|
57
|
-
onMounted(async () => {
|
|
58
|
-
wait.start('MAIN_LOADER')
|
|
59
|
-
await sleep(2000)
|
|
60
|
-
wait.stop('MAIN_LOADER')
|
|
61
|
-
})
|
|
62
|
-
</script>
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: useWindowSize
|
|
3
|
-
description: This composable provides a simple utility to track the width and height of the browser window with reactivity
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
## Basic usage
|
|
11
|
-
|
|
12
|
-
```ts
|
|
13
|
-
const { height, width } = useWindowSize()
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
::: warning
|
|
17
|
-
More documentation to come
|
|
18
|
-
:::
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
# Icon Set (860+ icons)
|
|
2
|
-
|
|
3
|
-
The library includes **860+ icons**
|
|
4
|
-
|
|
5
|
-
## Icon Naming Convention
|
|
6
|
-
|
|
7
|
-
All icons follow a consistent naming pattern:
|
|
8
|
-
|
|
9
|
-
- Static Vue components: `Maz` + PascalCase (e.g., `MazUserCircle`)
|
|
10
|
-
- Lazy Vue components: `LazyMaz` + PascalCase (e.g., `LazyMazUserCircle`)
|
|
11
|
-
- SVG files: kebab-case (e.g., `user-circle.svg`)
|
|
12
|
-
|
|
13
|
-
## Find your icon
|
|
14
|
-
|
|
15
|
-
<ComponentDemo>
|
|
16
|
-
<div class="maz:flex maz:flex-col maz:gap-4">
|
|
17
|
-
<div class="maz:flex maz:gap-2 maz:items-start">
|
|
18
|
-
<MazInput v-model="search" label="Search icon" @update:model-value="search = $event.trim()" :start-icon="SearchIcon" class="flex-1" :assistive-text="`${filteredIcons.length} icons found`" />
|
|
19
|
-
</div>
|
|
20
|
-
<MazTabs v-model="currentTab">
|
|
21
|
-
<MazTabsBar :items="tabs" />
|
|
22
|
-
</MazTabs>
|
|
23
|
-
<div class="maz:grid maz:grid-cols-3 maz:gap-2">
|
|
24
|
-
<div v-for="icon in filteredIcons" :key="icon.name" class="maz:flex maz:flex-col maz:items-center maz:gap-3 maz:text-center maz:border maz:border-solid maz:border-divider maz:rounded-md maz:p-4 maz:truncate">
|
|
25
|
-
<component :is="icon.component" class="maz:size-8" />
|
|
26
|
-
<span class="maz:text-xs maz:text-muted maz:truncate">{{ icon.name }}</span>
|
|
27
|
-
<div class="maz:flex maz:flex-row maz:gap-2 maz:w-full">
|
|
28
|
-
<MazBtn v-tooltip="{ text: 'Copy Name', panelClass: 'maz:text-xs' }" class="maz:flex-1" size="xs" color="surface" outlined @click="copyIcon(icon.name)" :icon="ClipboardDocumentIcon" />
|
|
29
|
-
<MazBtn v-tooltip="{ text: 'Copy Static Import', panelClass: 'maz:text-xs' }" class="maz:flex-1" size="xs" color="surface" outlined @click="copyStaticImport(icon.name)" :icon="ClipboardDocumentListIcon" />
|
|
30
|
-
<MazBtn v-tooltip="{ text: 'Copy Lazy Import', panelClass: 'maz:text-xs' }" class="maz:flex-1" size="xs" color="surface" outlined @click="copyLazyImport(icon.name)" :icon="ClipboardDocumentListIcon" />
|
|
31
|
-
</div>
|
|
32
|
-
</div>
|
|
33
|
-
</div>
|
|
34
|
-
</div>
|
|
35
|
-
</ComponentDemo>
|
|
36
|
-
|
|
37
|
-
<script setup>
|
|
38
|
-
import { computed, ref, shallowRef } from 'vue'
|
|
39
|
-
import { useToast } from 'maz-ui/composables/useToast'
|
|
40
|
-
import { vTooltip } from 'maz-ui/directives/vTooltip'
|
|
41
|
-
|
|
42
|
-
const LazyIcons = shallowRef()
|
|
43
|
-
const SearchIcon = shallowRef()
|
|
44
|
-
const ClipboardDocumentIcon = shallowRef()
|
|
45
|
-
const ClipboardDocumentListIcon = shallowRef()
|
|
46
|
-
|
|
47
|
-
const lazyIconModule = await import('@maz-ui/icons/lazy')
|
|
48
|
-
LazyIcons.value = lazyIconModule
|
|
49
|
-
SearchIcon.value = lazyIconModule.MazMagnifyingGlass
|
|
50
|
-
ClipboardDocumentIcon.value = lazyIconModule.MazClipboardDocument
|
|
51
|
-
ClipboardDocumentListIcon.value = lazyIconModule.MazClipboardDocumentList
|
|
52
|
-
|
|
53
|
-
const icons = Object.entries(LazyIcons.value)
|
|
54
|
-
.filter(([name]) => name.startsWith('Maz'))
|
|
55
|
-
.sort(([nameA], [nameB]) => nameA.localeCompare(nameB))
|
|
56
|
-
.map(([name, component]) => ({ name, component }))
|
|
57
|
-
|
|
58
|
-
const { commonIcons, flags, flagsSquare, logos, all } = icons.reduce((acc, iconComponent) => {
|
|
59
|
-
if (iconComponent.name.startsWith('MazFlagSquare')) {
|
|
60
|
-
acc.flagsSquare.push(iconComponent)
|
|
61
|
-
}
|
|
62
|
-
else if (iconComponent.name.startsWith('MazFlag') && iconComponent.name.length >= 8) {
|
|
63
|
-
acc.flags.push(iconComponent)
|
|
64
|
-
}
|
|
65
|
-
else if (iconComponent.name.startsWith('MazLogo') && iconComponent.name.length >= 8) {
|
|
66
|
-
acc.logos.push(iconComponent)
|
|
67
|
-
}
|
|
68
|
-
else if (iconComponent.name.startsWith('Maz')) {
|
|
69
|
-
acc.commonIcons.push(iconComponent)
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
acc.all.push(iconComponent)
|
|
73
|
-
|
|
74
|
-
return acc
|
|
75
|
-
}, {
|
|
76
|
-
commonIcons: [],
|
|
77
|
-
flags: [],
|
|
78
|
-
flagsSquare: [],
|
|
79
|
-
logos: [],
|
|
80
|
-
all: [],
|
|
81
|
-
})
|
|
82
|
-
|
|
83
|
-
const currentTab = ref(1)
|
|
84
|
-
|
|
85
|
-
const tabs = [
|
|
86
|
-
{ label: 'All', badge: { color: 'secondary', content: all.length, roundedSize: 'full' } },
|
|
87
|
-
{ label: 'Icons', badge: { color: 'secondary', content: commonIcons.length, roundedSize: 'full' } },
|
|
88
|
-
{ label: 'Logos', badge: { color: 'secondary', content: logos.length, roundedSize: 'full' } },
|
|
89
|
-
{ label: 'Flags', badge: { color: 'secondary', content: flags.length, roundedSize: 'full' } },
|
|
90
|
-
{ label: 'Flags Square', badge: { color: 'secondary', content: flagsSquare.length, roundedSize: 'full' } },
|
|
91
|
-
]
|
|
92
|
-
|
|
93
|
-
const { success } = useToast()
|
|
94
|
-
|
|
95
|
-
const search = ref()
|
|
96
|
-
|
|
97
|
-
const filteredIcons = computed(() => {
|
|
98
|
-
const _currentTab = currentTab.value
|
|
99
|
-
|
|
100
|
-
const tabMap = { 1: all, 2: commonIcons, 3: logos, 4: flags, 5: flagsSquare }
|
|
101
|
-
const baseIcons = tabMap[_currentTab] || all
|
|
102
|
-
|
|
103
|
-
const _search = search.value?.toLowerCase().replace(/\s/g, '')
|
|
104
|
-
if (!_search) return baseIcons
|
|
105
|
-
|
|
106
|
-
return baseIcons.filter(icon => icon.name.toLowerCase().includes(_search) || _search.includes(icon.name.toLowerCase()))
|
|
107
|
-
})
|
|
108
|
-
|
|
109
|
-
const copyIcon = (icon) => {
|
|
110
|
-
navigator.clipboard.writeText(icon)
|
|
111
|
-
success('Icon name copied to clipboard')
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
const copyStaticImport = (icon) => {
|
|
115
|
-
navigator.clipboard.writeText(`import { ${icon} } from '@maz-ui/icons/${icon}'`)
|
|
116
|
-
success('Static import copied to clipboard')
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
const copyLazyImport = (icon) => {
|
|
120
|
-
navigator.clipboard.writeText(`import { ${icon} } from '@maz-ui/icons/lazy/${icon}'`)
|
|
121
|
-
success('Lazy import copied to clipboard')
|
|
122
|
-
}
|
|
123
|
-
</script>
|
|
@@ -1,210 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Model Context Protocol (MCP)
|
|
3
|
-
description: Connect Maz-UI with AI assistants using Model Context Protocol - Get intelligent help with components, guides, composables, directives, plugins, and helpers
|
|
4
|
-
head:
|
|
5
|
-
- - meta
|
|
6
|
-
- name: keywords
|
|
7
|
-
content: mcp, model context protocol, ai assistant, claude, cline, maz-ui integration, ai development
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# {{ $frontmatter.title }}
|
|
11
|
-
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
<NpmBadge package="@maz-ui/mcp" />
|
|
15
|
-
|
|
16
|
-
Connect your AI assistant directly to Maz-UI's documentation and get intelligent help with components, composables, directives, plugins, helpers, and best practices.
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
- [{{ $frontmatter.title }}](#-frontmattertitle-)
|
|
21
|
-
- [What is MCP?](#what-is-mcp)
|
|
22
|
-
- [AI Assistant Configuration](#ai-assistant-configuration)
|
|
23
|
-
- [Claude Code](#claude-code)
|
|
24
|
-
- [Claude Desktop](#claude-desktop)
|
|
25
|
-
- [Cursor IDE](#cursor-ide)
|
|
26
|
-
- [Windsurf](#windsurf)
|
|
27
|
-
- [Visual Studio Code (Copilot)](#visual-studio-code-copilot)
|
|
28
|
-
- [Cline](#cline)
|
|
29
|
-
- [Available Resources](#available-resources)
|
|
30
|
-
|
|
31
|
-
## What is MCP?
|
|
32
|
-
|
|
33
|
-
Think of MCP (Model Context Protocol) as a **smart bridge** between your AI assistant and Maz-UI. It's like giving your AI assistant a direct phone line to all of Maz-UI's documentation!
|
|
34
|
-
|
|
35
|
-
Instead of asking *"How do I use MazBtn?"* and getting generic answers or answers based on old documentation, your AI can now:
|
|
36
|
-
- 🔍 **Search** through all 50+ Maz-UI components and others
|
|
37
|
-
- 📖 **Read** the exact documentation for any component, composables, directives, plugins, helpers, and best practices
|
|
38
|
-
- 💡 **Suggest** the best way to implement your needs
|
|
39
|
-
- 🛠️ **Help** with implementation examples
|
|
40
|
-
|
|
41
|
-
::: tip Maz-UI provides a free MCP server with access to:
|
|
42
|
-
|
|
43
|
-
- 50+ Vue components documentation
|
|
44
|
-
- 14+ composables and utilities
|
|
45
|
-
- 11 comprehensive guides
|
|
46
|
-
- 5 directives and 4 plugins
|
|
47
|
-
- 20+ helper functions
|
|
48
|
-
|
|
49
|
-
:::
|
|
50
|
-
|
|
51
|
-
## AI Assistant Configuration
|
|
52
|
-
|
|
53
|
-
### Claude Code
|
|
54
|
-
|
|
55
|
-
1. Run the following command:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
claude mcp add maz-ui npx @maz-ui/mcp --scope (project | local | user)
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
2. Will add the following to your `~/.mcp.json` (for project scope):
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{
|
|
65
|
-
"mcpServers": {
|
|
66
|
-
"maz-ui": {
|
|
67
|
-
"type": "stdio",
|
|
68
|
-
"command": "npx",
|
|
69
|
-
"args": ["@maz-ui/mcp"]
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
3. Restart Claude code to apply the new configuration.
|
|
76
|
-
|
|
77
|
-
### Claude Desktop
|
|
78
|
-
|
|
79
|
-
1. Open Claude desktop and navigate to Settings.
|
|
80
|
-
|
|
81
|
-
2. Under the Developer tab, tap Edit Config to open the configuration file.
|
|
82
|
-
|
|
83
|
-
3. Add the following configuration:
|
|
84
|
-
|
|
85
|
-
```json
|
|
86
|
-
{
|
|
87
|
-
"mcpServers": {
|
|
88
|
-
"maz-ui": {
|
|
89
|
-
"type": "stdio",
|
|
90
|
-
"command": "npx",
|
|
91
|
-
"args": ["@maz-ui/mcp"]
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
4. Save the configuration file and restart Claude desktop.
|
|
98
|
-
|
|
99
|
-
5. From the new chat screen, you should see a hammer (MCP) icon appear with the new MCP server available.
|
|
100
|
-
|
|
101
|
-
### Cursor IDE
|
|
102
|
-
|
|
103
|
-
1. Open Cursor and create a .cursor directory in your project root if it doesn't exist.
|
|
104
|
-
|
|
105
|
-
2. Create a .cursor/mcp.json file if it doesn't exist and open it.
|
|
106
|
-
|
|
107
|
-
3. Add the following configuration:
|
|
108
|
-
|
|
109
|
-
```json
|
|
110
|
-
{
|
|
111
|
-
"mcpServers": {
|
|
112
|
-
"maz-ui": {
|
|
113
|
-
"command": "npx",
|
|
114
|
-
"args": ["@maz-ui/mcp"]
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
4. Save the configuration file.
|
|
121
|
-
|
|
122
|
-
5. Open Cursor and navigate to Settings/MCP. You should see a green active status after the server is successfully connected.
|
|
123
|
-
|
|
124
|
-
### Windsurf
|
|
125
|
-
|
|
126
|
-
1. Open Windsurf and navigate to the Cascade assistant.
|
|
127
|
-
|
|
128
|
-
2. Tap on the hammer (MCP) icon, then Configure to open the configuration file.
|
|
129
|
-
|
|
130
|
-
3. Add the following configuration:
|
|
131
|
-
|
|
132
|
-
```json
|
|
133
|
-
{
|
|
134
|
-
"mcpServers": {
|
|
135
|
-
"maz-ui": {
|
|
136
|
-
"command": "npx",
|
|
137
|
-
"args": ["@maz-ui/mcp"]
|
|
138
|
-
}
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
4. Save the configuration file and reload by tapping Refresh in the Cascade assistant.
|
|
144
|
-
|
|
145
|
-
5. You should see a green active status after the server is successfully connected.
|
|
146
|
-
|
|
147
|
-
### Visual Studio Code (Copilot)
|
|
148
|
-
|
|
149
|
-
1. Open VS Code and create a .vscode directory in your project root if it doesn't exist.
|
|
150
|
-
|
|
151
|
-
2. Create a .vscode/mcp.json file if it doesn't exist and open it.
|
|
152
|
-
|
|
153
|
-
3. Add the following configuration:
|
|
154
|
-
|
|
155
|
-
```json
|
|
156
|
-
{
|
|
157
|
-
"servers": {
|
|
158
|
-
"maz-ui": {
|
|
159
|
-
"command": "npx",
|
|
160
|
-
"args": ["@maz-ui/mcp"]
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
}
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
4. Save the configuration file.
|
|
167
|
-
|
|
168
|
-
5. Open Copilot chat and switch to "Agent" mode. You should see a tool icon that you can tap to confirm the MCP tools are available. Once you begin using the server, you will be prompted to enter your personal access token. Enter the token that you created earlier.
|
|
169
|
-
|
|
170
|
-
### Cline
|
|
171
|
-
|
|
172
|
-
1. Open the Cline extension in VS Code and tap the MCP Servers icon.
|
|
173
|
-
|
|
174
|
-
2. Tap Configure MCP Servers to open the configuration file.
|
|
175
|
-
|
|
176
|
-
3. Add the following configuration:
|
|
177
|
-
|
|
178
|
-
```json
|
|
179
|
-
{
|
|
180
|
-
"mcpServers": {
|
|
181
|
-
"maz-ui": {
|
|
182
|
-
"command": "npx",
|
|
183
|
-
"args": ["@maz-ui/mcp"]
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
4. Save the configuration file. Cline should automatically reload the configuration.
|
|
190
|
-
|
|
191
|
-
5. You should see a green active status after the server is successfully connected.
|
|
192
|
-
|
|
193
|
-
## Available Resources
|
|
194
|
-
|
|
195
|
-
Your AI assistant now has access to:
|
|
196
|
-
|
|
197
|
-
| Resource Type | Count | Description |
|
|
198
|
-
|---------------|-------|-------------|
|
|
199
|
-
| **Components** | 50+ | All Vue components with props, events, and examples |
|
|
200
|
-
| **Guides** | 11 | Installation, theming, migration, and best practices |
|
|
201
|
-
| **Composables** | 14+ | Reusable Vue composition functions |
|
|
202
|
-
| **Directives** | 5 | Vue directives for enhanced functionality |
|
|
203
|
-
| **Plugins** | 4 | Toast, dialog, AOS, and wait overlay systems |
|
|
204
|
-
| **Helpers** | 20+ | Utility functions for common tasks |
|
|
205
|
-
|
|
206
|
-
::: warning 🔒 Security Note
|
|
207
|
-
The MCP server provides read-only access to documentation. No sensitive data is transmitted or stored.
|
|
208
|
-
:::
|
|
209
|
-
|
|
210
|
-
Happy coding with AI-powered Maz-UI assistance! 🚀✨
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: '@maz-ui/node'
|
|
3
|
-
description: Lightweight Node.js utilities — promise-based shell execution, an opinionated consola-backed logger, and a banner printer for CLIs.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
<NpmBadge package="@maz-ui/node" />
|
|
11
|
-
|
|
12
|
-
`@maz-ui/node` powers the CLIs and build scripts inside the maz-ui ecosystem. It's intentionally tiny: an `exec` wrapper that returns a real `Promise`, a colourful logger built on [consola](https://github.com/unjs/consola), and a banner helper using [figlet](https://github.com/patorjk/figlet.js).
|
|
13
|
-
|
|
14
|
-
## Installation
|
|
15
|
-
|
|
16
|
-
::: code-group
|
|
17
|
-
|
|
18
|
-
```bash [pnpm]
|
|
19
|
-
pnpm add @maz-ui/node
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
```bash [npm]
|
|
23
|
-
npm install @maz-ui/node
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
```bash [yarn]
|
|
27
|
-
yarn add @maz-ui/node
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
:::
|
|
31
|
-
|
|
32
|
-
## Basic usage
|
|
33
|
-
|
|
34
|
-
```ts
|
|
35
|
-
import { execPromise, logger, printBanner } from '@maz-ui/node'
|
|
36
|
-
|
|
37
|
-
printBanner({ name: 'my-cli', version: '1.0.0' })
|
|
38
|
-
|
|
39
|
-
logger.info('Running tests…')
|
|
40
|
-
await execPromise('npm test', { packageName: 'tests' })
|
|
41
|
-
logger.success('Done')
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## What's inside
|
|
45
|
-
|
|
46
|
-
- [`execPromise`](./exec-promise) — Promise-based `child_process.exec` with structured logging.
|
|
47
|
-
- [`logger` / `createLogger`](./logger) — consola-backed logger with semantic log levels and helpers (`box`, `divider`, `brand`, …).
|
|
48
|
-
- [`printBanner`](./print-banner) — ASCII-art banner printer (figlet) with versioning, dividers and clearing.
|
|
49
|
-
|
|
50
|
-
## Requirements
|
|
51
|
-
|
|
52
|
-
- Node.js >= 22.12.0
|
|
53
|
-
- ESM only — published as `"type": "module"`.
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: camelCase
|
|
3
|
-
description: Convert a kebab-case string to camelCase by stripping dashes and uppercasing the following letter.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
## Usage
|
|
11
|
-
|
|
12
|
-
```ts
|
|
13
|
-
import { camelCase } from '@maz-ui/utils'
|
|
14
|
-
|
|
15
|
-
camelCase('my-component-name') // → 'myComponentName'
|
|
16
|
-
camelCase('hello-world') // → 'helloWorld'
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## API
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
function camelCase(str: string): string
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
| Parameter | Type | Description |
|
|
26
|
-
| --------- | -------- | --------------------- |
|
|
27
|
-
| `str` | `string` | The string to convert |
|
|
28
|
-
|
|
29
|
-
## Notes
|
|
30
|
-
|
|
31
|
-
`camelCase` is intentionally minimal — it only handles `kebab-case` input. For more general normalization (snake_case, spaces, PascalCase), use [`normalizeString`](./normalize-string) with the `case: 'camelCase'` option.
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: capitalize
|
|
3
|
-
description: The module capitalize is a function that adds a capital letter to a string
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# {{ $frontmatter.title }}
|
|
7
|
-
|
|
8
|
-
{{ $frontmatter.description }}
|
|
9
|
-
|
|
10
|
-
<MazInput v-model="stringValue" />
|
|
11
|
-
|
|
12
|
-
<div
|
|
13
|
-
class="maz:flex maz:flex-center maz:rounded-md maz:gap-0.5 maz:p-4 maz:mt-16 maz:bg-surface-300"
|
|
14
|
-
>
|
|
15
|
-
formatted value: <strong>{{ stringFormatted }}</strong>
|
|
16
|
-
</div>
|
|
17
|
-
|
|
18
|
-
```vue
|
|
19
|
-
<script lang="ts" setup>
|
|
20
|
-
import { capitalize } from '@maz-ui/utils'
|
|
21
|
-
import { computed, ref } from 'vue'
|
|
22
|
-
|
|
23
|
-
const stringValue = ref('string value')
|
|
24
|
-
|
|
25
|
-
const stringFormatted = computed(() =>
|
|
26
|
-
capitalize(stringValue.value),
|
|
27
|
-
)
|
|
28
|
-
</script>
|
|
29
|
-
|
|
30
|
-
<template>
|
|
31
|
-
<MazInput v-model="stringValue" />
|
|
32
|
-
|
|
33
|
-
<div
|
|
34
|
-
class="flex flex-center rounded-md gap-0.5 p-4 mt-16 bg-surface-300"
|
|
35
|
-
>
|
|
36
|
-
{{ stringFormatted }}
|
|
37
|
-
</div>
|
|
38
|
-
</template>
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
<script lang="ts" setup>
|
|
42
|
-
import { capitalize } from '@maz-ui/utils'
|
|
43
|
-
import { ref, computed } from 'vue'
|
|
44
|
-
|
|
45
|
-
const stringValue = ref('string value')
|
|
46
|
-
|
|
47
|
-
const stringFormatted = computed(() =>
|
|
48
|
-
capitalize(stringValue.value),
|
|
49
|
-
)
|
|
50
|
-
</script>
|