@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.
Files changed (343) hide show
  1. package/README.md +61 -228
  2. package/bin/maz-ui-mcp.mjs +2 -5
  3. package/dist/cli.d.mts +7 -0
  4. package/dist/cli.d.ts +7 -0
  5. package/dist/cli.mjs +16 -0
  6. package/dist/index.d.mts +345 -0
  7. package/dist/index.d.ts +345 -0
  8. package/dist/index.mjs +16 -0
  9. package/dist/shared/mcp.DseFuKdl.mjs +2968 -0
  10. package/docs/README.md +207 -0
  11. package/docs/agents/agents-md.md +52 -0
  12. package/docs/agents/claude-rule.md +52 -0
  13. package/docs/components/maz-accordion.md +78 -0
  14. package/docs/{src/components → components}/maz-alert.md +31 -164
  15. package/docs/components/maz-animated-counter.md +87 -0
  16. package/docs/components/maz-animated-element.md +46 -0
  17. package/docs/components/maz-animated-text.md +53 -0
  18. package/docs/components/maz-avatar.md +193 -0
  19. package/docs/components/maz-backdrop.md +178 -0
  20. package/docs/{src/components → components}/maz-badge.md +26 -67
  21. package/docs/components/maz-bottom-sheet.md +257 -0
  22. package/docs/{src/components → components}/maz-btn-group.md +27 -189
  23. package/docs/{src/components → components}/maz-btn.md +62 -245
  24. package/docs/components/maz-card-spotlight.md +84 -0
  25. package/docs/{src/components → components}/maz-card.md +67 -192
  26. package/docs/components/maz-carousel.md +153 -0
  27. package/docs/{src/components → components}/maz-chart.md +17 -161
  28. package/docs/components/maz-checkbox.md +138 -0
  29. package/docs/components/maz-checklist.md +251 -0
  30. package/docs/components/maz-circular-progress-bar.md +109 -0
  31. package/docs/{src/components → components}/maz-code-highlight.md +15 -93
  32. package/docs/components/maz-container.md +241 -0
  33. package/docs/{src/components → components}/maz-date-picker.md +85 -454
  34. package/docs/components/maz-dialog-confirm.md +215 -0
  35. package/docs/components/maz-dialog.md +143 -0
  36. package/docs/components/maz-drawer.md +107 -0
  37. package/docs/components/maz-dropdown.md +419 -0
  38. package/docs/{src/components → components}/maz-dropzone.md +80 -221
  39. package/docs/components/maz-expand-animation.md +82 -0
  40. package/docs/components/maz-fullscreen-loader.md +58 -0
  41. package/docs/components/maz-gallery.md +79 -0
  42. package/docs/{src/components → components}/maz-icon.md +32 -83
  43. package/docs/components/maz-input-code.md +73 -0
  44. package/docs/components/maz-input-number.md +79 -0
  45. package/docs/components/maz-input-phone-number.md +536 -0
  46. package/docs/components/maz-input-price.md +68 -0
  47. package/docs/components/maz-input-tags.md +112 -0
  48. package/docs/{src/components → components}/maz-input.md +74 -221
  49. package/docs/components/maz-lazy-img.md +113 -0
  50. package/docs/components/maz-link.md +146 -0
  51. package/docs/components/maz-loading-bar.md +38 -0
  52. package/docs/{src/components → components}/maz-markdown-editor.md +72 -125
  53. package/docs/components/maz-pagination.md +82 -0
  54. package/docs/components/maz-popover.md +794 -0
  55. package/docs/{src/components → components}/maz-pull-to-refresh.md +59 -45
  56. package/docs/components/maz-radio-buttons.md +313 -0
  57. package/docs/components/maz-radio.md +119 -0
  58. package/docs/{src/components → components}/maz-read-more.md +31 -122
  59. package/docs/components/maz-reading-progress-bar.md +96 -0
  60. package/docs/{src/components → components}/maz-select-country.md +80 -340
  61. package/docs/{src/components → components}/maz-select.md +76 -206
  62. package/docs/components/maz-sidebar-content.md +25 -0
  63. package/docs/components/maz-sidebar-footer.md +25 -0
  64. package/docs/components/maz-sidebar-group.md +27 -0
  65. package/docs/components/maz-sidebar-header.md +25 -0
  66. package/docs/components/maz-sidebar-menu-button.md +41 -0
  67. package/docs/components/maz-sidebar-menu-item.md +25 -0
  68. package/docs/components/maz-sidebar-menu-sub.md +32 -0
  69. package/docs/components/maz-sidebar-menu.md +25 -0
  70. package/docs/components/maz-sidebar-separator.md +21 -0
  71. package/docs/components/maz-sidebar-trigger.md +25 -0
  72. package/docs/{src/components → components}/maz-sidebar.md +117 -329
  73. package/docs/{src/components → components}/maz-skeleton.md +27 -156
  74. package/docs/{src/components → components}/maz-slider.md +33 -66
  75. package/docs/components/maz-spinner.md +84 -0
  76. package/docs/{src/components → components}/maz-stepper.md +48 -185
  77. package/docs/components/maz-switch.md +86 -0
  78. package/docs/components/maz-table-cell.md +27 -0
  79. package/docs/components/maz-table-row.md +28 -0
  80. package/docs/components/maz-table-title.md +27 -0
  81. package/docs/components/maz-table-virtualizer.md +31 -0
  82. package/docs/components/maz-table.md +426 -0
  83. package/docs/components/maz-tabs-bar.md +43 -0
  84. package/docs/components/maz-tabs-content-item.md +27 -0
  85. package/docs/components/maz-tabs-content.md +27 -0
  86. package/docs/{src/components → components}/maz-tabs.md +89 -126
  87. package/docs/components/maz-textarea.md +255 -0
  88. package/docs/components/maz-ticker.md +427 -0
  89. package/docs/components/maz-timeline.md +304 -0
  90. package/docs/components/maz-ui-provider.md +26 -0
  91. package/docs/{src/components → components}/maz-window-mockup.md +38 -105
  92. package/docs/composables/use-aos.md +41 -0
  93. package/docs/composables/use-breakpoints.md +42 -0
  94. package/docs/composables/use-dialog.md +58 -0
  95. package/docs/{src/composables → composables}/use-display-names.md +12 -59
  96. package/docs/{src/composables → composables}/use-drag.md +14 -68
  97. package/docs/{src/composables → composables}/use-form-validator.md +22 -696
  98. package/docs/{src/composables → composables}/use-idle-timeout.md +13 -97
  99. package/docs/{src/composables → composables}/use-pull-to-refresh.md +14 -7
  100. package/docs/{src/composables → composables}/use-reading-time.md +20 -56
  101. package/docs/composables/use-string-matching.md +41 -0
  102. package/docs/{src/composables → composables}/use-swipe.md +14 -81
  103. package/docs/{src/composables → composables}/use-timer.md +12 -38
  104. package/docs/composables/use-toast.md +50 -0
  105. package/docs/{src/composables → composables}/use-user-visibility.md +14 -56
  106. package/docs/composables/use-wait.md +50 -0
  107. package/docs/composables/use-window-size.md +25 -0
  108. package/docs/{src/directives → directives}/click-outside.md +13 -99
  109. package/docs/{src/directives → directives}/fullscreen-img.md +10 -28
  110. package/docs/{src/directives → directives}/lazy-img.md +14 -49
  111. package/docs/{src/directives → directives}/tooltip.md +12 -217
  112. package/docs/{src/directives → directives}/zoom-img.md +11 -38
  113. package/docs/{src/ecosystem → ecosystem}/eslint-config.md +37 -29
  114. package/docs/ecosystem/icons/icon-set.md +25 -0
  115. package/docs/{src/ecosystem → ecosystem}/icons/index.md +21 -15
  116. package/docs/ecosystem/mcp.md +165 -0
  117. package/docs/{src/ecosystem → ecosystem}/node/exec-promise.md +12 -6
  118. package/docs/ecosystem/node/index.md +53 -0
  119. package/docs/{src/ecosystem → ecosystem}/node/logger.md +12 -6
  120. package/docs/{src/ecosystem → ecosystem}/node/print-banner.md +12 -4
  121. package/docs/ecosystem/node/setup-agents.md +102 -0
  122. package/docs/{src/ecosystem → ecosystem}/nuxt.md +50 -19
  123. package/docs/{src/ecosystem → ecosystem}/stylelint-config.md +33 -25
  124. package/docs/{src/ecosystem → ecosystem}/themes.md +72 -235
  125. package/docs/{src/ecosystem → ecosystem}/translations.md +25 -23
  126. package/docs/ecosystem/utils/camel-case.md +37 -0
  127. package/docs/ecosystem/utils/capitalize.md +37 -0
  128. package/docs/{src/ecosystem → ecosystem}/utils/check-availability.md +14 -8
  129. package/docs/{src/ecosystem → ecosystem}/utils/cookie.md +18 -12
  130. package/docs/ecosystem/utils/country-code-to-unicode-flag.md +128 -0
  131. package/docs/{src/ecosystem → ecosystem}/utils/currency.md +12 -26
  132. package/docs/{src/ecosystem → ecosystem}/utils/date.md +10 -24
  133. package/docs/ecosystem/utils/debounce-callback.md +44 -0
  134. package/docs/{src/ecosystem → ecosystem}/utils/debounce-id.md +14 -8
  135. package/docs/{src/ecosystem → ecosystem}/utils/debounce.md +14 -8
  136. package/docs/ecosystem/utils/fetch-locale-ip.md +39 -0
  137. package/docs/{src/ecosystem → ecosystem}/utils/format-json.md +11 -5
  138. package/docs/{src/ecosystem → ecosystem}/utils/format-phone-number.md +12 -6
  139. package/docs/ecosystem/utils/get-browser-locale.md +35 -0
  140. package/docs/ecosystem/utils/get-country-flag-url.md +67 -0
  141. package/docs/{src/ecosystem → ecosystem}/utils/get-error-message.md +10 -4
  142. package/docs/{src/ecosystem → ecosystem}/utils/idle-timeout.md +15 -9
  143. package/docs/{src/ecosystem → ecosystem}/utils/index.md +10 -13
  144. package/docs/{src/ecosystem → ecosystem}/utils/is-client.md +11 -5
  145. package/docs/{src/ecosystem → ecosystem}/utils/is-equal.md +14 -8
  146. package/docs/{src/ecosystem → ecosystem}/utils/is-ios.md +12 -6
  147. package/docs/ecosystem/utils/is-server.md +37 -0
  148. package/docs/ecosystem/utils/is-standalone-mode.md +49 -0
  149. package/docs/{src/ecosystem → ecosystem}/utils/kebab-case.md +10 -4
  150. package/docs/{src/ecosystem → ecosystem}/utils/normalize-string.md +10 -4
  151. package/docs/{src/ecosystem → ecosystem}/utils/number.md +10 -24
  152. package/docs/{src/ecosystem → ecosystem}/utils/pascal-case.md +11 -5
  153. package/docs/{src/ecosystem → ecosystem}/utils/prevent-ios-input-zoom.md +14 -8
  154. package/docs/{src/ecosystem → ecosystem}/utils/script-loader.md +16 -8
  155. package/docs/{src/ecosystem → ecosystem}/utils/sleep.md +10 -4
  156. package/docs/{src/ecosystem → ecosystem}/utils/snake-case.md +10 -4
  157. package/docs/{src/ecosystem → ecosystem}/utils/swipe-handler.md +14 -8
  158. package/docs/{src/ecosystem → ecosystem}/utils/textarea-autogrow.md +12 -6
  159. package/docs/{src/ecosystem → ecosystem}/utils/throttle-id.md +13 -7
  160. package/docs/{src/ecosystem → ecosystem}/utils/throttle.md +14 -8
  161. package/docs/ecosystem/utils/truthy-filter.md +37 -0
  162. package/docs/{src/ecosystem → ecosystem}/utils/types/deep-key-of.md +11 -5
  163. package/docs/{src/ecosystem → ecosystem}/utils/types/deep-partial.md +10 -4
  164. package/docs/ecosystem/utils/types/deep-required.md +45 -0
  165. package/docs/ecosystem/utils/types/flatten-object-keys.md +50 -0
  166. package/docs/{src/ecosystem → ecosystem}/utils/types/generic-instance-type.md +10 -4
  167. package/docs/{src/ecosystem → ecosystem}/utils/types/infer-maybe-ref.md +10 -4
  168. package/docs/ecosystem/utils/upper-first.md +38 -0
  169. package/docs/{src/ecosystem → ecosystem}/utils/user-visibility.md +12 -6
  170. package/docs/guide/ai-agents.md +239 -0
  171. package/docs/{src/guide → guide}/browser-support.md +22 -15
  172. package/docs/{src/guide → guide}/getting-started.md +34 -139
  173. package/docs/{src/guide → guide}/global-defaults.md +12 -11
  174. package/docs/{src/guide → guide}/maz-ui-provider.md +17 -16
  175. package/docs/{src/guide → guide}/migration-v5.md +95 -88
  176. package/docs/{src/guide → guide}/resolvers.md +33 -100
  177. package/docs/guide/tailwind.md +507 -0
  178. package/docs/{src/guide → guide}/vue.md +33 -39
  179. package/docs/manifest.json +1 -0
  180. package/docs/{src/plugins → plugins}/aos.md +20 -55
  181. package/docs/{src/plugins → plugins}/dialog.md +14 -161
  182. package/docs/plugins/toast.md +221 -0
  183. package/docs/plugins/wait.md +78 -0
  184. package/docs/reference/icons.md +46 -0
  185. package/docs/reference/tailwind-tokens.md +191 -0
  186. package/docs/rules.md +59 -0
  187. package/package.json +86 -22
  188. package/dist/mcp.d.mts +0 -153
  189. package/dist/mcp.d.ts +0 -153
  190. package/dist/mcp.mjs +0 -1511
  191. package/docs/generated-docs/maz-accordion.doc.md +0 -21
  192. package/docs/generated-docs/maz-alert.doc.md +0 -20
  193. package/docs/generated-docs/maz-animated-counter.doc.md +0 -17
  194. package/docs/generated-docs/maz-animated-element.doc.md +0 -14
  195. package/docs/generated-docs/maz-animated-text.doc.md +0 -17
  196. package/docs/generated-docs/maz-avatar.doc.md +0 -45
  197. package/docs/generated-docs/maz-backdrop.doc.md +0 -55
  198. package/docs/generated-docs/maz-badge.doc.md +0 -16
  199. package/docs/generated-docs/maz-bottom-sheet.doc.md +0 -24
  200. package/docs/generated-docs/maz-btn-group.doc.md +0 -20
  201. package/docs/generated-docs/maz-btn.doc.md +0 -33
  202. package/docs/generated-docs/maz-card-spotlight.doc.md +0 -16
  203. package/docs/generated-docs/maz-card.doc.md +0 -39
  204. package/docs/generated-docs/maz-carousel.doc.md +0 -17
  205. package/docs/generated-docs/maz-chart.doc.md +0 -10
  206. package/docs/generated-docs/maz-checkbox.doc.md +0 -33
  207. package/docs/generated-docs/maz-checklist.doc.md +0 -30
  208. package/docs/generated-docs/maz-circular-progress-bar.doc.md +0 -27
  209. package/docs/generated-docs/maz-code-highlight.doc.md +0 -11
  210. package/docs/generated-docs/maz-container.doc.md +0 -26
  211. package/docs/generated-docs/maz-date-picker.doc.md +0 -56
  212. package/docs/generated-docs/maz-dialog-confirm.doc.md +0 -24
  213. package/docs/generated-docs/maz-dialog.doc.md +0 -22
  214. package/docs/generated-docs/maz-drawer.doc.md +0 -25
  215. package/docs/generated-docs/maz-dropdown.doc.md +0 -45
  216. package/docs/generated-docs/maz-dropzone.doc.md +0 -82
  217. package/docs/generated-docs/maz-expand-animation.doc.md +0 -12
  218. package/docs/generated-docs/maz-fullscreen-loader.doc.md +0 -13
  219. package/docs/generated-docs/maz-gallery.doc.md +0 -17
  220. package/docs/generated-docs/maz-icon.doc.md +0 -16
  221. package/docs/generated-docs/maz-input-code.doc.md +0 -25
  222. package/docs/generated-docs/maz-input-number.doc.md +0 -33
  223. package/docs/generated-docs/maz-input-phone-number.doc.md +0 -62
  224. package/docs/generated-docs/maz-input-price.doc.md +0 -26
  225. package/docs/generated-docs/maz-input-tags.doc.md +0 -24
  226. package/docs/generated-docs/maz-input.doc.md +0 -54
  227. package/docs/generated-docs/maz-lazy-img.doc.md +0 -49
  228. package/docs/generated-docs/maz-link.doc.md +0 -31
  229. package/docs/generated-docs/maz-loading-bar.doc.md +0 -6
  230. package/docs/generated-docs/maz-markdown-editor.doc.md +0 -65
  231. package/docs/generated-docs/maz-pagination.doc.md +0 -21
  232. package/docs/generated-docs/maz-popover.doc.md +0 -79
  233. package/docs/generated-docs/maz-pull-to-refresh.doc.md +0 -50
  234. package/docs/generated-docs/maz-radio-buttons.doc.md +0 -34
  235. package/docs/generated-docs/maz-radio.doc.md +0 -33
  236. package/docs/generated-docs/maz-read-more.doc.md +0 -18
  237. package/docs/generated-docs/maz-reading-progress-bar.doc.md +0 -18
  238. package/docs/generated-docs/maz-select-country.doc.md +0 -45
  239. package/docs/generated-docs/maz-select.doc.md +0 -32
  240. package/docs/generated-docs/maz-sidebar-content.doc.md +0 -5
  241. package/docs/generated-docs/maz-sidebar-footer.doc.md +0 -5
  242. package/docs/generated-docs/maz-sidebar-group.doc.md +0 -11
  243. package/docs/generated-docs/maz-sidebar-header.doc.md +0 -5
  244. package/docs/generated-docs/maz-sidebar-menu-button.doc.md +0 -27
  245. package/docs/generated-docs/maz-sidebar-menu-item.doc.md +0 -5
  246. package/docs/generated-docs/maz-sidebar-menu-sub.doc.md +0 -16
  247. package/docs/generated-docs/maz-sidebar-menu.doc.md +0 -5
  248. package/docs/generated-docs/maz-sidebar-separator.doc.md +0 -0
  249. package/docs/generated-docs/maz-sidebar-trigger.doc.md +0 -5
  250. package/docs/generated-docs/maz-sidebar.doc.md +0 -36
  251. package/docs/generated-docs/maz-skeleton.doc.md +0 -12
  252. package/docs/generated-docs/maz-slider.doc.md +0 -20
  253. package/docs/generated-docs/maz-spinner.doc.md +0 -6
  254. package/docs/generated-docs/maz-stepper.doc.md +0 -30
  255. package/docs/generated-docs/maz-switch.doc.md +0 -31
  256. package/docs/generated-docs/maz-table-cell.doc.md +0 -5
  257. package/docs/generated-docs/maz-table-row.doc.md +0 -12
  258. package/docs/generated-docs/maz-table-title.doc.md +0 -5
  259. package/docs/generated-docs/maz-table-virtualizer.doc.md +0 -20
  260. package/docs/generated-docs/maz-table.doc.md +0 -72
  261. package/docs/generated-docs/maz-tabs-bar.doc.md +0 -29
  262. package/docs/generated-docs/maz-tabs-content-item.doc.md +0 -11
  263. package/docs/generated-docs/maz-tabs-content.doc.md +0 -5
  264. package/docs/generated-docs/maz-tabs.doc.md +0 -20
  265. package/docs/generated-docs/maz-textarea.doc.md +0 -46
  266. package/docs/generated-docs/maz-ticker.doc.md +0 -25
  267. package/docs/generated-docs/maz-timeline.doc.md +0 -32
  268. package/docs/generated-docs/maz-ui-provider.doc.md +0 -12
  269. package/docs/generated-docs/maz-window-mockup.doc.md +0 -23
  270. package/docs/src/blog/v4.md +0 -276
  271. package/docs/src/blog/v5.md +0 -184
  272. package/docs/src/changelog.md +0 -7
  273. package/docs/src/components/index.md +0 -8
  274. package/docs/src/components/maz-accordion.md +0 -80
  275. package/docs/src/components/maz-animated-counter.md +0 -124
  276. package/docs/src/components/maz-animated-element.md +0 -36
  277. package/docs/src/components/maz-animated-text.md +0 -36
  278. package/docs/src/components/maz-avatar.md +0 -227
  279. package/docs/src/components/maz-backdrop.md +0 -250
  280. package/docs/src/components/maz-bottom-sheet.md +0 -533
  281. package/docs/src/components/maz-card-spotlight.md +0 -163
  282. package/docs/src/components/maz-carousel.md +0 -231
  283. package/docs/src/components/maz-checkbox.md +0 -168
  284. package/docs/src/components/maz-checklist.md +0 -414
  285. package/docs/src/components/maz-circular-progress-bar.md +0 -145
  286. package/docs/src/components/maz-container.md +0 -363
  287. package/docs/src/components/maz-dialog-confirm.md +0 -240
  288. package/docs/src/components/maz-dialog.md +0 -164
  289. package/docs/src/components/maz-drawer.md +0 -181
  290. package/docs/src/components/maz-dropdown.md +0 -691
  291. package/docs/src/components/maz-expand-animation.md +0 -99
  292. package/docs/src/components/maz-fullscreen-loader.md +0 -58
  293. package/docs/src/components/maz-gallery.md +0 -85
  294. package/docs/src/components/maz-input-code.md +0 -61
  295. package/docs/src/components/maz-input-number.md +0 -81
  296. package/docs/src/components/maz-input-phone-number.md +0 -942
  297. package/docs/src/components/maz-input-price.md +0 -67
  298. package/docs/src/components/maz-input-tags.md +0 -114
  299. package/docs/src/components/maz-lazy-img.md +0 -88
  300. package/docs/src/components/maz-link.md +0 -178
  301. package/docs/src/components/maz-loading-bar.md +0 -26
  302. package/docs/src/components/maz-pagination.md +0 -79
  303. package/docs/src/components/maz-popover.md +0 -1416
  304. package/docs/src/components/maz-radio-buttons.md +0 -462
  305. package/docs/src/components/maz-radio.md +0 -142
  306. package/docs/src/components/maz-reading-progress-bar.md +0 -74
  307. package/docs/src/components/maz-spinner.md +0 -93
  308. package/docs/src/components/maz-switch.md +0 -92
  309. package/docs/src/components/maz-table.md +0 -732
  310. package/docs/src/components/maz-textarea.md +0 -400
  311. package/docs/src/components/maz-ticker.md +0 -692
  312. package/docs/src/components/maz-timeline.md +0 -478
  313. package/docs/src/composables/use-aos.md +0 -34
  314. package/docs/src/composables/use-breakpoints.md +0 -35
  315. package/docs/src/composables/use-dialog.md +0 -88
  316. package/docs/src/composables/use-string-matching.md +0 -63
  317. package/docs/src/composables/use-toast.md +0 -71
  318. package/docs/src/composables/use-wait.md +0 -62
  319. package/docs/src/composables/use-window-size.md +0 -18
  320. package/docs/src/ecosystem/icons/icon-set.md +0 -123
  321. package/docs/src/ecosystem/mcp.md +0 -210
  322. package/docs/src/ecosystem/node/index.md +0 -53
  323. package/docs/src/ecosystem/utils/camel-case.md +0 -31
  324. package/docs/src/ecosystem/utils/capitalize.md +0 -50
  325. package/docs/src/ecosystem/utils/country-code-to-unicode-flag.md +0 -213
  326. package/docs/src/ecosystem/utils/debounce-callback.md +0 -38
  327. package/docs/src/ecosystem/utils/fetch-locale-ip.md +0 -33
  328. package/docs/src/ecosystem/utils/get-browser-locale.md +0 -29
  329. package/docs/src/ecosystem/utils/get-country-flag-url.md +0 -156
  330. package/docs/src/ecosystem/utils/is-server.md +0 -31
  331. package/docs/src/ecosystem/utils/is-standalone-mode.md +0 -43
  332. package/docs/src/ecosystem/utils/truthy-filter.md +0 -31
  333. package/docs/src/ecosystem/utils/types/deep-required.md +0 -39
  334. package/docs/src/ecosystem/utils/types/flatten-object-keys.md +0 -44
  335. package/docs/src/ecosystem/utils/upper-first.md +0 -32
  336. package/docs/src/guide/cli.md +0 -144
  337. package/docs/src/guide/migration-v4.md +0 -925
  338. package/docs/src/guide/tailwind.md +0 -158
  339. package/docs/src/index.md +0 -603
  340. package/docs/src/made-with-maz-ui.md +0 -58
  341. package/docs/src/plugins/toast.md +0 -349
  342. package/docs/src/plugins/wait.md +0 -109
  343. package/docs/src/theme-editor.md +0 -21
