@maz-ui/mcp 5.0.0-beta.3 → 5.0.0-beta.31
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 +1 -1
- package/dist/mcp.d.mts +22 -9
- package/dist/mcp.d.ts +22 -9
- package/dist/mcp.mjs +160 -83
- package/docs/generated-docs/maz-avatar.doc.md +30 -30
- package/docs/generated-docs/maz-btn.doc.md +3 -2
- package/docs/generated-docs/maz-checkbox.doc.md +16 -17
- package/docs/generated-docs/maz-circular-progress-bar.doc.md +1 -1
- package/docs/generated-docs/maz-code-highlight.doc.md +11 -0
- package/docs/generated-docs/maz-container.doc.md +1 -0
- package/docs/generated-docs/maz-date-picker.doc.md +41 -41
- package/docs/generated-docs/maz-drawer.doc.md +7 -8
- package/docs/generated-docs/maz-dropdown.doc.md +3 -0
- package/docs/generated-docs/maz-expand-animation.doc.md +4 -4
- package/docs/generated-docs/maz-fullscreen-loader.doc.md +5 -5
- package/docs/generated-docs/maz-gallery.doc.md +15 -15
- package/docs/generated-docs/maz-input-code.doc.md +16 -16
- package/docs/generated-docs/maz-input-phone-number.doc.md +42 -38
- package/docs/generated-docs/maz-input-price.doc.md +14 -14
- package/docs/generated-docs/maz-input-tags.doc.md +16 -16
- package/docs/generated-docs/maz-input.doc.md +33 -33
- package/docs/generated-docs/maz-lazy-img.doc.md +14 -14
- package/docs/generated-docs/maz-loading-bar.doc.md +4 -4
- package/docs/generated-docs/maz-markdown-editor.doc.md +65 -0
- package/docs/generated-docs/maz-popover.doc.md +1 -1
- package/docs/generated-docs/maz-pull-to-refresh.doc.md +10 -10
- package/docs/generated-docs/maz-radio-buttons.doc.md +17 -17
- package/docs/generated-docs/maz-radio.doc.md +16 -16
- package/docs/generated-docs/maz-reading-progress-bar.doc.md +4 -4
- package/docs/generated-docs/maz-sidebar-content.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar-footer.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar-group.doc.md +11 -0
- package/docs/generated-docs/maz-sidebar-header.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar-menu-button.doc.md +27 -0
- package/docs/generated-docs/maz-sidebar-menu-item.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar-menu-sub.doc.md +16 -0
- package/docs/generated-docs/maz-sidebar-menu.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar-separator.doc.md +0 -0
- package/docs/generated-docs/maz-sidebar-trigger.doc.md +5 -0
- package/docs/generated-docs/maz-sidebar.doc.md +36 -0
- package/docs/generated-docs/maz-slider.doc.md +1 -1
- package/docs/generated-docs/maz-spinner.doc.md +4 -4
- package/docs/generated-docs/maz-switch.doc.md +14 -14
- package/docs/generated-docs/maz-table.doc.md +5 -5
- package/docs/generated-docs/maz-textarea.doc.md +25 -24
- package/docs/generated-docs/maz-ticker.doc.md +1 -1
- package/docs/generated-docs/maz-timeline.doc.md +4 -4
- package/docs/generated-docs/maz-window-mockup.doc.md +23 -0
- package/docs/src/blog/v4.md +1 -1
- package/docs/src/blog/v5.md +5 -7
- package/docs/src/components/maz-avatar.md +29 -0
- package/docs/src/components/maz-btn.md +1 -1
- package/docs/src/components/maz-code-highlight.md +233 -0
- package/docs/src/components/maz-container.md +2 -2
- package/docs/src/components/maz-date-picker.md +1 -1
- package/docs/src/components/maz-dialog.md +46 -0
- package/docs/src/components/maz-dropdown.md +32 -16
- package/docs/src/components/maz-icon.md +2 -2
- package/docs/src/components/maz-input-phone-number.md +106 -103
- package/docs/src/components/maz-markdown-editor.md +369 -0
- package/docs/src/components/maz-sidebar.md +719 -0
- package/docs/src/components/maz-textarea.md +27 -1
- package/docs/src/components/maz-timeline.md +60 -0
- package/docs/src/components/maz-window-mockup.md +249 -0
- package/docs/src/composables/use-form-validator.md +50 -11
- package/docs/src/directives/click-outside.md +8 -15
- package/docs/src/directives/fullscreen-img.md +1 -1
- package/docs/src/directives/lazy-img.md +5 -5
- package/docs/src/directives/tooltip.md +24 -1
- package/docs/src/directives/zoom-img.md +1 -1
- package/docs/src/ecosystem/eslint-config.md +95 -1
- package/docs/src/{guide/icons.md → ecosystem/icons/index.md} +1 -1
- package/docs/src/ecosystem/node/exec-promise.md +87 -0
- package/docs/src/ecosystem/node/index.md +53 -0
- package/docs/src/ecosystem/node/logger.md +146 -0
- package/docs/src/ecosystem/node/print-banner.md +93 -0
- package/docs/src/{guide → ecosystem}/nuxt.md +81 -47
- package/docs/src/{guide → ecosystem}/themes.md +153 -72
- package/docs/src/{guide → ecosystem}/translations.md +1 -1
- package/docs/src/ecosystem/utils/camel-case.md +31 -0
- package/docs/src/{helpers → ecosystem/utils}/capitalize.md +2 -3
- package/docs/src/ecosystem/utils/check-availability.md +79 -0
- package/docs/src/ecosystem/utils/cookie.md +80 -0
- package/docs/src/{helpers → ecosystem/utils}/currency.md +2 -2
- package/docs/src/{helpers → ecosystem/utils}/date.md +2 -2
- package/docs/src/ecosystem/utils/debounce-callback.md +38 -0
- package/docs/src/ecosystem/utils/debounce-id.md +69 -0
- package/docs/src/ecosystem/utils/debounce.md +65 -0
- package/docs/src/ecosystem/utils/fetch-locale-ip.md +33 -0
- package/docs/src/ecosystem/utils/format-json.md +33 -0
- package/docs/src/ecosystem/utils/format-phone-number.md +37 -0
- package/docs/src/ecosystem/utils/get-browser-locale.md +29 -0
- package/docs/src/ecosystem/utils/get-error-message.md +39 -0
- package/docs/src/ecosystem/utils/idle-timeout.md +90 -0
- package/docs/src/ecosystem/utils/index.md +60 -0
- package/docs/src/ecosystem/utils/is-client.md +32 -0
- package/docs/src/ecosystem/utils/is-equal.md +38 -0
- package/docs/src/ecosystem/utils/is-server.md +31 -0
- package/docs/src/ecosystem/utils/is-standalone-mode.md +43 -0
- package/docs/src/ecosystem/utils/kebab-case.md +36 -0
- package/docs/src/ecosystem/utils/normalize-string.md +77 -0
- package/docs/src/{helpers → ecosystem/utils}/number.md +2 -2
- package/docs/src/ecosystem/utils/pascal-case.md +35 -0
- package/docs/src/ecosystem/utils/script-loader.md +77 -0
- package/docs/src/ecosystem/utils/sleep.md +59 -0
- package/docs/src/ecosystem/utils/snake-case.md +36 -0
- package/docs/src/ecosystem/utils/swipe-handler.md +91 -0
- package/docs/src/ecosystem/utils/textarea-autogrow.md +41 -0
- package/docs/src/ecosystem/utils/throttle-id.md +48 -0
- package/docs/src/ecosystem/utils/throttle.md +57 -0
- package/docs/src/ecosystem/utils/truthy-filter.md +31 -0
- package/docs/src/ecosystem/utils/types/deep-key-of.md +48 -0
- package/docs/src/ecosystem/utils/types/deep-partial.md +42 -0
- package/docs/src/ecosystem/utils/types/deep-required.md +39 -0
- package/docs/src/ecosystem/utils/types/flatten-object-keys.md +44 -0
- package/docs/src/ecosystem/utils/types/generic-instance-type.md +42 -0
- package/docs/src/ecosystem/utils/types/infer-maybe-ref.md +35 -0
- package/docs/src/ecosystem/utils/upper-first.md +32 -0
- package/docs/src/ecosystem/utils/user-visibility.md +69 -0
- package/docs/src/guide/getting-started.md +15 -13
- package/docs/src/guide/global-defaults.md +101 -0
- package/docs/src/guide/maz-ui-provider.md +6 -3
- package/docs/src/guide/migration-v4.md +13 -9
- package/docs/src/guide/migration-v5.md +112 -13
- package/docs/src/guide/resolvers.md +7 -7
- package/docs/src/guide/tailwind.md +4 -0
- package/docs/src/guide/vue.md +4 -4
- package/docs/src/index.md +12 -12
- package/docs/src/plugins/aos.md +1 -1
- package/docs/src/plugins/wait.md +1 -1
- package/package.json +8 -7
- package/docs/src/helpers/camel-case.md +0 -14
- package/docs/src/helpers/check-availability.md +0 -14
- package/docs/src/helpers/debounce-callback.md +0 -14
- package/docs/src/helpers/debounce-id.md +0 -14
- package/docs/src/helpers/debounce.md +0 -14
- package/docs/src/helpers/is-client.md +0 -14
- package/docs/src/helpers/is-equal.md +0 -14
- package/docs/src/helpers/is-standalone-mode.md +0 -14
- package/docs/src/helpers/kebab-case.md +0 -14
- package/docs/src/helpers/normalize-string.md +0 -14
- package/docs/src/helpers/pascal-case.md +0 -14
- package/docs/src/helpers/script-loader.md +0 -14
- package/docs/src/helpers/sleep.md +0 -14
- package/docs/src/helpers/snake-case.md +0 -14
- package/docs/src/helpers/throttle-id.md +0 -14
- package/docs/src/helpers/throttle.md +0 -14
- /package/docs/src/{guide → ecosystem/icons}/icon-set.md +0 -0
- /package/docs/src/{guide → ecosystem}/mcp.md +0 -0
- /package/docs/src/{helpers → ecosystem/utils}/country-code-to-unicode-flag.md +0 -0
- /package/docs/src/{helpers → ecosystem/utils}/get-country-flag-url.md +0 -0
|
@@ -1,43 +1,47 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description
|
|
4
|
-
| ----------------------------- |
|
|
5
|
-
| **style** | Style attribut of the component root element
|
|
6
|
-
| **class** | Class attribut of the component root element
|
|
7
|
-
| **model-value** | `v-model` <br/>The current value of the input field in international format (e.g. +33612345678)<br/>**Example:** `"+33612345678"`
|
|
8
|
-
| **country-code** | `v-model:country-code` <br/>The selected country code (e.g. "FR")<br/>**Example:** `"FR"`
|
|
9
|
-
| **id** | Unique identifier for the component<br/>**Example:** `"phone-input-1"`
|
|
10
|
-
| **placeholder** | Text displayed when the input is empty<br/>**Example:** `"Enter your phone number"`
|
|
11
|
-
| **label**
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **search
|
|
25
|
-
| **
|
|
26
|
-
| **
|
|
27
|
-
| **
|
|
28
|
-
| **
|
|
29
|
-
| **
|
|
30
|
-
| **
|
|
31
|
-
| **
|
|
32
|
-
| **
|
|
33
|
-
| **validation-
|
|
34
|
-
| **success**
|
|
35
|
-
| **
|
|
36
|
-
| **
|
|
37
|
-
| **
|
|
38
|
-
| **
|
|
39
|
-
| **
|
|
40
|
-
| **
|
|
3
|
+
| Name | Description | Type | Required | Default | Possible values |
|
|
4
|
+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
5
|
+
| **style** | Style attribut of the component root element | `HTMLAttributes['style']` | No | `undefined` | - |
|
|
6
|
+
| **class** | Class attribut of the component root element | `HTMLAttributes['class']` | No | `undefined` | - |
|
|
7
|
+
| **model-value** | `v-model` <br/>The current value of the input field in international format (e.g. +33612345678)<br/>**Example:** `"+33612345678"` | `string \| undefined \| null` | No | `undefined` | - |
|
|
8
|
+
| **country-code** | `v-model:country-code` <br/>The selected country code (e.g. "FR")<br/>**Example:** `"FR"` | `CountryCode \| undefined \| null` | No | `undefined` | - |
|
|
9
|
+
| **id** | Unique identifier for the component<br/>**Example:** `"phone-input-1"` | `string` | No | `undefined` | - |
|
|
10
|
+
| **placeholder** | Text displayed when the input is empty<br/>**Example:** `"Enter your phone number"` | `string` | No | `undefined` | - |
|
|
11
|
+
| **top-label** | Static label displayed above the input field. Unlike the floating label, this remains fixed<br/>**Example:** `"User Information"` | `string` | No | `undefined` | - |
|
|
12
|
+
| **label** | Label displayed above the input<br/>**Example:** `"Phone Number"` | `string` | No | `undefined` | - |
|
|
13
|
+
| **preferred-countries** | List of country codes to place first in the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
|
|
14
|
+
| **ignored-countries** | List of country codes to be removed from the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
|
|
15
|
+
| **only-countries** | List of country codes to only have the countries selected in the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
|
|
16
|
+
| **translations** | Locale strings of the component The default values are the translations of the MazUiTranslations plugin | `Partial<MazUiTranslationsNestedSchema['inputPhoneNumber']>` | No | `{ countrySelect: { error: 'Choose country', placeholder: 'Country code', searchPlaceholder: 'Search the country', }, phoneInput: { placeholder: 'Phone number', example: 'Example: {example}', }, }` | - |
|
|
17
|
+
| **list-position** | Position where the list of countries will be opened | `MazPopoverProps['position']` | No | `bottom left` | `top left, top right, bottom left, bottom right` |
|
|
18
|
+
| **color** | Component color applied | `MazColor` | No | `primary` | `primary, secondary, accent, info, success, warning, destructive, contrast` |
|
|
19
|
+
| **size** | Component size applied | `MazSize` | No | `md` | `xs, sm, md, lg, xl, mini` |
|
|
20
|
+
| **hide-flags** | Remove flags in country list | `boolean` | No | `false` | - |
|
|
21
|
+
| **disabled** | Make the input disabled | `boolean` | No | `false` | - |
|
|
22
|
+
| **required** | Make the input required | `boolean` | No | `false` | - |
|
|
23
|
+
| **example** | Show the phone number example | `boolean` | No | `true` | - |
|
|
24
|
+
| **search** | Disable search input in country list | `boolean` | No | `true` | - |
|
|
25
|
+
| **search-threshold** | Threshold of the search input in country list where 1 is a perfect match and 0 is a match with any character | `number` | No | `0.75` | - |
|
|
26
|
+
| **use-browser-locale** | If true, the browser locale will be used | `boolean` | No | `true` | - |
|
|
27
|
+
| **fetch-country** | The component will make a request (https://ipwho.is) to get the location of the user and use it to set the default country code | `boolean` | No | `false` | - |
|
|
28
|
+
| **hide-country-select** | Hide the country selector | `boolean` | No | `false` | - |
|
|
29
|
+
| **show-code-in-list** | Show country calling code in the country list | `boolean` | No | `false` | - |
|
|
30
|
+
| **custom-countries-list** | Replace country names | `Record<CountryCode, string>` | No | `undefined` | - |
|
|
31
|
+
| **auto-format** | Disabled auto-format when phone is valid | `"blur" \| "typing" \| "disabled" \| false` | No | `blur` | - |
|
|
32
|
+
| **country-locale** | Locale of country list<br/>**Example:** `"fr-FR"` | `string` | No | `undefined` | - |
|
|
33
|
+
| **validation-error** | Disable validation error UI | `boolean` | No | `true` | - |
|
|
34
|
+
| **validation-success** | Disable validation success UI | `boolean` | No | `true` | - |
|
|
35
|
+
| **success** | Add success UI | `boolean` | No | `false` | - |
|
|
36
|
+
| **error** | Add error UI | `boolean` | No | `false` | - |
|
|
37
|
+
| **warning** | Add warning UI | `boolean` | No | `false` | - |
|
|
38
|
+
| **display-country-name** | Will replace the calling code by the country name in the country selector | `boolean` | No | `false` | - |
|
|
39
|
+
| **block** | The input will be displayed in full width | `boolean` | No | `false` | - |
|
|
40
|
+
| **orientation** | Orientation of the inputs in the component | `'row' \| 'col' \| 'responsive'` | No | `responsive` | `row, col, responsive` |
|
|
41
|
+
| **country-select-attributes** | Meta attributes of the country input | `Record<string, unknown>` | No | `{ autocomplete: 'off', name: 'country' }` | - |
|
|
42
|
+
| **phone-input-attributes** | Meta attributes of the phone number input | `Record<string, unknown>` | No | `{ autocomplete: 'tel', name: 'phone', inputmode: 'tel' }` | - |
|
|
43
|
+
| **assistive-text** | Helper text displayed below the input to provide additional context or validation feedback<br/>**Example:** `"Must contain at least 8 characters"` | `string` | No | `undefined` | - |
|
|
44
|
+
| **hint** | Alternative text that replaces the label when provided. Useful for contextual hints<br/>**Example:** `"This phone number is not valid"` | `string` | No | `undefined` | - |
|
|
41
45
|
|
|
42
46
|
## Events
|
|
43
47
|
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type | Required |
|
|
4
|
-
| -------------------- | ---------------------------------------------------------------------------- | --------- | -------- |
|
|
5
|
-
| **model-value** | `v-model` <br/> | `number` | No |
|
|
6
|
-
| **currency** | The currency to use | `string` | No |
|
|
7
|
-
| **locale** | The locale to use | `string` | No |
|
|
8
|
-
| **min** | The minimum value that the input can accept | `number` | No |
|
|
9
|
-
| **max** | The maximum value that the input can accept | `number` | No |
|
|
10
|
-
| **no-icon** | The input will be displayed without icon | `boolean` | No |
|
|
11
|
-
| **block** | The input will be displayed in full width | `boolean` | No |
|
|
12
|
-
| **error** | Will display the input in error state. | `boolean` | No |
|
|
13
|
-
| **hint** | The hint text to display below the input. | `string` | No |
|
|
14
|
-
| **success** | Will display the input in success state. | `boolean` | No |
|
|
15
|
-
| **warning** | Will display the input in warning state. | `boolean` | No |
|
|
16
|
-
| **currency-options** | Options for the currency helper - [see](https://maz-ui.com/helpers/currency) | `Omit` | No |
|
|
3
|
+
| Name | Description | Type | Required |
|
|
4
|
+
| -------------------- | ---------------------------------------------------------------------------- | --------- | -------- |
|
|
5
|
+
| **model-value** | `v-model` <br/> | `number` | No |
|
|
6
|
+
| **currency** | The currency to use | `string` | No |
|
|
7
|
+
| **locale** | The locale to use | `string` | No |
|
|
8
|
+
| **min** | The minimum value that the input can accept | `number` | No |
|
|
9
|
+
| **max** | The maximum value that the input can accept | `number` | No |
|
|
10
|
+
| **no-icon** | The input will be displayed without icon | `boolean` | No |
|
|
11
|
+
| **block** | The input will be displayed in full width | `boolean` | No |
|
|
12
|
+
| **error** | Will display the input in error state. | `boolean` | No |
|
|
13
|
+
| **hint** | The hint text to display below the input. | `string` | No |
|
|
14
|
+
| **success** | Will display the input in success state. | `boolean` | No |
|
|
15
|
+
| **warning** | Will display the input in warning state. | `boolean` | No |
|
|
16
|
+
| **currency-options** | Options for the currency helper - [see](https://maz-ui.com/helpers/currency) | `Omit` | No |
|
|
17
17
|
|
|
18
18
|
## Events
|
|
19
19
|
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type | Required |
|
|
4
|
-
| -------------------- | -------------------------------------------- | ----------------------- | -------- |
|
|
5
|
-
| **style** | Style attribut of the component root element | `Native type` | No |
|
|
6
|
-
| **class** | Class attribut of the component root element | `Native type` | No |
|
|
7
|
-
| **model-value** | `v-model` <br/> | `TSParenthesizedType[]` | No |
|
|
8
|
-
| **placeholder** | The placeholder of the input | `string` | No |
|
|
9
|
-
| **label** | The label of the input | `string` | No |
|
|
10
|
-
| **disabled** | Disable the input | `boolean` | No |
|
|
11
|
-
| **error** | Display the input with error style | `boolean` | No |
|
|
12
|
-
| **success** | Display the input with success style | `boolean` | No |
|
|
13
|
-
| **warning** | Display the input with warning style | `boolean` | No |
|
|
14
|
-
| **size** | The size of the input | `MazSize` | No |
|
|
15
|
-
| **color** | The color of the input | `MazColor` | No |
|
|
16
|
-
| **block** | The input will be displayed in full width | `boolean` | No |
|
|
17
|
-
| **add-tags-on-blur** | Add tags on blur | `boolean` | No |
|
|
18
|
-
| **hint** | The hint text to display below the input. | `string` | No |
|
|
3
|
+
| Name | Description | Type | Required |
|
|
4
|
+
| -------------------- | -------------------------------------------- | ----------------------- | -------- |
|
|
5
|
+
| **style** | Style attribut of the component root element | `Native type` | No |
|
|
6
|
+
| **class** | Class attribut of the component root element | `Native type` | No |
|
|
7
|
+
| **model-value** | `v-model` <br/> | `TSParenthesizedType[]` | No |
|
|
8
|
+
| **placeholder** | The placeholder of the input | `string` | No |
|
|
9
|
+
| **label** | The label of the input | `string` | No |
|
|
10
|
+
| **disabled** | Disable the input | `boolean` | No |
|
|
11
|
+
| **error** | Display the input with error style | `boolean` | No |
|
|
12
|
+
| **success** | Display the input with success style | `boolean` | No |
|
|
13
|
+
| **warning** | Display the input with warning style | `boolean` | No |
|
|
14
|
+
| **size** | The size of the input | `MazSize` | No |
|
|
15
|
+
| **color** | The color of the input | `MazColor` | No |
|
|
16
|
+
| **block** | The input will be displayed in full width | `boolean` | No |
|
|
17
|
+
| **add-tags-on-blur** | Add tags on blur | `boolean` | No |
|
|
18
|
+
| **hint** | The hint text to display below the input. | `string` | No |
|
|
19
19
|
|
|
20
20
|
## Events
|
|
21
21
|
|
|
@@ -1,38 +1,38 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type
|
|
4
|
-
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5
|
-
| **style** | Inline styles to apply to the component root element | `HTMLAttributes['style']`
|
|
6
|
-
| **class** | CSS classes to apply to the component root element | `HTMLAttributes['class']`
|
|
7
|
-
| **model-value** | `v-model` <br/>The current value of the input field. This prop is used for two-way data binding with v-model<br/>**Example:** `<MazInput v-model="inputValue" />` | `T`
|
|
8
|
-
| **placeholder** | Text displayed when the input is empty to guide the user<br/>**Example:** `"Enter your email address"` | `string`
|
|
9
|
-
| **label** | Floating label that appears inside the input and moves up when focused or filled. Provides better UX than traditional placeholders<br/>**Example:** `"Email Address"` | `string`
|
|
10
|
-
| **top-label** | Static label displayed above the input field. Unlike the floating label, this remains fixed<br/>**Example:** `"User Information"` | `string`
|
|
11
|
-
| **assistive-text** | Helper text displayed below the input to provide additional context or validation feedback<br/>**Example:** `"Must contain at least 8 characters"` | `string`
|
|
12
|
-
| **color** | Theme color that affects the border and focus states of the input<br/>**Example:** `"primary"` | `MazColor`
|
|
13
|
-
| **type** | HTML input type attribute that determines the input behavior and validation<br/>**Example:** `"email"` | `InputHTMLAttributes['type']`
|
|
14
|
-
| **required** | Makes the input field mandatory for form submission<br/>**Example:** `true` | `boolean`
|
|
15
|
-
| **disabled** | Disables the input field, preventing user interaction and form submission<br/>**Example:** `false` | `boolean`
|
|
16
|
-
| **readonly** | Makes the input field read-only, allowing selection but preventing modification<br/>**Example:** `false` | `boolean`
|
|
17
|
-
| **id** | Unique identifier for the input element, used for form labels and accessibility<br/>**Example:** `"user-email"` | `string`
|
|
18
|
-
| **error** | Applies error styling (red border and text) to indicate validation failure<br/>**Example:** `true` | `boolean`
|
|
19
|
-
| **success** | Applies success styling (green border and text) to indicate successful validation<br/>**Example:** `true` | `boolean`
|
|
20
|
-
| **warning** | Applies warning styling (orange border and text) to indicate potential issues<br/>**Example:** `true` | `boolean`
|
|
21
|
-
| **hint** | Alternative text that replaces the label when provided. Useful for contextual hints<br/>**Example:** `"Optional field"` | `string`
|
|
22
|
-
| **input-classes** | Additional CSS classes to apply specifically to the input wrapper element<br/>**Example:** `"custom-input-wrapper"` | `string`
|
|
23
|
-
| **border** | Controls whether the input has a visible border. Set to false for borderless inputs<br/>**Example:** `true` | `boolean`
|
|
24
|
-
| **inputmode** | HTML inputmode attribute that provides hints for virtual keyboards on mobile devices<br/>**Example:** `"numeric"` | `InputHTMLAttributes['inputmode']`
|
|
25
|
-
| **size** | Controls the height and text size of the input component<br/>**Example:** `"md"` | `MazSize`
|
|
26
|
-
| **debounce** | Enables input debouncing to limit the frequency of value updates. When true, uses 500ms delay. When a number, uses that value as delay in milliseconds<br/>**Example:** `true` | `boolean \| number`
|
|
27
|
-
| **auto-focus** | Automatically focuses the input when the component mounts<br/>**Example:** `false` | `boolean`
|
|
28
|
-
| **border-active** | When true, shows the colored border immediately instead of only on focus<br/>**Example:** `false` | `boolean`
|
|
29
|
-
| **start-icon** | Icon displayed on the inline-start edge of the input (left in LTR, right in RTL). Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object for fine-grained control (size, title, svgAttributes, fallback, …). | `MazIconLike`
|
|
30
|
-
| **end-icon** | Icon displayed on the inline-end edge of the input (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object. | `MazIconLike`
|
|
31
|
-
| **rounded-size** | Controls the border radius of the input component<br/>**Example:** `"lg"` | `
|
|
32
|
-
| **block** | Makes the input expand to the full width of its container<br/>**Example:** `false` | `boolean`
|
|
33
|
-
| **name** | The name of the input field. Used for form submission and validation<br/>**Example:** `"email"` | `string`
|
|
34
|
-
| **autocomplete** | The autocomplete attribute for the input field. Used for form submission and validation<br/>**Example:** `"email"` | `string`
|
|
35
|
-
| **loading** | Loading state for the input field. Used to show a loading spinner | `boolean`
|
|
3
|
+
| Name | Description | Type | Required | Default | Possible values |
|
|
4
|
+
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------ |
|
|
5
|
+
| **style** | Inline styles to apply to the component root element | `HTMLAttributes['style']` | No | `undefined` | - |
|
|
6
|
+
| **class** | CSS classes to apply to the component root element | `HTMLAttributes['class']` | No | `undefined` | - |
|
|
7
|
+
| **model-value** | `v-model` <br/>The current value of the input field. This prop is used for two-way data binding with v-model<br/>**Example:** `<MazInput v-model="inputValue" />` | `T` | No | `undefined` | - |
|
|
8
|
+
| **placeholder** | Text displayed when the input is empty to guide the user<br/>**Example:** `"Enter your email address"` | `string` | No | `undefined` | - |
|
|
9
|
+
| **label** | Floating label that appears inside the input and moves up when focused or filled. Provides better UX than traditional placeholders<br/>**Example:** `"Email Address"` | `string` | No | `undefined` | - |
|
|
10
|
+
| **top-label** | Static label displayed above the input field. Unlike the floating label, this remains fixed<br/>**Example:** `"User Information"` | `string` | No | `undefined` | - |
|
|
11
|
+
| **assistive-text** | Helper text displayed below the input to provide additional context or validation feedback<br/>**Example:** `"Must contain at least 8 characters"` | `string` | No | `undefined` | - |
|
|
12
|
+
| **color** | Theme color that affects the border and focus states of the input<br/>**Example:** `"primary"` | `MazColor` | No | `undefined` | `primary, secondary, accent, info, success, warning, destructive, contrast` |
|
|
13
|
+
| **type** | HTML input type attribute that determines the input behavior and validation<br/>**Example:** `"email"` | `InputHTMLAttributes['type']` | No | `undefined` | `text, password, email, number, tel, url, search, date, time, datetime-local, month, week` |
|
|
14
|
+
| **required** | Makes the input field mandatory for form submission<br/>**Example:** `true` | `boolean` | No | `undefined` | - |
|
|
15
|
+
| **disabled** | Disables the input field, preventing user interaction and form submission<br/>**Example:** `false` | `boolean` | No | `undefined` | - |
|
|
16
|
+
| **readonly** | Makes the input field read-only, allowing selection but preventing modification<br/>**Example:** `false` | `boolean` | No | `undefined` | - |
|
|
17
|
+
| **id** | Unique identifier for the input element, used for form labels and accessibility<br/>**Example:** `"user-email"` | `string` | No | `undefined` | - |
|
|
18
|
+
| **error** | Applies error styling (red border and text) to indicate validation failure<br/>**Example:** `true` | `boolean` | No | `undefined` | - |
|
|
19
|
+
| **success** | Applies success styling (green border and text) to indicate successful validation<br/>**Example:** `true` | `boolean` | No | `undefined` | - |
|
|
20
|
+
| **warning** | Applies warning styling (orange border and text) to indicate potential issues<br/>**Example:** `true` | `boolean` | No | `undefined` | - |
|
|
21
|
+
| **hint** | Alternative text that replaces the label when provided. Useful for contextual hints<br/>**Example:** `"Optional field"` | `string` | No | `undefined` | - |
|
|
22
|
+
| **input-classes** | Additional CSS classes to apply specifically to the input wrapper element<br/>**Example:** `"custom-input-wrapper"` | `string` | No | `undefined` | - |
|
|
23
|
+
| **border** | Controls whether the input has a visible border. Set to false for borderless inputs<br/>**Example:** `true` | `boolean` | No | `undefined` | - |
|
|
24
|
+
| **inputmode** | HTML inputmode attribute that provides hints for virtual keyboards on mobile devices<br/>**Example:** `"numeric"` | `InputHTMLAttributes['inputmode']` | No | `undefined` | `text, numeric, decimal, tel, search, email, url` |
|
|
25
|
+
| **size** | Controls the height and text size of the input component<br/>**Example:** `"md"` | `MazSize` | No | `undefined` | `xs, sm, md, lg, xl, mini` |
|
|
26
|
+
| **debounce** | Enables input debouncing to limit the frequency of value updates. When true, uses 500ms delay. When a number, uses that value as delay in milliseconds<br/>**Example:** `true` | `boolean \| number` | No | `undefined` | - |
|
|
27
|
+
| **auto-focus** | Automatically focuses the input when the component mounts<br/>**Example:** `false` | `boolean` | No | `undefined` | - |
|
|
28
|
+
| **border-active** | When true, shows the colored border immediately instead of only on focus<br/>**Example:** `false` | `boolean` | No | `undefined` | - |
|
|
29
|
+
| **start-icon** | Icon displayed on the inline-start edge of the input (left in LTR, right in RTL). Accepts a bare value (Vue component, raw SVG string, URL or `data:` URI) or a full `MazIconProps` object for fine-grained control (size, title, svgAttributes, fallback, …). | `MazIconLike` | No | `undefined` | - |
|
|
30
|
+
| **end-icon** | Icon displayed on the inline-end edge of the input (right in LTR, left in RTL). Accepts a bare value or a full `MazIconProps` object. | `MazIconLike` | No | `undefined` | - |
|
|
31
|
+
| **rounded-size** | Controls the border radius of the input component<br/>**Example:** `"lg"` | `MazRoundedSize` | No | `md` | `none, sm, md, lg, xl, full` |
|
|
32
|
+
| **block** | Makes the input expand to the full width of its container<br/>**Example:** `false` | `boolean` | No | `undefined` | - |
|
|
33
|
+
| **name** | The name of the input field. Used for form submission and validation<br/>**Example:** `"email"` | `string` | No | `undefined` | - |
|
|
34
|
+
| **autocomplete** | The autocomplete attribute for the input field. Used for form submission and validation<br/>**Example:** `"email"` | `string` | No | `undefined` | - |
|
|
35
|
+
| **loading** | Loading state for the input field. Used to show a loading spinner | `boolean` | No | `false` | - |
|
|
36
36
|
|
|
37
37
|
## Events
|
|
38
38
|
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type | Required |
|
|
4
|
-
| --------------------- | ---------------------------------------------------- | ------------------------- | -------- |
|
|
5
|
-
| **style** | The style of the component | `Native type` | No |
|
|
6
|
-
| **class** | The class of the component | `Native type` | No |
|
|
7
|
-
| **src** | The source of the image | `string \| Image \| null` | No |
|
|
8
|
-
| **alt** | The alt of the image | `string` | No |
|
|
9
|
-
| **hide-loader** | Remove the loader | `boolean` | No |
|
|
10
|
-
| **observer-once** | Remove the observer once the image is loaded | `boolean` | No |
|
|
11
|
-
| **load-once** | Remove the observer once the image is loaded | `boolean` | No |
|
|
12
|
-
| **image-height-full** | Make the image height full | `boolean` | No |
|
|
13
|
-
| **observer-options** | The options of the observer | `Native type` | No |
|
|
14
|
-
| **fallback-src** | The fallback src to replace the src on loading error | `string` | No |
|
|
15
|
-
| **img-class** | The classes of the image element | `Native type` | No |
|
|
16
|
-
| **block** | The image will be displayed in full width | `boolean` | No |
|
|
3
|
+
| Name | Description | Type | Required |
|
|
4
|
+
| --------------------- | ---------------------------------------------------- | ------------------------- | -------- |
|
|
5
|
+
| **style** | The style of the component | `Native type` | No |
|
|
6
|
+
| **class** | The class of the component | `Native type` | No |
|
|
7
|
+
| **src** | The source of the image | `string \| Image \| null` | No |
|
|
8
|
+
| **alt** | The alt of the image | `string` | No |
|
|
9
|
+
| **hide-loader** | Remove the loader | `boolean` | No |
|
|
10
|
+
| **observer-once** | Remove the observer once the image is loaded | `boolean` | No |
|
|
11
|
+
| **load-once** | Remove the observer once the image is loaded | `boolean` | No |
|
|
12
|
+
| **image-height-full** | Make the image height full | `boolean` | No |
|
|
13
|
+
| **observer-options** | The options of the observer | `Native type` | No |
|
|
14
|
+
| **fallback-src** | The fallback src to replace the src on loading error | `string` | No |
|
|
15
|
+
| **img-class** | The classes of the image element | `Native type` | No |
|
|
16
|
+
| **block** | The image will be displayed in full width | `boolean` | No |
|
|
17
17
|
|
|
18
18
|
## Events
|
|
19
19
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type | Required |
|
|
4
|
-
| ---------- | ---------------------------- | ---------- | -------- |
|
|
5
|
-
| **color** | The color of the component. | `MazColor` | No |
|
|
6
|
-
| **height** | The height of the component. | `string` | No |
|
|
3
|
+
| Name | Description | Type | Required |
|
|
4
|
+
| ---------- | ---------------------------- | ---------- | -------- |
|
|
5
|
+
| **color** | The color of the component. | `MazColor` | No |
|
|
6
|
+
| **height** | The height of the component. | `string` | No |
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
## Props
|
|
2
|
+
|
|
3
|
+
| Name | Description | Type | Required | Default |
|
|
4
|
+
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -------- | ----------- |
|
|
5
|
+
| **style** | Style attribute of the component root element | `Native type` | No | `undefined` |
|
|
6
|
+
| **class** | Class attribute of the component root element | `Native type` | No | `undefined` |
|
|
7
|
+
| **model-value** | `v-model` <br/> | `string` | No | `undefined` |
|
|
8
|
+
| **id** | The id of the textarea | `string` | No | `undefined` |
|
|
9
|
+
| **name** | The name of the textarea | `string` | No | `undefined` |
|
|
10
|
+
| **label** | Static label displayed above the editor | `string` | No | `undefined` |
|
|
11
|
+
| **placeholder** | The placeholder of the textarea | `string` | No | `undefined` |
|
|
12
|
+
| **required** | If the editor is required | `boolean` | No | `undefined` |
|
|
13
|
+
| **disabled** | If the editor is disabled | `boolean` | No | `undefined` |
|
|
14
|
+
| **readonly** | If the editor is readonly | `boolean` | No | `undefined` |
|
|
15
|
+
| **error** | If the editor has an error | `boolean` | No | `undefined` |
|
|
16
|
+
| **success** | If the editor has a success | `boolean` | No | `undefined` |
|
|
17
|
+
| **warning** | If the editor has a warning | `boolean` | No | `undefined` |
|
|
18
|
+
| **color** | The color of the editor | `MazColor` | No | `undefined` |
|
|
19
|
+
| **rounded-size** | Size radius of the component's border | `MazRoundedSize` | No | `md` |
|
|
20
|
+
| **top-label** | Static label displayed above the editor. Unlike a floating label, this remains fixed | `string` | No | `undefined` |
|
|
21
|
+
| **assistive-text** | Helper text displayed below the editor to provide additional context or validation feedback<br/>**Example:** `"Markdown is supported"` | `string` | No | `undefined` |
|
|
22
|
+
| **toolbar** | Show the formatting toolbar. Pass `true` for the full toolbar, or an ordered array of action keys to display only a subset (and control their order). | `boolean \| MazMarkdownEditorToolbarAction[]` | No | `false` |
|
|
23
|
+
| **line-numbers** | Display line numbers in a gutter on the left of the editor | `boolean` | No | `false` |
|
|
24
|
+
| **shortcuts** | Enable keyboard shortcuts for the toolbar actions (e.g. Cmd/Ctrl+B for bold). | `boolean` | No | `true` |
|
|
25
|
+
| **sanitize** | Sanitize the rendered preview HTML with DOMPurify | `boolean` | No | `true` |
|
|
26
|
+
| **render-function** | Custom markdown renderer. Receives the raw markdown and returns an HTML string (sync or async). Falls back to `marked` when omitted. The result is still sanitized when `sanitize` is enabled. | `TSFunctionType` | No | `undefined` |
|
|
27
|
+
| **marked-options** | Options forwarded to `marked` when using the default renderer | `Record` | No | `undefined` |
|
|
28
|
+
| **rows** | Minimum number of visible rows of the editor textarea | `number` | No | `6` |
|
|
29
|
+
| **translations** | Custom translations for the component. Override any key independently. | `DeepPartial<MazUiTranslationsNestedSchema['markdownEditor']>` | No | `undefined` |
|
|
30
|
+
|
|
31
|
+
## Events
|
|
32
|
+
|
|
33
|
+
| Event name | Properties | Description |
|
|
34
|
+
| ------------------ | ---------------------------------------------------- | --------------------------------------- |
|
|
35
|
+
| update:model-value | **value** `string \| undefined` - The markdown value | Emitted when the markdown value changes |
|
|
36
|
+
| input | **value** `string \| undefined` - The markdown value | Emitted when the markdown value changes |
|
|
37
|
+
| focus | **event** `FocusEvent` - The focus event | Emitted when the textarea is focused |
|
|
38
|
+
| blur | **event** `FocusEvent` - The blur event | Emitted when the textarea is blurred |
|
|
39
|
+
| change | **event** `Event` - The change event | Emitted when the textarea value changes |
|
|
40
|
+
|
|
41
|
+
## Slots
|
|
42
|
+
|
|
43
|
+
| Name | Description | Bindings |
|
|
44
|
+
| ------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| label | Replace the static label displayed above the editor | |
|
|
46
|
+
| toolbar | Replace the toolbar content (only rendered when the toolbar is enabled and not in preview mode) | **mode** `MazMarkdownEditorMode` - The current editor mode<br/>**wrap-selection** `Function` - Wrap the current selection with the given markers<br/>**prefix-lines** `Function` - Prefix every selected line with the given string<br/>**apply-heading** `Function` - Apply a heading of the given level to the selected lines<br/>**insert-link** `Function` - Insert a markdown link at the selection<br/>**insert-image** `Function` - Insert a markdown image at the selection<br/>**insert-code-block** `Function` - Insert a fenced code block at the selection<br/>**insert-table** `Function` - Insert a markdown table at the selection |
|
|
47
|
+
| empty-preview | Content displayed in the preview pane when there is nothing to render | |
|
|
48
|
+
|
|
49
|
+
## Expose
|
|
50
|
+
|
|
51
|
+
### textarea
|
|
52
|
+
|
|
53
|
+
> The underlying textarea element
|
|
54
|
+
|
|
55
|
+
### mode
|
|
56
|
+
|
|
57
|
+
> The current editor mode (write / preview / split)
|
|
58
|
+
|
|
59
|
+
### renderPreview
|
|
60
|
+
|
|
61
|
+
> Programmatically re-render the markdown preview
|
|
62
|
+
|
|
63
|
+
### focus
|
|
64
|
+
|
|
65
|
+
> Focus the editor textarea
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
| **offset** | Distance between trigger and popover in pixels | `number` | No | `8` | - |
|
|
15
15
|
| **delay** | Delay before showing/hiding in milliseconds | `number` | No | `0` | - |
|
|
16
16
|
| **hover-delay** | Delay before closing on hover in milliseconds | `number` | No | `150` | - |
|
|
17
|
-
| **transition** | CSS transition name for animations
|
|
17
|
+
| **transition** | **CSS transition name for animations** <br/> <br/>'scale-pop' \| 'scale-fade' for default transitions. 'scale-pop' is a pop effect, 'scale-fade' is a fade effect.<br/> | `"scale-pop" \| "scale-fade" \| string` | No | `scale-pop` | `scale-pop' \| 'scale-fade' \| string` |
|
|
18
18
|
| **teleport-to** | Teleport target selector | `string` | No | `body` | - |
|
|
19
19
|
| **overlay-class** | Additional CSS classes for the overlay wrapper | `Native type` | No | `undefined` | - |
|
|
20
20
|
| **panel-class** | Additional CSS classes for the popover panel | `Native type` | No | `undefined` | - |
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
## Props
|
|
2
2
|
|
|
3
|
-
| Name | Description | Type | Required |
|
|
4
|
-
| ---------------------- | ----------- | ---------------- | -------- |
|
|
5
|
-
| **distance** | | `number` | No |
|
|
6
|
-
| **offset** | | `number` | No |
|
|
7
|
-
| **on-click** | | `TSFunctionType` | No |
|
|
8
|
-
| **container-selector** | | `string` | No |
|
|
9
|
-
| **header-class** | | `string` | No |
|
|
10
|
-
| **spinner-color** | | `MazColor` | No |
|
|
11
|
-
| **disabled** | | `boolean` | No |
|
|
12
|
-
| **standalone-mode** | | `boolean` | No |
|
|
3
|
+
| Name | Description | Type | Required |
|
|
4
|
+
| ---------------------- | ----------- | ---------------- | -------- |
|
|
5
|
+
| **distance** | | `number` | No |
|
|
6
|
+
| **offset** | | `number` | No |
|
|
7
|
+
| **on-click** | | `TSFunctionType` | No |
|
|
8
|
+
| **container-selector** | | `string` | No |
|
|
9
|
+
| **header-class** | | `string` | No |
|
|
10
|
+
| **spinner-color** | | `MazColor` | No |
|
|
11
|
+
| **disabled** | | `boolean` | No |
|
|
12
|
+
| **standalone-mode** | | `boolean` | No |
|
|
13
13
|
|
|
14
14
|
## Events
|
|
15
15
|
|