@maz-ui/mcp 4.0.0-beta.26

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 (175) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +264 -0
  3. package/bin/maz-ui-mcp.mjs +7 -0
  4. package/dist/mcp.d.mts +13 -0
  5. package/dist/mcp.d.ts +13 -0
  6. package/dist/mcp.mjs +586 -0
  7. package/docs/generated-docs/maz-accordion.doc.md +21 -0
  8. package/docs/generated-docs/maz-animated-counter.doc.md +17 -0
  9. package/docs/generated-docs/maz-animated-element.doc.md +14 -0
  10. package/docs/generated-docs/maz-animated-text.doc.md +14 -0
  11. package/docs/generated-docs/maz-avatar.doc.md +44 -0
  12. package/docs/generated-docs/maz-backdrop.doc.md +61 -0
  13. package/docs/generated-docs/maz-badge.doc.md +16 -0
  14. package/docs/generated-docs/maz-bottom-sheet.doc.md +21 -0
  15. package/docs/generated-docs/maz-btn.doc.md +30 -0
  16. package/docs/generated-docs/maz-card-spotlight.doc.md +16 -0
  17. package/docs/generated-docs/maz-card.doc.md +39 -0
  18. package/docs/generated-docs/maz-carousel.doc.md +16 -0
  19. package/docs/generated-docs/maz-chart.doc.md +10 -0
  20. package/docs/generated-docs/maz-checkbox.doc.md +34 -0
  21. package/docs/generated-docs/maz-checklist.doc.md +30 -0
  22. package/docs/generated-docs/maz-circular-progress-bar.doc.md +27 -0
  23. package/docs/generated-docs/maz-date-picker.doc.md +52 -0
  24. package/docs/generated-docs/maz-dialog-confirm.doc.md +24 -0
  25. package/docs/generated-docs/maz-dialog.doc.md +22 -0
  26. package/docs/generated-docs/maz-drawer.doc.md +26 -0
  27. package/docs/generated-docs/maz-dropdown.doc.md +42 -0
  28. package/docs/generated-docs/maz-dropzone.doc.md +82 -0
  29. package/docs/generated-docs/maz-expand-animation.doc.md +12 -0
  30. package/docs/generated-docs/maz-fullscreen-loader.doc.md +13 -0
  31. package/docs/generated-docs/maz-gallery.doc.md +17 -0
  32. package/docs/generated-docs/maz-icon.doc.md +18 -0
  33. package/docs/generated-docs/maz-input-code.doc.md +25 -0
  34. package/docs/generated-docs/maz-input-number.doc.md +31 -0
  35. package/docs/generated-docs/maz-input-phone-number.doc.md +56 -0
  36. package/docs/generated-docs/maz-input-price.doc.md +26 -0
  37. package/docs/generated-docs/maz-input-tags.doc.md +24 -0
  38. package/docs/generated-docs/maz-input.doc.md +54 -0
  39. package/docs/generated-docs/maz-lazy-img.doc.md +31 -0
  40. package/docs/generated-docs/maz-link.doc.md +31 -0
  41. package/docs/generated-docs/maz-loading-bar.doc.md +6 -0
  42. package/docs/generated-docs/maz-pagination.doc.md +22 -0
  43. package/docs/generated-docs/maz-popover.doc.md +70 -0
  44. package/docs/generated-docs/maz-pull-to-refresh.doc.md +31 -0
  45. package/docs/generated-docs/maz-radio-buttons.doc.md +33 -0
  46. package/docs/generated-docs/maz-radio.doc.md +33 -0
  47. package/docs/generated-docs/maz-reading-progress-bar.doc.md +18 -0
  48. package/docs/generated-docs/maz-select-country.doc.md +44 -0
  49. package/docs/generated-docs/maz-select.doc.md +65 -0
  50. package/docs/generated-docs/maz-slider.doc.md +20 -0
  51. package/docs/generated-docs/maz-spinner.doc.md +6 -0
  52. package/docs/generated-docs/maz-stepper.doc.md +29 -0
  53. package/docs/generated-docs/maz-switch.doc.md +31 -0
  54. package/docs/generated-docs/maz-table-cell.doc.md +5 -0
  55. package/docs/generated-docs/maz-table-row.doc.md +11 -0
  56. package/docs/generated-docs/maz-table-title.doc.md +5 -0
  57. package/docs/generated-docs/maz-table.doc.md +66 -0
  58. package/docs/generated-docs/maz-tabs-bar.doc.md +18 -0
  59. package/docs/generated-docs/maz-tabs-content-item.doc.md +11 -0
  60. package/docs/generated-docs/maz-tabs-content.doc.md +5 -0
  61. package/docs/generated-docs/maz-tabs.doc.md +17 -0
  62. package/docs/generated-docs/maz-textarea.doc.md +41 -0
  63. package/docs/src/components/index.md +8 -0
  64. package/docs/src/components/maz-accordion.md +80 -0
  65. package/docs/src/components/maz-animated-counter.md +124 -0
  66. package/docs/src/components/maz-animated-element.md +36 -0
  67. package/docs/src/components/maz-animated-text.md +36 -0
  68. package/docs/src/components/maz-avatar.md +179 -0
  69. package/docs/src/components/maz-backdrop.md +16 -0
  70. package/docs/src/components/maz-badge.md +222 -0
  71. package/docs/src/components/maz-bottom-sheet.md +398 -0
  72. package/docs/src/components/maz-btn.md +526 -0
  73. package/docs/src/components/maz-card-spotlight.md +163 -0
  74. package/docs/src/components/maz-card.md +447 -0
  75. package/docs/src/components/maz-carousel.md +127 -0
  76. package/docs/src/components/maz-chart.md +346 -0
  77. package/docs/src/components/maz-checkbox.md +168 -0
  78. package/docs/src/components/maz-checklist.md +414 -0
  79. package/docs/src/components/maz-circular-progress-bar.md +147 -0
  80. package/docs/src/components/maz-date-picker.md +1078 -0
  81. package/docs/src/components/maz-dialog-confirm.md +240 -0
  82. package/docs/src/components/maz-dialog.md +208 -0
  83. package/docs/src/components/maz-drawer.md +177 -0
  84. package/docs/src/components/maz-dropdown.md +650 -0
  85. package/docs/src/components/maz-dropzone.md +442 -0
  86. package/docs/src/components/maz-expand-animation.md +99 -0
  87. package/docs/src/components/maz-fullscreen-loader.md +58 -0
  88. package/docs/src/components/maz-gallery.md +85 -0
  89. package/docs/src/components/maz-icon.md +85 -0
  90. package/docs/src/components/maz-input-code.md +61 -0
  91. package/docs/src/components/maz-input-number.md +81 -0
  92. package/docs/src/components/maz-input-phone-number.md +867 -0
  93. package/docs/src/components/maz-input-price.md +58 -0
  94. package/docs/src/components/maz-input-tags.md +114 -0
  95. package/docs/src/components/maz-input.md +453 -0
  96. package/docs/src/components/maz-lazy-img.md +24 -0
  97. package/docs/src/components/maz-link.md +156 -0
  98. package/docs/src/components/maz-loading-bar.md +26 -0
  99. package/docs/src/components/maz-pagination.md +81 -0
  100. package/docs/src/components/maz-popover.md +1414 -0
  101. package/docs/src/components/maz-pull-to-refresh.md +49 -0
  102. package/docs/src/components/maz-radio-buttons.md +456 -0
  103. package/docs/src/components/maz-radio.md +141 -0
  104. package/docs/src/components/maz-reading-progress-bar.md +74 -0
  105. package/docs/src/components/maz-select-country.md +636 -0
  106. package/docs/src/components/maz-select.md +439 -0
  107. package/docs/src/components/maz-slider.md +191 -0
  108. package/docs/src/components/maz-spinner.md +93 -0
  109. package/docs/src/components/maz-stepper.md +418 -0
  110. package/docs/src/components/maz-switch.md +92 -0
  111. package/docs/src/components/maz-table.md +571 -0
  112. package/docs/src/components/maz-tabs.md +231 -0
  113. package/docs/src/components/maz-textarea.md +218 -0
  114. package/docs/src/composables/use-aos.md +34 -0
  115. package/docs/src/composables/use-breakpoints.md +35 -0
  116. package/docs/src/composables/use-dialog.md +88 -0
  117. package/docs/src/composables/use-display-names.md +174 -0
  118. package/docs/src/composables/use-form-validator.md +1149 -0
  119. package/docs/src/composables/use-idle-timeout.md +256 -0
  120. package/docs/src/composables/use-reading-time.md +168 -0
  121. package/docs/src/composables/use-string-matching.md +63 -0
  122. package/docs/src/composables/use-swipe.md +223 -0
  123. package/docs/src/composables/use-timer.md +130 -0
  124. package/docs/src/composables/use-toast.md +71 -0
  125. package/docs/src/composables/use-user-visibility.md +169 -0
  126. package/docs/src/composables/use-wait.md +62 -0
  127. package/docs/src/composables/use-window-size.md +18 -0
  128. package/docs/src/demo/DemoAuthPage.vue +178 -0
  129. package/docs/src/demo/DemoDashboardPage.vue +298 -0
  130. package/docs/src/demo/DemoProductPage.vue +135 -0
  131. package/docs/src/directives/click-outside.md +275 -0
  132. package/docs/src/directives/fullscreen-img.md +101 -0
  133. package/docs/src/directives/lazy-img.md +184 -0
  134. package/docs/src/directives/tooltip.md +458 -0
  135. package/docs/src/directives/zoom-img.md +127 -0
  136. package/docs/src/guide/cli.md +144 -0
  137. package/docs/src/guide/getting-started.md +284 -0
  138. package/docs/src/guide/icon-set.md +60 -0
  139. package/docs/src/guide/icons.md +481 -0
  140. package/docs/src/guide/mcp.md +210 -0
  141. package/docs/src/guide/migration-v4.md +898 -0
  142. package/docs/src/guide/nuxt.md +411 -0
  143. package/docs/src/guide/resolvers.md +697 -0
  144. package/docs/src/guide/themes.md +789 -0
  145. package/docs/src/guide/translations.md +1173 -0
  146. package/docs/src/guide/vue.md +243 -0
  147. package/docs/src/helpers/camel-case.md +14 -0
  148. package/docs/src/helpers/capitalize.md +51 -0
  149. package/docs/src/helpers/check-availability.md +14 -0
  150. package/docs/src/helpers/country-code-to-unicode-flag.md +213 -0
  151. package/docs/src/helpers/currency.md +67 -0
  152. package/docs/src/helpers/date.md +67 -0
  153. package/docs/src/helpers/debounce-callback.md +14 -0
  154. package/docs/src/helpers/debounce-id.md +14 -0
  155. package/docs/src/helpers/debounce.md +14 -0
  156. package/docs/src/helpers/get-country-flag-url.md +156 -0
  157. package/docs/src/helpers/is-client.md +14 -0
  158. package/docs/src/helpers/is-equal.md +14 -0
  159. package/docs/src/helpers/is-standalone-mode.md +14 -0
  160. package/docs/src/helpers/kebab-case.md +14 -0
  161. package/docs/src/helpers/normalize-string.md +14 -0
  162. package/docs/src/helpers/number.md +65 -0
  163. package/docs/src/helpers/pascal-case.md +14 -0
  164. package/docs/src/helpers/script-loader.md +14 -0
  165. package/docs/src/helpers/sleep.md +14 -0
  166. package/docs/src/helpers/snake-case.md +14 -0
  167. package/docs/src/helpers/throttle-id.md +14 -0
  168. package/docs/src/helpers/throttle.md +14 -0
  169. package/docs/src/index.md +555 -0
  170. package/docs/src/made-with-maz-ui.md +58 -0
  171. package/docs/src/plugins/aos.md +347 -0
  172. package/docs/src/plugins/dialog.md +411 -0
  173. package/docs/src/plugins/toast.md +349 -0
  174. package/docs/src/plugins/wait.md +109 -0
  175. package/package.json +84 -0