@@ -1,349 +0,0 @@
1
- ---
2
- title: Toast
3
- description: A powerful toast notification system for Vue.js that displays user-friendly messages with customizable positioning, styling, and behavior options
4
- ---
5
-
6
- # {{ $frontmatter.title }}
7
-
8
- {{ $frontmatter.description }}
9
-
10
- ::: tip
11
- This plugin has a composable for easier use, after installing it you can use [useToast](./../composables/use-toast.md)
12
- :::
13
-
14
- ## Installation
15
-
16
- ::: code-group
17
-
18
- ```ts [Vue]
19
- import { ToastPlugin } from 'maz-ui/plugins/toast'
20
- import { createApp } from 'vue'
21
-
22
- const app = createApp(App)
23
-
24
- const toastOptions: ToastOptions = {
25
- position: 'bottom-right',
26
- timeout: 10_000,
27
- persistent: false,
28
- }
29
-
30
- app.use(ToastPlugin, toastOptions)
31
- app.mount('#app')
32
- ```
33
-
34
- ```ts [Nuxt]
35
- export default defineNuxtConfig({
36
- modules: ['@maz-ui/nuxt'],
37
- mazUi: {
38
- composables: {
39
- useToast: true,
40
- },
41
- },
42
- })
43
- ```
44
-
45
- :::
46
-
47
- ## Basic usage
48
-
49
- <ComponentDemo expanded>
50
- <div class="maz:flex maz:flex-wrap maz:gap-2">
51
- <MazBtn color="contrast" @click="toast.message('Message text')">
52
- Message
53
- </MazBtn>
54
- <MazBtn color="info" @click="toast.info('Info message', { position: 'top', button: { href: 'https://www.loicmazuel.com' } })">
55
- Info toast on top
56
- </MazBtn>
57
- <MazBtn color="destructive" @click="toast.error('Error message', { position: 'bottom', timeout: 1000 })">
58
- Error toast on bottom with 1s timeout
59
- </MazBtn>
60
- <MazBtn color="warning" @click="toast.warning('Warning message', { position: 'top-right' })">
61
- Warning toast on top right
62
- </MazBtn>
63
- <MazBtn color="contrast" @click="toast.message(`<ul><li>Item <b>1</b></li><li>Item <b>2</b></li><li>Item <b>3</b></li></ul>`, { position: 'bottom-left', html: true })">
64
- Toast with html content
65
- </MazBtn>
66
- <MazBtn color="contrast" @click="toast.message('No timeout toast', { timeout: false })">
67
- Persistent with no timeout
68
- </MazBtn>
69
-
70
- </div>
71
-
72
- <template #code>
73
-
74
- ```vue
75
- <script lang="ts" setup>
76
- import { useToast } from 'maz-ui/composables/useToast'
77
-
78
- const toast = useToast()
79
- </script>
80
-
81
- <template>
82
- <MazBtn color="contrast" @click="toast.message('Message text')">
83
- Message
84
- </MazBtn>
85
- <MazBtn color="info" @click="toast.info('Info message', { position: 'top', button: { href: 'https://www.loicmazuel.com' } })">
86
- Info toast on top
87
- </MazBtn>
88
- <MazBtn color="destructive" @click="toast.error('Error message', { position: 'bottom', timeout: 1000 })">
89
- Error toast on bottom with 1s timeout
90
- </MazBtn>
91
- <MazBtn color="warning" @click="toast.warning('Warning message', { position: 'top-right' })">
92
- Warning toast on top right
93
- </MazBtn>
94
- <MazBtn color="contrast" @click="toast.message(`<ul><li>Item <b>1</b></li><li>Item <b>2</b></li><li>Item <b>3</b></li></ul>`, { position: 'bottom-left', html: true })">
95
- Toast with html content
96
- </MazBtn>
97
- <MazBtn color="contrast" @click="toast.message('No timeout toast', { timeout: false })">
98
- Persistent with no timeout
99
- </MazBtn>
100
- </template>
101
- ```
102
-
103
- </template>
104
-
105
- </ComponentDemo>
106
-
107
- ### Action and link
108
-
109
- Toast can have a link or an action
110
-
111
- <ComponentDemo>
112
- <div class="maz:flex maz:flex-wrap maz:gap-2">
113
- <MazBtn color="info" @click="showInfoWithLink">
114
- Toast with link
115
- </MazBtn>
116
- <MazBtn color="warning" @click="showInfoWithExternalLink">
117
- Toast with blank link
118
- </MazBtn>
119
- <MazBtn color="destructive" @click="showInfoWithAction">
120
- Toast with action
121
- </MazBtn>
122
- </div>
123
-
124
- <template #code>
125
-
126
- ```vue
127
- <script lang="ts" setup>
128
- import { useToast } from 'maz-ui/composables/useToast'
129
-
130
- const toast = useToast()
131
-
132
- function showInfoWithLink() {
133
- toast.info('Toast with link, click -->', {
134
- button: {
135
- href: 'https://www.loicmazuel.com',
136
- }
137
- })
138
- }
139
-
140
- function showInfoWithExternalLink() {
141
- toast.warning('Toast with link', {
142
- button: {
143
- href: 'https://www.loicmazuel.com',
144
- target: '_blank',
145
- closeToast: true,
146
- text: 'Follow link'
147
- }
148
- })
149
- }
150
-
151
- function showInfoWithAction() {
152
- toast.error('Toast with action', {
153
- button: {
154
- onClick: () => new Promise((resolve) => {
155
- sleep(3000)
156
- resolve()
157
- toast.success('Promise executed')
158
- }),
159
- text: 'Exec promise',
160
- closeToast: true,
161
- },
162
- })
163
- }
164
- </script>
165
-
166
- <template>
167
- <MazBtn color="info" @click="showInfoWithLink">
168
- Toast with link
169
- </MazBtn>
170
- <MazBtn color="warning" @click="showInfoWithExternalLink">
171
- Toast with blank link
172
- </MazBtn>
173
- <MazBtn color="destructive" @click="showInfoWithAction">
174
- Toast with action
175
- </MazBtn>
176
- </template>
177
- ```
178
-
179
- </template>
180
- </ComponentDemo>
181
-
182
- ## Close toast programmatically
183
-
184
- You can close a toast programmatically by using the `close` method returned by the `toast` function
185
-
186
- <div class="maz:flex maz:flex-wrap maz:gap-2">
187
- <MazBtn color="primary" @click="showToastAutoCLose">
188
- Show toast
189
- </MazBtn>
190
- </div>
191
-
192
- ```typescript
193
- function showToast() {
194
- const toastMessage = toast.message('Toast message closed by code')
195
-
196
- setTimeout(() => {
197
- toastMessage.close()
198
- }, 2000)
199
- }
200
- ```
201
-
202
- ### Type
203
-
204
- ```ts
205
- interface ToastOptions {
206
- /**
207
- * The position of the toast on the screen
208
- * @default 'bottom-right'
209
- */
210
- position?: ToastPosition
211
- /**
212
- * The timeout is in ms, it's the time before the toast is automatically closed
213
- * if set to `false`, the toast will not be closed automatically
214
- * @default 10000
215
- */
216
- timeout?: number | boolean
217
- /**
218
- * If the toast is persistent, it can't be closed by user interaction (only on timeout or programmatically)
219
- * @default false
220
- */
221
- persistent?: boolean
222
- /**
223
- * Display an icon in the toast
224
- * @default true
225
- */
226
- icon?: boolean
227
- /**
228
- * The action will be displayed as a button in the toast
229
- * @default undefined
230
- */
231
- button?: MazBtnProps & {
232
- text: string
233
- onClick: () => unknown
234
- href?: string
235
- text?: string
236
- /** @default _self */
237
- target?: string
238
- /** @default false */
239
- closeToast?: boolean
240
- }
241
- buttons?: (MazBtnProps & {
242
- text: string
243
- onClick: () => unknown
244
- href?: string
245
- text?: string
246
- /** @default _self */
247
- target?: string
248
- /** @default false */
249
- closeToast?: boolean
250
- })[]
251
- /**
252
- * If the toast is queued, it will be displayed in the order of the toasts
253
- * @default false
254
- */
255
- queue?: boolean
256
- /**
257
- * The maximum number of toasts to display
258
- * @default false
259
- */
260
- maxToasts?: number | boolean
261
- /**
262
- * If the toast is paused on hover, it will be paused when the mouse is over the toast
263
- * @default true
264
- */
265
- pauseOnHover?: boolean
266
- /**
267
- * If the message is HTML
268
- * @default false
269
- */
270
- html?: boolean
271
- }
272
- ```
273
-
274
- <script lang="ts" setup>
275
- import { useToast } from 'maz-ui/composables/useToast'
276
- import { sleep } from '@maz-ui/utils'
277
-
278
- const toast = useToast()
279
-
280
- function showToastAutoCLose () {
281
- const toastMessage = toast.message('Toast message closed by code')
282
-
283
- setTimeout(() => {
284
- toastMessage.close()
285
- }, 3000)
286
- }
287
-
288
- function showMessage () {
289
- const t = toast.message('Message text')
290
- }
291
-
292
- function showInfo () {
293
- toast.info('Info message', {
294
- position: 'top',
295
- })
296
- }
297
-
298
- function showError () {
299
- toast.error('Error message', {
300
- position: 'bottom',
301
- timeout: 1000,
302
- })
303
- }
304
-
305
- function showWarning () {
306
- toast.warning('Warning message', {
307
- position: 'top-right',
308
- })
309
- }
310
-
311
- function showSuccess () {
312
- toast.success('Success message', {
313
- position: 'bottom-left',
314
- persistent: true,
315
- })
316
- }
317
-
318
- function showInfoWithLink () {
319
- toast.info('Toast with link, click -->', {
320
- button: {
321
- href: 'https://www.loicmazuel.com',
322
- }
323
- })
324
- }
325
-
326
- function showInfoWithExternalLink () {
327
- toast.warning('Toast with link', {
328
- button: {
329
- href: 'https://www.loicmazuel.com',
330
- target: '_blank',
331
- closeToast: true,
332
- text: 'Follow link'
333
- }
334
- })
335
- }
336
-
337
- function showInfoWithAction () {
338
- toast.error('Toast with action', {
339
- button: {
340
- onClick: () => new Promise(async (resolve) => {
341
- await sleep(3000)
342
- resolve()
343
- }),
344
- text: 'Exec promise',
345
- closeToast: true
346
- }
347
- })
348
- }
349
- </script>
@@ -1,109 +0,0 @@
1
- ---
2
- title: wait
3
- description: A comprehensive loading state management plugin for Vue.js that provides easy-to-use utilities for handling async operations, loading indicators, and user feedback during data processing or any other async operation
4
- ---
5
-
6
- # {{ $frontmatter.title }}
7
-
8
- {{ $frontmatter.description }}
9
-
10
- ::: tip
11
- This plugin has a composable for easier use, after installing it you can use [useWait](./../composables/use-wait.md)
12
- :::
13
-
14
- ## Installation
15
-
16
- ::: code-group
17
-
18
- ```ts [Vue]
19
- import { WaitPlugin } from 'maz-ui/plugins/wait'
20
- import { createApp } from 'vue'
21
-
22
- const app = createApp(App)
23
-
24
- app.use(WaitPlugin)
25
- app.mount('#app')
26
- ```
27
-
28
- ```ts [Nuxt]
29
- export default defineNuxtConfig({
30
- modules: ['@maz-ui/nuxt'],
31
- mazUi: {
32
- composables: {
33
- useWait: true,
34
- },
35
- },
36
- })
37
- ```
38
-
39
- :::
40
-
41
- ## Basic usage
42
-
43
- <MazBtn @click="submitData" :loading="wait.isLoading('DATA_SUBMITTING')">
44
- Submit Data
45
- </MazBtn>
46
-
47
- <br />
48
-
49
- <div v-if="submitted" style="padding: 20px; background-color: var(--maz-surface-300); border-radius: 10px; margin-top: 1rem;">
50
- Data Submitted
51
- </div>
52
-
53
- ```vue
54
- <script lang="ts" setup>
55
- import { useWait } from 'maz-ui/composables'
56
- import { ref } from 'vue'
57
-
58
- const wait = useWait()
59
-
60
- const submitted = ref(false)
61
-
62
- function sleep(ms: number) {
63
- return new Promise(resolve => setTimeout(resolve, ms))
64
- }
65
-
66
- async function submitData() {
67
- submitted.value = false
68
- wait.start('DATA_SUBMITTING')
69
-
70
- await sleep(2000)
71
-
72
- submitted.value = true
73
- wait.stop('DATA_SUBMITTING')
74
- }
75
- </script>
76
-
77
- <template>
78
- <MazBtn :loading="wait.isLoading('DATA_SUBMITTING')" @click="submitData">
79
- Submit Data
80
- </MazBtn>
81
-
82
- <div v-if="submitted">
83
- Data Submitted
84
- </div>
85
- </template>
86
- ```
87
-
88
- <script lang="ts" setup>
89
- import { ref } from 'vue'
90
- import { useWait } from 'maz-ui/composables/useWait'
91
-
92
- const wait = useWait()
93
-
94
- const submitted = ref(false)
95
-
96
- function sleep(ms: number) {
97
- return new Promise(resolve => setTimeout(resolve, ms));
98
- }
99
-
100
- const submitData = async () => {
101
- submitted.value = false
102
- wait.start('DATA_SUBMITTING')
103
-
104
- await sleep(2000)
105
-
106
- submitted.value = true
107
- wait.stop('DATA_SUBMITTING')
108
- }
109
- </script>
@@ -1,21 +0,0 @@
1
- ---
2
- title: Theme Editor
3
- description: Create your own theme for maz-ui and export it to use it in your project
4
- layout: home
5
- sidebar: false
6
- ---
7
-
8
- <br />
9
- <br />
10
-
11
- # {{ $frontmatter.title }}
12
-
13
- {{ $frontmatter.description }}
14
-
15
- <br />
16
-
17
- <ThemeEditorPage />
18
-
19
- <script setup lang="ts">
20
- import ThemeEditorPage from '../components/ThemeEditorPage.vue'
21
- </script>