@@ -0,0 +1,42 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default | Possible values |
4
+ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
5
+ | **model-value** | `v-model` <br/>Controls whether the dropdown menu is open | `boolean` | No | `false` | - |
6
+ | **style** | Inline styles to apply to the component root element | `HTMLAttributes['style']` | No | `undefined` | - |
7
+ | **class** | CSS classes to apply to the component root element | `HTMLAttributes['class']` | No | `undefined` | - |
8
+ | **items** | Menu items to display in the dropdown Each item can be either a link (with href/to properties) or an action (with onClick function)<br/>**Example:** `[ { label: 'Profile', href: '/profile' }, { label: 'Settings', onClick: () => console.log('Settings clicked') } ]` | `MazDropdownMenuItem[]` | No | `[]` | - |
9
+ | **id** | Unique identifier for the dropdown component | `string` | No | `undefined` | - |
10
+ | **trigger** | Determines how the dropdown should be triggered | `MazPopoverProps['trigger']` | No | `adaptive` | `click, hover, manual, adaptive` |
11
+ | **color** | Color theme for the dropdown button | `MazColor` | No | `transparent` | `primary, secondary, info, success, warning, destructive, transparent, contrast, accent` |
12
+ | **position** | Position of the menu relative to trigger | `Native type` | No | `auto` | `auto, top, bottom, left, right, top-start, top-end, bottom-start, bottom-end, left-start, left-end, right-start, right-end` |
13
+ | **prefer-position** | Preferred position of the menu relative to trigger when auto position is used | `Native type` | No | `bottom-start` | `auto, top, bottom, left, right, top-start, top-end, bottom-start, bottom-end, left-start, left-end, right-start, right-end` |
14
+ | **close-on-click** | Controls whether the dropdown menu closes when a menu item is clicked | `boolean` | No | `true` | - |
15
+ | **disabled** | Disables the dropdown functionality | `boolean` | No | `false` | - |
16
+ | **chevron** | Controls whether to show the chevron icon in the trigger button | `boolean` | No | `true` | - |
17
+ | **screen-reader-description** | Accessible description for screen readers describing the dropdown functionality If not provided, the default translation of MazTranslations plugin will be used | `string` | No | `MazTranslationsSchema['dropdown']['screenReaderDescription']` | - |
18
+ | **menu-panel-class** | Additional CSS classes to apply to the dropdown menu panel Useful for customizing the dropdown appearance (background, border, etc.) | `HTMLAttributes['class']` | No | `undefined` | - |
19
+ | **menu-panel-style** | Inline styles to apply to the dropdown menu panel Useful for custom styling. You may use `!important` to override default styles | `HTMLAttributes['style']` | No | `undefined` | - |
20
+ | **block** | Makes the dropdown button expand to full width of its container | `boolean` | No | `false` | - |
21
+ | **dropdown-icon** | Icon to use instead of the default chevron for the dropdown indicator Can be either an icon name string or a Vue component<br/>**Example:** `'arrow-down'` | `string \| IconComponent` | No | `undefined` | - |
22
+ | **dropdown-icon-animation** | Controls whether the dropdown icon rotates when the dropdown is opened | `boolean` | No | `true` | - |
23
+ | **size** | Size of the dropdown button | `MazSize` | No | `md` | `mini, xs, sm, md, lg, xl` |
24
+
25
+ ## Events
26
+
27
+ | Event name | Properties | Description |
28
+ | ------------------ | ------------------------------------------------------------------------------ | -------------------------------------------- |
29
+ | menuitem-clicked | **event** `Event` - The native click event from the menu item interaction | Emitted when a menu item is clicked |
30
+ | update:model-value | **value** `boolean` - The new open state (true when opened, false when closed) | Emitted when the dropdown open state changes |
31
+
32
+ ## Slots
33
+
34
+ | Name | Description | Bindings |
35
+ | ------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
+ | screen-reader-description | description for screen readers (hidden from visual display) | |
37
+ | trigger | trigger element for the dropdown | **is-open** `boolean` - Current state of the dropdown (true when open, false when closed)<br/>**toggle** `() =&gt; void` - Function to toggle the dropdown<br/>**close** `() =&gt; void` - Function to close the dropdown<br/>**open** `() =&gt; void` - Function to open the dropdown |
38
+ | default | Text content of the trigger element | |
39
+ | dropdown-icon | Dropdown indicator icon | **is-open** `boolean` - Current state of the dropdown (true when open, false when closed)<br/><br/><br/> |
40
+ | dropdown | Dropdown menu panel content | **items** `MazDropdownMenuItem[]` - Array of menu items passed via the items prop<br/>**open** `() =&gt; void` - Function to open the dropdown<br/>**close** `() =&gt; void` - Function to close the dropdown<br/>**is-open** `boolean` - Current state of the dropdown (true when open, false when closed)<br/>**toggle** `() =&gt; void` - Function to toggle the dropdown |
41
+ | menuitem | Menu item component | **item** `MenuItem` - Individual menu item object with properties like label, href, onClick, etc.<br/>**open** `() =&gt; void` - Function to open the dropdown<br/>**close** `() =&gt; void` - Function to close the dropdown<br/>**is-open** `boolean` - Current state of the dropdown (true when open, false when closed)<br/>**toggle** `() =&gt; void` - Function to toggle the dropdown |
42
+ | menuitem-label | Label content for menu item | **item** `MenuItem` - Individual menu item object containing label and other properties<br/>**open** `() =&gt; void` - Function to open the dropdown<br/>**close** `() =&gt; void` - Function to close the dropdown<br/>**is-open** `boolean` - Current state of the dropdown (true when open, false when closed)<br/>**toggle** `() =&gt; void` - Function to toggle the dropdown |
@@ -0,0 +1,82 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5
+ | **id** | The id of the dropzone | `string` | No | `undefined` |
6
+ | **multiple** | Allow multiple files to be uploaded. | `boolean` | No | `false` |
7
+ | **data-types** | Allowed data types/MIME types for files (e.g. ['application/json']) | `string[]` | No | `['*\/*']` |
8
+ | **prevent-default-for-unhandled** | Prevent default behavior for unhandled drag & drop events. | `boolean` | No | `true` |
9
+ | **max-file-size** | Maximum file size in MB. | `number` | No | `undefined` |
10
+ | **max-files** | Maximum number of files allowed. | `number` | No | `undefined` |
11
+ | **disabled** | Disable the dropzone | `boolean` | No | `undefined` |
12
+ | **preview** | Show file preview | `boolean` | No | `undefined` |
13
+ | **min-file-size** | Minimum file size in MB | `number` | No | `undefined` |
14
+ | **allow-duplicates** | Allow duplicates | `boolean` | No | `false` |
15
+ | **translations** | **Translations** <br/> <br/>Custom translations for the component<br/> | `{ dragAndDrop?: string fileMaxCount?: string fileMaxSize?: string fileTypes?: string selectFile?: string divider?: string }` | No | `{ dragAndDrop: 'Drag and drop your files', fileMaxCount: 'Maximum {count} files', fileMaxSize: 'Maximum {size} MB', fileTypes: 'Allowed file types: {types}', selectFile: 'Select file', divider: 'or' }` |
16
+ | **color** | Main color of the component | `MazColor` | No | `primary` |
17
+ | **select-file-btn-props** | MazBtn props [MazBtn props](/components/maz-btn#props) | `MazBtnProps` | No | `{}` |
18
+ | **remove-file-btn-props** | MazBtn props [MazBtn props](/components/maz-btn#props) | `MazBtnProps` | No | `{}` |
19
+ | **spinner-props** | MazSpinner props [MazSpinner props](/components/maz-spinner#props) | `MazSpinnerProps` | No | `{}` |
20
+ | **auto-upload** | **Auto upload files** <br/> <br/>If set to `multiple`, all files will be uploaded at once in a single request. If set to `single`, files will be uploaded one by one in separate requests. If set to `false`, no upload will be done automatically.<br/> | `"multiple" \| "single" \| false` | No | `false` |
21
+ | **url** | **Upload URL** <br/> <br/>If set, files will be uploaded to the given URL.<br/> | `string` | No | `undefined` |
22
+ | **request-options** | **Request options** <br/> <br/>Request options to be used for the upload (using fetch) [Request options](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options)<br/><br/>**Example:** `{ mode: 'no-cors', headers: { 'Content-Type': 'multipart/form-data', 'Authorization': 'Bearer 1234567890' } }` | `RequestInit` | No | `undefined` |
23
+ | **transform-body** | Transform the body of the request | `TSFunctionType` | No | `undefined` |
24
+
25
+ ## Events
26
+
27
+ | Event name | Properties | Description |
28
+ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
29
+ | drop | **values** `{ files: File[] \| null, event: DragEvent }` - The dropped files and the drag event | Event emitted when files are dropped in the dropzone |
30
+ | enter | **values** `{ files: File[] \| null, event: DragEvent }` - The dragged files and the drag event | Event emitted when dragged files enter the dropzone |
31
+ | leave | **values** `{ files: File[] \| null, event: DragEvent }` - The dragged files and the drag event | Event emitted when dragged files leave the dropzone |
32
+ | over | **values** `{ files: File[] \| null, event: DragEvent }` - The dragged files and the drag event | Event emitted when dragged files are over the dropzone |
33
+ | add | **value** `File` - The added file | Event emitted when a file is added to the dropzone |
34
+ | remove | **value** `File` - The removed file | Event emitted when a file is removed from the dropzone |
35
+ | error | **values** `{ files: File[] \| null, event: DragEvent \| null, code: MazDropzoneErrorCode }` - The files, event and error code | Event emitted when an error occurs |
36
+ | upload-error | **values** `{ file: File, code: MazDropzoneErrorCode, error: unknown }` - The file, error code and error details | Event emitted when an error occurs during file upload |
37
+ | upload-error-multiple | **values** `{ files: File[], code: MazDropzoneErrorCode, error: unknown }` - The files, error code and error details | Event emitted when an error occurs during multiple files upload |
38
+ | upload-success | **values** `{ file: File, response?: Response }` - The uploaded file and the response | Event emitted when a file is successfully uploaded |
39
+ | upload-success-multiple | **values** `{ files: File[], response?: Response }` - The uploaded files and the response | Event emitted when multiple files are successfully uploaded |
40
+
41
+ ## Slots
42
+
43
+ | Name | Description | Bindings |
44
+ | ------------- | ----------------------------------- | ------------------------------------------------------------ |
45
+ | files-area | Slot to customize the files area | **files-data** `MazDropzoneFileData[]` - The files data |
46
+ | file-item | Slot to customize the file item | **file** `MazDropzoneFileData` - The drop file data |
47
+ | no-files-area | Slot to customize the no files area | **select-file** `Function` - The function to select the file |
48
+ | upload-icon | Slot to customize the upload icon | |
49
+
50
+ ## Expose
51
+
52
+ ### uploadFiles
53
+
54
+ > Upload files <br/>`@description` With this method, the files are uploaded one by one (a request for each file)<br/>`@usage` `mazDropzoneInstance.value?.uploadFiles()`
55
+
56
+ ### uploadFilesMultiple
57
+
58
+ > Upload multiple files <br/>`@description` With this method, the files are uploaded all at once in a single request<br/>`@usage` `mazDropzoneInstance.value?.uploadFilesMultiple()`
59
+
60
+ ### getFormData
61
+
62
+ > Get form data <br/>`@description` Get the form data of one file<br/>`@usage` `const formData = mazDropzoneInstance.value?.getFormData(file)`
63
+
64
+ ### getFormDataMultiple
65
+
66
+ > Get form data multiple <br/>`@description` Get the form data of all files<br/>`@usage` `const formData = mazDropzoneInstance.value?.getFormDataMultiple()`
67
+
68
+ ### reset
69
+
70
+ > Reset the files <br/>`@description` Remove all files from the dropzone<br/>`@usage` `mazDropzoneInstance.value?.reset()`
71
+
72
+ ### isUploading
73
+
74
+ > Check if the files are uploading <br/>`@description` Check if the files are uploading<br/>`@usage` `const isUploading = mazDropzoneInstance.value?.isUploading`
75
+
76
+ ### addFile
77
+
78
+ > Add a file to the dropzone <br/>`@description` Add a file manually to the dropzone<br/>`@usage` `mazDropzoneInstance.value?.addFile(file)`
79
+
80
+ ### removeFile
81
+
82
+ > Remove a file from the dropzone <br/>`@description` Remove a file manually from the dropzone<br/>`@usage` `mazDropzoneInstance.value?.removeFile(file)`
@@ -0,0 +1,12 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | ------------------- | ----------------------------------------- | -------- | -------- | --------------- |
5
+ | **duration** | Duration of the animation in milliseconds | `string` | No | `'300ms'` |
6
+ | **timing-function** | Timing function of the animation | `string` | No | `'ease-in-out'` |
7
+
8
+ ## Slots
9
+
10
+ | Name | Description | Bindings |
11
+ | ------- | ------------------------------ | -------- |
12
+ | default | Default Slot - Display content | |
@@ -0,0 +1,13 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required |
4
+ | --------------------- | ----------------------------------- | ---------- | -------- |
5
+ | **color** | The color of the spinner | `MazColor` | No |
6
+ | **size** | The size of the spinner | `string` | No |
7
+ | **teleport-selector** | The selector to teleport the loader | `string` | No |
8
+
9
+ ## Slots
10
+
11
+ | Name | Description | Bindings |
12
+ | ------- | ----------- | -------- |
13
+ | default | | |
@@ -0,0 +1,17 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -------- | -------------------------------- |
5
+ | **images** | Array of string or object: `['https://via.placeholder.com/500', 'https://via.placeholder.com/600']` or `[{ slug: 'https://via.placeholder.com/500', alt: 'image descripton' }, { slug: 'https://via.placeholder.com/600', alt: 'image descripton' }]` | `MazGalleryImage[]` | No | `undefined` |
6
+ | **displayed-count** | Images count shown (max: 5) | `number` | No | `5` |
7
+ | **remaining** | Remove transparent layer with the remain count (ex: +2) | `boolean` | No | `true` |
8
+ | **height** | Height of gallery - set to `false` to remove default height | `number \| string \| false` | No | `150` |
9
+ | **width** | Width of gallery - set to `false` to remove default width | `number \| string \| false` | No | `100%` |
10
+ | **radius** | Disable the border radius of the gallery | `boolean` | No | `false` |
11
+ | **zoom** | Disable full size display when clicking on image | `boolean` | No | `false` |
12
+ | **has-empty-layer** | Layer with photography icon when no images is provided | `boolean` | No | `true` |
13
+ | **lazy** | Lazy load image - if false, images are directly loaded | `boolean` | No | `true` |
14
+ | **blur** | Disable blur effect on image hover | `boolean` | No | `true` |
15
+ | **scale** | Disable scale animation effect on image hover | `boolean` | No | `true` |
16
+ | **separator-color** | Choose color of borders between images - Should be a CSS color or CSS variable - Ex: `#000` or `hsl(var(--maz-background-300))` | `string` | No | `transparent` |
17
+ | **background-color** | Choose background color of the gallery - Should be a CSS color or CSS variable - Ex: `#000` or `hsl(var(--maz-background-300))` | `string` | No | `hsl(var(--maz-background-300))` |
@@ -0,0 +1,18 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required |
4
+ | -------------------- | -------------------------------------------------------------------------- | ---------------- | -------- |
5
+ | **src** | The source path of the SVG file - e.g: `/icons/home.svg` | `string` | No |
6
+ | **path** | The path of the folder where the SVG files are stored - e.g: `/icons` | `string` | No |
7
+ | **name** | The name of the SVG file - e.g: `home` | `string` | No |
8
+ | **size** | The size of the SVG file - e.g: `1em` | `string` | No |
9
+ | **title** | The title of the SVG file - e.g: `Home` | `string` | No |
10
+ | **transform-source** | The function to transform the source of the SVG file - e.g: `(svg) => svg` | `TSFunctionType` | No |
11
+
12
+ ## Events
13
+
14
+ | Event name | Properties | Description |
15
+ | ---------- | ---------------------------------------------------------- | ----------------------------------- |
16
+ | loaded | **svg** `SVGElement \| undefined` - the svg element loaded | emitted when SVG file is loaded |
17
+ | unloaded | | emitted when SVG file is not loaded |
18
+ | error | **error** `Error` - the error | emitted when SVG file is not loaded |
@@ -0,0 +1,25 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | ---------------- | ------------------------------------------ | -------------------- | -------- | ----------- |
5
+ | **style** | The style of the component. | `Native type` | No | `undefined` |
6
+ | **class** | The class of the component. | `Native type` | No | `undefined` |
7
+ | **model-value** | The value of the component (v-model). | `T` | No | `undefined` |
8
+ | **code-length** | The length of the code. | `number` | No | `4` |
9
+ | **type** | The type of the input field. | `"text" \| "number"` | No | `'text'` |
10
+ | **accept-alpha** | Whether to accept alpha characters. | `boolean` | No | `false` |
11
+ | **required** | Whether the input is required. | `boolean` | No | `false` |
12
+ | **disabled** | Whether the input is disabled. | `boolean` | No | `false` |
13
+ | **error** | Whether there is an error with the input. | `boolean` | No | `false` |
14
+ | **success** | Whether the input is successful. | `boolean` | No | `false` |
15
+ | **warning** | Whether there is a warning with the input. | `boolean` | No | `false` |
16
+ | **size** | The size of the component. | `MazInputCodeSize` | No | `'md'` |
17
+ | **color** | The color of the component. | `MazColor` | No | `'primary'` |
18
+ | **hint** | The hint text to display below the input. | `string` | No | `undefined` |
19
+
20
+ ## Events
21
+
22
+ | Event name | Properties | Description |
23
+ | ------------------ | ----------------------------------------------- | -------------------------------- |
24
+ | update:model-value | **value** `mixed` - The new value of the model. | Update the model value. |
25
+ | completed | | Emitted when all inputs are set. |
@@ -0,0 +1,31 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | ---------------- | ----------------------------------------------------------------- | ----------------------------- | -------- | -------------------------- |
5
+ | **style** | The inline style object for the component. | `HTMLAttributes['style']` | No | `undefined` |
6
+ | **class** | The CSS class name for the component. | `HTMLAttributes['class']` | No | `undefined` |
7
+ | **model-value** | `v-model` <br/>The value of the component (v-model). | `number` | No | `undefined` |
8
+ | **disabled** | Whether the input number is disabled or not. | `boolean` | No | `false` |
9
+ | **max** | The maximum value allowed for the input number. | `number` | No | `Number.POSITIVE_INFINITY` |
10
+ | **min** | The minimum value allowed for the input number. | `number` | No | `Number.NEGATIVE_INFINITY` |
11
+ | **step** | The step value for incrementing or decrementing the input number. | `number` | No | `1` |
12
+ | **size** | The size of the input number component. | `MazSize` | No | `'md'` |
13
+ | **hide-buttons** | Whether to hide the increment and decrement buttons or not. | `boolean` | No | `false` |
14
+ | **text-center** | Whether to center the text inside the input or not. | `boolean` | No | `true` |
15
+ | **inputmode** | The inputmode attribute for the input. | `HTMLAttributes['inputmode']` | No | `'numeric'` |
16
+ | **block** | The input will be displayed in full width | `boolean` | No | `undefined` |
17
+ | **error** | Will display the input in error state. | `boolean` | No | `false` |
18
+ | **hint** | The hint text to display below the input. | `string` | No | `undefined` |
19
+ | **success** | Will display the input in success state. | `boolean` | No | `false` |
20
+ | **warning** | Will display the input in warning state. | `boolean` | No | `false` |
21
+ | **input-props** | The props for the input component. | `MazInputProps` | No | `undefined` |
22
+
23
+ ## Events
24
+
25
+ | Event name | Properties | Description |
26
+ | ------------------ | ---------------------------------------------------- | ----------------------------------- |
27
+ | focus | **value** `Event` - event object | Emitted when the input is focused |
28
+ | change | **value** `Event` - event object | Emitted when the value change |
29
+ | blur | **value** `Event` - event object | Emitted when the input is blurred |
30
+ | click | **value** `Event` - event object | Emitted input is clicked |
31
+ | update:model-value | **value** `number \| undefined` - value of the input | Emitted when the input value change |
@@ -0,0 +1,56 @@
1
+ ## Props
2
+
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
+ | **label** | Label displayed above the input<br/>**Example:** `"Phone Number"` | `string` | No | `undefined` | - |
12
+ | **preferred-countries** | List of country codes to place first in the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
13
+ | **ignored-countries** | List of country codes to be removed from the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
14
+ | **only-countries** | List of country codes to only have the countries selected in the select list<br/>**Example:** `["FR", "BE", "GE"]` | `CountryCode[]` | No | `undefined` | - |
15
+ | **translations** | Locale strings of the component The default values are the translations of the MazTranslations plugin | `Partial<MazTranslationsNestedSchema['inputPhoneNumber']>` | No | `{ countrySelect: { error: 'Choose country', placeholder: 'Country code', searchPlaceholder: 'Search the country', }, phoneInput: { placeholder: 'Phone number', example: 'Example: {example}', }, }` | - |
16
+ | **list-position** | Position where the list of countries will be opened | `MazPopoverProps['position']` | No | `'bottom-start'` | `top left, top right, bottom left, bottom right` |
17
+ | **color** | Component color applied | `MazColor` | No | `'primary'` | `primary, secondary, accent, info, success, warning, destructive, contrast` |
18
+ | **size** | Component size applied | `MazSize` | No | `'md'` | `xs, sm, md, lg, xl, mini` |
19
+ | **hide-flags** | Remove flags in country list | `boolean` | No | `false` | - |
20
+ | **disabled** | Disable input | `boolean` | No | `false` | - |
21
+ | **example** | Show the phone number example | `boolean` | No | `true` | - |
22
+ | **search** | Disable search input in country list | `boolean` | No | `true` | - |
23
+ | **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` | - |
24
+ | **use-browser-locale** | If true, the browser locale will be used | `boolean` | No | `true` | - |
25
+ | **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` | - |
26
+ | **hide-country-select** | Hide the country selector | `boolean` | No | `false` | - |
27
+ | **show-code-in-list** | Show country calling code in the country list | `boolean` | No | `false` | - |
28
+ | **custom-countries-list** | Replace country names | `Record<CountryCode, string>` | No | `undefined` | - |
29
+ | **auto-format** | Disabled auto-format when phone is valid | `boolean` | No | `true` | - |
30
+ | **country-locale** | Locale of country list<br/>**Example:** `"fr-FR"` | `string` | No | `undefined` | - |
31
+ | **validation-error** | Disable validation error UI | `boolean` | No | `true` | - |
32
+ | **validation-success** | Disable validation success UI | `boolean` | No | `true` | - |
33
+ | **success** | Add success UI | `boolean` | No | `false` | - |
34
+ | **error** | Add error UI | `boolean` | No | `false` | - |
35
+ | **display-country-name** | Will replace the calling code by the country name in the country selector | `boolean` | No | `false` | - |
36
+ | **block** | The input will be displayed in full width | `boolean` | No | `false` | - |
37
+ | **orientation** | Orientation of the inputs in the component | `'row' \| 'col' \| 'responsive'` | No | `'responsive'` | `row, col, responsive` |
38
+ | **country-select-attributes** | Meta attributes of the country input | `Record<string, unknown>` | No | `() => ({ name: 'country', autocomplete: 'off', style: { width: '14rem', }, })` | - |
39
+ | **phone-input-attributes** | Meta attributes of the phone number input | `Record<string, unknown>` | No | `() => ({ name: 'phone', autocomplete: 'tel', inputmode: 'tel', })` | - |
40
+
41
+ ## Events
42
+
43
+ | Event name | Properties | Description |
44
+ | ------------------- | -------------------------------------------------------- | -------------------------------------------- |
45
+ | update:model-value | **phoneNumber** `string` - phoneNumber formatted | Emitted when country or phone number changes |
46
+ | country-code | **countryCode** `CountryCode` - Country code | Emitted when selected country changes |
47
+ | update:country-code | **countryCode** `CountryCode` - Country code | Emitted when country changes |
48
+ | data | **results** `Results` - metadata of current phone number | Emitted when country or phone number changes |
49
+
50
+ ## Slots
51
+
52
+ | Name | Description | Bindings |
53
+ | ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
54
+ | no-results | Replace the "no results" icon in the country selector list | |
55
+ | selector-flag | Country selector flag | **country-code** `String` - current selected country code Ex: `"FR"` |
56
+ | country-list-flag | Country list flag | **country-code** `String` - country code of option Ex: `"FR"`<br/>**option** `{ iso2: string; dialCode: string; name: string; }` - country data<br/>**is-selected** `Boolean` - `true` if option is selected |
@@ -0,0 +1,26 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | -------------------- | -------------------------------------------------------------------------- | --------- | -------- | -------------------------- |
5
+ | **model-value** | `v-model` <br/> | `number` | No | `undefined` |
6
+ | **currency** | The currency to use | `string` | No | `'EUR'` |
7
+ | **locale** | The locale to use | `string` | No | `'fr-FR'` |
8
+ | **min** | The minimum value that the input can accept | `number` | No | `Number.NEGATIVE_INFINITY` |
9
+ | **max** | The maximum value that the input can accept | `number` | No | `Number.POSITIVE_INFINITY` |
10
+ | **no-icon** | The input will be displayed without icon | `boolean` | No | `false` |
11
+ | **block** | The input will be displayed in full width | `boolean` | No | `undefined` |
12
+ | **error** | Will display the input in error state. | `boolean` | No | `undefined` |
13
+ | **hint** | The hint text to display below the input. | `string` | No | `undefined` |
14
+ | **success** | Will display the input in success state. | `boolean` | No | `undefined` |
15
+ | **warning** | Will display the input in warning state. | `boolean` | No | `undefined` |
16
+ | **currency-options** | Options for the currency helper - [see](https://maz-ui.com/utils/currency) | `Omit` | No | `undefined` |
17
+
18
+ ## Events
19
+
20
+ | Event name | Properties | Description |
21
+ | ------------------ | ---------- | ----------- |
22
+ | update:model-value | |
23
+ | input | |
24
+ | formatted | |
25
+ | blur | |
26
+ | focus | |
@@ -0,0 +1,24 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | -------------------- | -------------------------------------------- | ----------------------- | -------- | ----------- |
5
+ | **style** | Style attribut of the component root element | `Native type` | No | `undefined` |
6
+ | **class** | Class attribut of the component root element | `Native type` | No | `undefined` |
7
+ | **model-value** | `v-model` <br/> | `TSParenthesizedType[]` | No | `undefined` |
8
+ | **placeholder** | The placeholder of the input | `string` | No | `undefined` |
9
+ | **label** | The label of the input | `string` | No | `undefined` |
10
+ | **disabled** | Disable the input | `boolean` | No | `false` |
11
+ | **error** | Display the input with error style | `boolean` | No | `false` |
12
+ | **success** | Display the input with success style | `boolean` | No | `false` |
13
+ | **warning** | Display the input with warning style | `boolean` | No | `false` |
14
+ | **size** | The size of the input | `MazSize` | No | `'md'` |
15
+ | **color** | The color of the input | `MazColor` | No | `'primary'` |
16
+ | **block** | The input will be displayed in full width | `boolean` | No | `undefined` |
17
+ | **add-tags-on-blur** | Add tags on blur | `boolean` | No | `true` |
18
+ | **hint** | The hint text to display below the input. | `string` | No | `undefined` |
19
+
20
+ ## Events
21
+
22
+ | Event name | Properties | Description |
23
+ | ------------------ | ---------- | ----------- |
24
+ | update:model-value | |
@@ -0,0 +1,54 @@
1
+ ## Props
2
+
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 | `'primary'` | `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 | `'text'` | `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 | `false` | - |
15
+ | **disabled** | Disables the input field, preventing user interaction and form submission<br/>**Example:** `false` | `boolean` | No | `false` | - |
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 | `false` | - |
19
+ | **success** | Applies success styling (green border and text) to indicate successful validation<br/>**Example:** `true` | `boolean` | No | `false` | - |
20
+ | **warning** | Applies warning styling (orange border and text) to indicate potential issues<br/>**Example:** `true` | `boolean` | No | `false` | - |
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 | `true` | - |
24
+ | **inputmode** | HTML inputmode attribute that provides hints for virtual keyboards on mobile devices<br/>**Example:** `"numeric"` | `InputHTMLAttributes['inputmode']` | No | `'text'` | `text, numeric, decimal, tel, search, email, url` |
25
+ | **size** | Controls the height and text size of the input component<br/>**Example:** `"md"` | `MazSize` | No | `'md'` | `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 | `false` | - |
27
+ | **auto-focus** | Automatically focuses the input when the component mounts<br/>**Example:** `false` | `boolean` | No | `false` | - |
28
+ | **border-active** | When true, shows the colored border immediately instead of only on focus<br/>**Example:** `false` | `boolean` | No | `false` | - |
29
+ | **left-icon** | Icon displayed on the left side of the input. Can be an icon name string or icon component<br/>**Example:** `"user"` | `string \| IconComponent` | No | `undefined` | - |
30
+ | **right-icon** | Icon displayed on the right side of the input. Can be an icon name string or icon component<br/>**Example:** `"search"` | `string \| IconComponent` | No | `undefined` | - |
31
+ | **rounded-size** | Controls the border radius of the input component<br/>**Example:** `"lg"` | `'none' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'full'` | No | `'lg'` | `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
+
37
+ ## Events
38
+
39
+ | Event name | Properties | Description |
40
+ | ------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
41
+ | click | **event** `Event` - The native click event object | Triggered when the user clicks on the input field |
42
+ | update:model-value | **value** `T` - The new input value (string, number, boolean, null, or undefined) | Triggered when the input value changes, used for v-model two-way binding.<br/>This event is debounced if the debounce prop is enabled |
43
+ | focus | **event** `Event` - The native focus event object | Triggered when the input field gains focus (user clicks or tabs into the field) |
44
+ | blur | **event** `Event` - The native blur event object | Triggered when the input field loses focus (user clicks outside or tabs away) |
45
+ | change | **event** `Event` - The native change event object | Triggered when the input value changes and the field loses focus.<br/>Different from input event which fires on every keystroke |
46
+ | input | **event** `Event` - The native input event object | Triggered on every keystroke or input interaction (real-time input changes).<br/>This is the raw input event, not debounced |
47
+
48
+ ## Slots
49
+
50
+ | Name | Description | Bindings |
51
+ | ---------- | ----------------------------------------------------- | -------- |
52
+ | left-icon | Custom content for the left side of the input field. | |
53
+ | right-icon | Custom content for the right side of the input field. | |
54
+ | loader | Loader slot. | |
@@ -0,0 +1,31 @@
1
+ ## Props
2
+
3
+ | Name | Description | Type | Required | Default |
4
+ | --------------------- | ---------------------------------------------------- | ------------------------- | -------- | ----------- |
5
+ | **style** | The style of the component | `Native type` | No | `undefined` |
6
+ | **class** | The class of the component | `Native type` | No | `undefined` |
7
+ | **src** | The source of the image | `string \| Image \| null` | No | `undefined` |
8
+ | **alt** | The alt of the image | `string` | No | `undefined` |
9
+ | **hide-loader** | Remove the loader | `boolean` | No | `undefined` |
10
+ | **observer-once** | Remove the observer once the image is loaded | `boolean` | No | `true` |
11
+ | **load-once** | Remove the observer once the image is loaded | `boolean` | No | `undefined` |
12
+ | **image-height-full** | Make the image height full | `boolean` | No | `undefined` |
13
+ | **observer-options** | The options of the observer | `Native type` | No | `undefined` |
14
+ | **fallback-src** | The fallback src to replace the src on loading error | `string` | No | `undefined` |
15
+ | **img-class** | The classes of the image element | `Native type` | No | `undefined` |
16
+ | **block** | The image will be displayed in full width | `boolean` | No | `undefined` |
17
+
18
+ ## Events
19
+
20
+ | Event name | Properties | Description |
21
+ | ------------ | ---------- | -------------------------------------- |
22
+ | intersecting | | Emitted when the image is intersecting |
23
+ | loading | | Emitted when the image is loading |
24
+ | loaded | | Emitted when the image is loaded |
25
+ | error | | Emitted when the image is in error |
26
+
27
+ ## Slots
28
+
29
+ | Name | Description | Bindings |
30
+ | ------- | ----------- | -------- |
31
+ | default | | |