wave-ui 3.10.1 → 3.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/dist/types/$waveui.d.ts +221 -0
  2. package/dist/types/$waveui.js +2 -0
  3. package/dist/types/colors.d.ts +503 -0
  4. package/dist/types/colors.js +2 -0
  5. package/dist/types/components/WAccordion.d.ts +226 -0
  6. package/dist/types/components/WAccordion.js +2 -0
  7. package/dist/types/components/WAlert.d.ts +225 -0
  8. package/dist/types/components/WAlert.js +2 -0
  9. package/dist/types/components/WApp.d.ts +84 -0
  10. package/dist/types/components/WApp.js +2 -0
  11. package/dist/types/components/WBadge.d.ts +194 -0
  12. package/dist/types/components/WBadge.js +2 -0
  13. package/dist/types/components/WBreadcrumbs.d.ts +129 -0
  14. package/dist/types/components/WBreadcrumbs.js +2 -0
  15. package/dist/types/components/WButton.d.ts +218 -0
  16. package/dist/types/components/WButton.js +2 -0
  17. package/dist/types/components/WCard.d.ts +140 -0
  18. package/dist/types/components/WCard.js +2 -0
  19. package/dist/types/components/WCheckbox.d.ts +132 -0
  20. package/dist/types/components/WCheckbox.js +2 -0
  21. package/dist/types/components/WCheckboxes.d.ts +141 -0
  22. package/dist/types/components/WCheckboxes.js +2 -0
  23. package/dist/types/components/WConfirm.d.ts +250 -0
  24. package/dist/types/components/WConfirm.js +2 -0
  25. package/dist/types/components/WDialog.d.ts +189 -0
  26. package/dist/types/components/WDialog.js +2 -0
  27. package/dist/types/components/WDivider.d.ts +49 -0
  28. package/dist/types/components/WDivider.js +2 -0
  29. package/dist/types/components/WDrawer.d.ts +249 -0
  30. package/dist/types/components/WDrawer.js +2 -0
  31. package/dist/types/components/WFlex.d.ts +137 -0
  32. package/dist/types/components/WFlex.js +2 -0
  33. package/dist/types/components/WForm.d.ts +165 -0
  34. package/dist/types/components/WForm.js +2 -0
  35. package/dist/types/components/WFormElement.d.ts +112 -0
  36. package/dist/types/components/WFormElement.js +2 -0
  37. package/dist/types/components/WGrid.d.ts +51 -0
  38. package/dist/types/components/WGrid.js +2 -0
  39. package/dist/types/components/WIcon.d.ts +167 -0
  40. package/dist/types/components/WIcon.js +2 -0
  41. package/dist/types/components/WImage.d.ts +172 -0
  42. package/dist/types/components/WImage.js +2 -0
  43. package/dist/types/components/WInput.d.ts +352 -0
  44. package/dist/types/components/WInput.js +2 -0
  45. package/dist/types/components/WList.d.ts +336 -0
  46. package/dist/types/components/WList.js +2 -0
  47. package/dist/types/components/WMenu.d.ts +250 -0
  48. package/dist/types/components/WMenu.js +2 -0
  49. package/dist/types/components/WNotification.d.ts +283 -0
  50. package/dist/types/components/WNotification.js +2 -0
  51. package/dist/types/components/WNotificationManager.d.ts +33 -0
  52. package/dist/types/components/WNotificationManager.js +2 -0
  53. package/dist/types/components/WOverlay.d.ts +118 -0
  54. package/dist/types/components/WOverlay.js +2 -0
  55. package/dist/types/components/WProgress.d.ts +177 -0
  56. package/dist/types/components/WProgress.js +2 -0
  57. package/dist/types/components/WRadio.d.ts +121 -0
  58. package/dist/types/components/WRadio.js +2 -0
  59. package/dist/types/components/WRadios.d.ts +129 -0
  60. package/dist/types/components/WRadios.js +2 -0
  61. package/dist/types/components/WRating.d.ts +176 -0
  62. package/dist/types/components/WRating.js +2 -0
  63. package/dist/types/components/WSelect.d.ts +416 -0
  64. package/dist/types/components/WSelect.js +2 -0
  65. package/dist/types/components/WSlider.d.ts +263 -0
  66. package/dist/types/components/WSlider.js +2 -0
  67. package/dist/types/components/WSpinner.d.ts +101 -0
  68. package/dist/types/components/WSpinner.js +2 -0
  69. package/dist/types/components/WSteps.d.ts +29 -0
  70. package/dist/types/components/WSteps.js +2 -0
  71. package/dist/types/components/WSwitch.d.ts +132 -0
  72. package/dist/types/components/WSwitch.js +2 -0
  73. package/dist/types/components/WTable.d.ts +504 -0
  74. package/dist/types/components/WTable.js +2 -0
  75. package/dist/types/components/WTabs.d.ts +343 -0
  76. package/dist/types/components/WTabs.js +2 -0
  77. package/dist/types/components/WTag.d.ts +160 -0
  78. package/dist/types/components/WTag.js +2 -0
  79. package/dist/types/components/WTextarea.d.ts +257 -0
  80. package/dist/types/components/WTextarea.js +2 -0
  81. package/dist/types/components/WTimeline.d.ts +102 -0
  82. package/dist/types/components/WTimeline.js +2 -0
  83. package/dist/types/components/WToolbar.d.ts +134 -0
  84. package/dist/types/components/WToolbar.js +2 -0
  85. package/dist/types/components/WTooltip.d.ts +170 -0
  86. package/dist/types/components/WTooltip.js +2 -0
  87. package/dist/types/components/WTree.d.ts +359 -0
  88. package/dist/types/components/WTree.js +2 -0
  89. package/dist/types/components/index.d.ts +42 -0
  90. package/dist/types/components/index.js +2 -0
  91. package/dist/types/extra-vue-types.d.ts +8 -0
  92. package/dist/types/extra-vue-types.js +2 -0
  93. package/dist/types/index.d.ts +5 -0
  94. package/dist/types/index.js +4 -0
  95. package/dist/types/plugin.d.ts +19 -0
  96. package/dist/types/plugin.js +2 -0
  97. package/dist/wave-ui.cjs.js +1 -1
  98. package/dist/wave-ui.css +1 -1
  99. package/dist/wave-ui.es.js +359 -333
  100. package/dist/wave-ui.umd.js +1 -1
  101. package/package.json +8 -2
  102. package/src/wave-ui/components/w-autocomplete.vue +1 -8
  103. package/src/wave-ui/components/w-input.vue +1 -0
  104. package/src/wave-ui/components/w-parallax.vue +0 -1
  105. package/src/wave-ui/components/w-select.vue +10 -8
  106. package/src/wave-ui/components/w-switch.vue +1 -1
  107. package/src/wave-ui/components/w-table.vue +18 -1
  108. package/src/wave-ui/components/w-textarea.vue +12 -10
  109. package/src/wave-ui/index.d.ts +21 -0
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,352 @@
1
+ import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
2
+ import { PublicProps, ResolveProps } from '../extra-vue-types';
3
+ export interface WaveInputProps {
4
+ /**
5
+ * ``value` in Vue 2.`
6
+ * The text content of the input field.
7
+ * Gets updated on text input.
8
+ * @property {any} modelValue - Default: ''
9
+ * @see https://antoniandre.github.io/wave-ui/w-input
10
+ */
11
+ modelValue?: any;
12
+ /**
13
+ * Applies a native HTML `type` attribute.
14
+ * @property {} type - Default: 'text'
15
+ * @see https://antoniandre.github.io/wave-ui/w-input
16
+ */
17
+ type?: string;
18
+ /**
19
+ * Sets a visible label for the input field.
20
+ * @property {string} label
21
+ * @see https://antoniandre.github.io/wave-ui/w-input
22
+ */
23
+ label?: string;
24
+ /**
25
+ * Sets the position of the label to one of the following positions: 'left\', \'right\', \'inside\'.
26
+ * @property {string} labelPosition - Default: 'inside'
27
+ * @see https://antoniandre.github.io/wave-ui/w-input
28
+ */
29
+ labelPosition?: string;
30
+ /**
31
+ * Adds an icon on the left inside the input field.
32
+ * Accepts a string: e.g. `mdi mdi-eye`.
33
+ * @property {string} innerIconLeft
34
+ * @see https://antoniandre.github.io/wave-ui/w-input
35
+ */
36
+ innerIconLeft?: string;
37
+ /**
38
+ * Adds an icon on the right inside the input field.
39
+ * Accepts a string: e.g. `mdi mdi-eye`.
40
+ * @property {string} innerIconRight
41
+ * @see https://antoniandre.github.io/wave-ui/w-input
42
+ */
43
+ innerIconRight?: string;
44
+ /**
45
+ * Prevents moving the label above the input field when the `labelPosition` is equal to `inside`. If a placeholder is present, it will be hidden and the label will be displayed instead.
46
+ * When a value is set the static label is replaced by the textual value.
47
+ * @property {boolean} staticLabel
48
+ * @see https://antoniandre.github.io/wave-ui/w-input
49
+ */
50
+ staticLabel?: boolean;
51
+ /**
52
+ * Provide a placeholder for the input field. If a label is positioned inside, it will be moved above the field so it doesn't overlap.
53
+ * @property {string} placeholder
54
+ * @see https://antoniandre.github.io/wave-ui/w-input
55
+ */
56
+ placeholder?: string;
57
+ /**
58
+ * Applies a color to the input field's text. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
59
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
60
+ * @property {string} color - Default: 'primary'
61
+ * @see https://antoniandre.github.io/wave-ui/w-input
62
+ * @see https://antoniandre.github.io/wave-ui/colors
63
+ */
64
+ color?: string;
65
+ /**
66
+ * Applies a color to the input field's background. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
67
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
68
+ * @property {string} bgColor
69
+ * @see https://antoniandre.github.io/wave-ui/w-input
70
+ * @see https://antoniandre.github.io/wave-ui/colors
71
+ */
72
+ bgColor?: string;
73
+ /**
74
+ * Applies a specific color to the input field's label. Note that on validation failure, the validation-color takes precedence.
75
+ * Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
76
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
77
+ * @property {string} labelColor - Default: 'primary'
78
+ * @see https://antoniandre.github.io/wave-ui/w-input
79
+ * @see https://antoniandre.github.io/wave-ui/colors
80
+ */
81
+ labelColor?: string;
82
+ /**
83
+ * TODO: Add Description
84
+ * @property {string} progressColor
85
+ * @see https://antoniandre.github.io/wave-ui/w-input
86
+ */
87
+ progressColor?: string;
88
+ /**
89
+ * Applies the native HTML `minlength` attribute.
90
+ * @property {number|string} minlength
91
+ * @see https://antoniandre.github.io/wave-ui/w-input
92
+ */
93
+ minlength?: number | string;
94
+ /**
95
+ * Applies the native HTML `maxlength` attribute which prevents typing more than this amount of characters.
96
+ * @property {number|string} maxlength
97
+ * @see https://antoniandre.github.io/wave-ui/w-input
98
+ */
99
+ maxlength?: number | string;
100
+ /**
101
+ * For `type="number"` inputs.
102
+ * Applies the native HTML `step` attribute which sets an incremental/decremental integer or floating step number, e.g. `0.3`.
103
+ * @property {number|string} step
104
+ * @see https://antoniandre.github.io/wave-ui/w-input
105
+ */
106
+ step?: number | string;
107
+ /**
108
+ * For `type="number"` inputs.
109
+ * Applies the native HTML `min` attribute which sets an integer or floating minimum number.
110
+ * @property {number|string} min
111
+ * @see https://antoniandre.github.io/wave-ui/w-input
112
+ */
113
+ min?: number | string;
114
+ /**
115
+ * For `type="number"` inputs.
116
+ * Applies the native HTML `max` attribute which sets an integer or floating maximum number.
117
+ * @property {number|string} max
118
+ * @see https://antoniandre.github.io/wave-ui/w-input
119
+ */
120
+ max?: number | string;
121
+ /**
122
+ * The outline style applies the provided `color` (by default the `primary` color is used) to the text and border and no background color is set.
123
+ * @property {boolean} outline
124
+ * @see https://antoniandre.github.io/wave-ui/w-input
125
+ */
126
+ outline?: boolean;
127
+ /**
128
+ * Sets a maximum border-radius on the corners of the input field, giving it a round look.
129
+ * @property {boolean} round
130
+ * @see https://antoniandre.github.io/wave-ui/w-input
131
+ */
132
+ round?: boolean;
133
+ /**
134
+ * Applies a drop shadow to the input field.
135
+ * @property {boolean} shadow
136
+ * @see https://antoniandre.github.io/wave-ui/w-input
137
+ */
138
+ shadow?: boolean;
139
+ /**
140
+ * Removes the default border-radius and sets sharp edges on the input field.
141
+ * @property {boolean} tile
142
+ * @see https://antoniandre.github.io/wave-ui/w-input
143
+ */
144
+ tile?: boolean;
145
+ /**
146
+ * TODO: Add Description
147
+ * @property {boolean} multiple
148
+ * @see https://antoniandre.github.io/wave-ui/w-input
149
+ */
150
+ multiple?: boolean;
151
+ /**
152
+ * TODO: Add Description
153
+ * @property {boolean|string} preview - Default: true
154
+ * @see https://antoniandre.github.io/wave-ui/w-input
155
+ */
156
+ preview?: boolean | string;
157
+ /**
158
+ * When set to `true`, displays an indefinite-value progress bar below the input field. If a number is given, it will be the value of the progress.
159
+ * @property {boolean|number} loading - Default: false
160
+ * @see https://antoniandre.github.io/wave-ui/w-input
161
+ */
162
+ loading?: boolean | number;
163
+ /**
164
+ * TODO: Add Description
165
+ * @property {boolean} showProgress
166
+ * @see https://antoniandre.github.io/wave-ui/w-input
167
+ */
168
+ showProgress?: boolean;
169
+ /**
170
+ * TODO: Add Description
171
+ * @property {Array<any>} files
172
+ * @see https://antoniandre.github.io/wave-ui/w-input
173
+ */
174
+ files?: Array<any>;
175
+ /**
176
+ * TODO: Add Description
177
+ * @property {boolean} dark
178
+ * @see https://antoniandre.github.io/wave-ui/w-input
179
+ */
180
+ dark?: boolean;
181
+ /**
182
+ * TODO: Add Description
183
+ * @property {boolean} light
184
+ * @see https://antoniandre.github.io/wave-ui/w-input
185
+ */
186
+ light?: boolean;
187
+ }
188
+ export interface WaveInputEmits {
189
+ /**
190
+ * Emitted each time the input text (or file) changes.<br>Updates the v-model value in Vue 2.x only.
191
+ * @param {any} renameMe1 - The new textual input value.
192
+ * @see https://antoniandre.github.io/wave-ui/w-input
193
+ */
194
+ 'onInput'?: (renameMe1: any) => void;
195
+ /**
196
+ * Emitted each time the input text changes.<br>Updates the v-model value in Vue 3 only.
197
+ * @param {any} renameMe1 - The new textual input value.
198
+ * @see https://antoniandre.github.io/wave-ui/w-input
199
+ */
200
+ 'onUpdate:modelValue'?: (renameMe1: any) => void;
201
+ /**
202
+ * Emitted on input focus.
203
+ * @param {any} renameMe1 - The associated focus DOM event.
204
+ * @see https://antoniandre.github.io/wave-ui/w-input
205
+ */
206
+ 'onFocus'?: (renameMe1: any) => void;
207
+ /**
208
+ * Emitted on input blur.
209
+ * @param {any} renameMe1 - The associated blur DOM event.
210
+ * @see https://antoniandre.github.io/wave-ui/w-input
211
+ */
212
+ 'onBlur'?: (renameMe1: any) => void;
213
+ /**
214
+ * Emitted on click of the left inner icon, if any.
215
+ * @param {any} renameMe1 - The associated click DOM event.
216
+ * @see https://antoniandre.github.io/wave-ui/w-input
217
+ */
218
+ 'onClick:innerIconLeft'?: (renameMe1: any) => void;
219
+ /**
220
+ * Emitted on click of the right inner icon, if any.
221
+ * @param {any} renameMe1 - The associated click DOM event.
222
+ * @see https://antoniandre.github.io/wave-ui/w-input
223
+ */
224
+ 'onClick:innerIconRight'?: (renameMe1: any) => void;
225
+ /**
226
+ * Emitted continuously while uploading a file. When using the <code>multiple</code> option, this is the overall progress of all the files together.<br>You can use it with <code>:overall-progress.sync</code> in Vue 2, or <code>v-model:overall-progress</code> in Vue 3.
227
+ * @see https://antoniandre.github.io/wave-ui/w-input
228
+ */
229
+ 'onUpdate:overallProgress'?: () => void;
230
+ }
231
+ export interface WaveInputComputeds extends ComputedOptions {
232
+ /**
233
+ * TODO: Add Description
234
+ * @see https://antoniandre.github.io/wave-ui/w-input
235
+ */
236
+ attrs: ComputedGetter<any>;
237
+ /**
238
+ * TODO: Add Description
239
+ * @see https://antoniandre.github.io/wave-ui/w-input
240
+ */
241
+ listeners: ComputedGetter<any>;
242
+ /**
243
+ * TODO: Add Description
244
+ * @see https://antoniandre.github.io/wave-ui/w-input
245
+ */
246
+ hasValue: ComputedGetter<any>;
247
+ /**
248
+ * TODO: Add Description
249
+ * @see https://antoniandre.github.io/wave-ui/w-input
250
+ */
251
+ hasLabel: ComputedGetter<any>;
252
+ /**
253
+ * TODO: Add Description
254
+ * @see https://antoniandre.github.io/wave-ui/w-input
255
+ */
256
+ hasLoading: ComputedGetter<any>;
257
+ /**
258
+ * TODO: Add Description
259
+ * @see https://antoniandre.github.io/wave-ui/w-input
260
+ */
261
+ loadingValue: ComputedGetter<any>;
262
+ /**
263
+ * TODO: Add Description
264
+ * @see https://antoniandre.github.io/wave-ui/w-input
265
+ */
266
+ showLabelInside: ComputedGetter<any>;
267
+ /**
268
+ * TODO: Add Description
269
+ * @see https://antoniandre.github.io/wave-ui/w-input
270
+ */
271
+ overallFilesProgress: ComputedGetter<any>;
272
+ /**
273
+ * TODO: Add Description
274
+ * @see https://antoniandre.github.io/wave-ui/w-input
275
+ */
276
+ uploadInProgress: ComputedGetter<any>;
277
+ /**
278
+ * TODO: Add Description
279
+ * @see https://antoniandre.github.io/wave-ui/w-input
280
+ */
281
+ uploadComplete: ComputedGetter<any>;
282
+ /**
283
+ * TODO: Add Description
284
+ * @see https://antoniandre.github.io/wave-ui/w-input
285
+ */
286
+ classes: ComputedGetter<any>;
287
+ /**
288
+ * TODO: Add Description
289
+ * @see https://antoniandre.github.io/wave-ui/w-input
290
+ */
291
+ inputWrapClasses: ComputedGetter<any>;
292
+ }
293
+ export interface WaveInputMethods extends MethodOptions {
294
+ /**
295
+ * TODO: Add Description
296
+ * @param {any} e
297
+ * @see https://antoniandre.github.io/wave-ui/w-input
298
+ */
299
+ onInput(e: any): void;
300
+ /**
301
+ * TODO: Add Description
302
+ * @param {any} e
303
+ * @see https://antoniandre.github.io/wave-ui/w-input
304
+ */
305
+ onFocus(e: any): void;
306
+ /**
307
+ * TODO: Add Description
308
+ * @param {any} e
309
+ * @see https://antoniandre.github.io/wave-ui/w-input
310
+ */
311
+ onBlur(e: any): void;
312
+ /**
313
+ * TODO: Add Description
314
+ * @param {any} e
315
+ * @see https://antoniandre.github.io/wave-ui/w-input
316
+ */
317
+ onFileChange(e: any): void;
318
+ /**
319
+ * TODO: Add Description
320
+ * @param {any} original
321
+ * @param {any} file
322
+ * @see https://antoniandre.github.io/wave-ui/w-input
323
+ */
324
+ readFile(original: any, file: any): void;
325
+ }
326
+ export type WaveInputSlots = SlotsType<{
327
+ /**
328
+ * The label content, if the `label` prop is not flexible enough.
329
+ * @see https://antoniandre.github.io/wave-ui/w-input
330
+ */
331
+ 'default': () => any;
332
+ /**
333
+ * TODO: Add Description
334
+ * @see https://antoniandre.github.io/wave-ui/w-input
335
+ */
336
+ 'no-file': () => any;
337
+ /**
338
+ * The left icon, if the `innerIconLeft` prop is not flexible enough.
339
+ * @see https://antoniandre.github.io/wave-ui/w-input
340
+ */
341
+ 'icon-left': (_: {
342
+ inputId: string;
343
+ }) => any;
344
+ /**
345
+ * The right icon, if the `innerIconRight` prop is not flexible enough.
346
+ * @see https://antoniandre.github.io/wave-ui/w-input
347
+ */
348
+ 'icon-right': (_: {
349
+ inputId: string;
350
+ }) => any;
351
+ }>;
352
+ export type WInput = DefineComponent<WaveInputProps, {}, {}, WaveInputComputeds, WaveInputMethods, {}, {}, WaveInputEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveInputProps & WaveInputEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveInputProps>, WaveInputSlots>;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,336 @@
1
+ import { ComputedGetter, ComputedOptions, DefineComponent, EmitsOptions, ExtractDefaultPropTypes, MethodOptions, SlotsType } from 'vue';
2
+ import { PublicProps, ResolveProps } from '../extra-vue-types';
3
+ export interface WaveListProps {
4
+ /**
5
+ * Expecting an array of objects. Each object being a list item, it should include at least a `label` attribute.
6
+ * Alternatively, you can provide an integer number (call it `x`), to loop through and create `x` items in the list. You can then use the individual slots `item-title.x` & `item-content.x` to define each item.
7
+ * @property {Array<any>|number} [items]
8
+ * @see https://antoniandre.github.io/wave-ui/w-list
9
+ */
10
+ items: Array<any> | number;
11
+ /**
12
+ * ``value` in Vue 2.`
13
+ * Provide an array of values if `multiple` is set to true, or a single value otherwise, to dictate the selected state of the list items.
14
+ * Also accepts full objects when `return-object` is set to true.
15
+ * This value gets updated when using a v-model.
16
+ * @property {any} modelValue
17
+ * @see https://antoniandre.github.io/wave-ui/w-list
18
+ */
19
+ modelValue?: any;
20
+ /**
21
+ * Sets the type of list to checklist: each item has a checkbox.
22
+ * @property {boolean} checklist
23
+ * @see https://antoniandre.github.io/wave-ui/w-list
24
+ */
25
+ checklist?: boolean;
26
+ /**
27
+ * When `checklist` is true, displays round checkboxes instead of square ones.
28
+ * @property {boolean} roundCheckboxes
29
+ * @see https://antoniandre.github.io/wave-ui/w-list
30
+ */
31
+ roundCheckboxes?: boolean;
32
+ /**
33
+ * When selectable, allows multiple selections. A checklist always has multiple selections.
34
+ * @property {boolean} multiple
35
+ * @see https://antoniandre.github.io/wave-ui/w-list
36
+ */
37
+ multiple?: boolean;
38
+ /**
39
+ * When set to true, will add an id on the list and all the list items.
40
+ * Useful for accessibility aria fields for instance.
41
+ * @property {boolean|string} addIds
42
+ * @see https://antoniandre.github.io/wave-ui/w-list
43
+ */
44
+ addIds?: boolean | string;
45
+ /**
46
+ * On mouseover, highlights the list items with the given `color`. Also adds a small vertical padding on the list items to space them.
47
+ * @property {boolean} hover
48
+ * @see https://antoniandre.github.io/wave-ui/w-list
49
+ */
50
+ hover?: boolean;
51
+ /**
52
+ * Applies a color to the list items's text. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
53
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
54
+ * @property {string} color
55
+ * @see https://antoniandre.github.io/wave-ui/w-list
56
+ * @see https://antoniandre.github.io/wave-ui/colors
57
+ */
58
+ color?: string;
59
+ /**
60
+ * Applies a color to the selected list items's background. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
61
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
62
+ * @property {string} selectionColor
63
+ * @see https://antoniandre.github.io/wave-ui/w-list
64
+ * @see https://antoniandre.github.io/wave-ui/colors
65
+ */
66
+ selectionColor?: string;
67
+ /**
68
+ * Applies a color to the list items's background. Accepts all the color names of the color palette, status colors, or custom colors (learn more about the colors in the `colors` knowledge base page).
69
+ * Providing a color hex, rgb(a) or hsl(a) will not work.
70
+ * @property {string} bgColor
71
+ * @see https://antoniandre.github.io/wave-ui/w-list
72
+ * @see https://antoniandre.github.io/wave-ui/colors
73
+ */
74
+ bgColor?: string;
75
+ /**
76
+ * Set the list as a navigation menu. All the items having a `route` attribute will be converted to link or router-link if vue-router is present.
77
+ * @property {boolean} nav
78
+ * @see https://antoniandre.github.io/wave-ui/w-list
79
+ */
80
+ nav?: boolean;
81
+ /**
82
+ * A global icon string to apply to all the list items. E.g. `mdi mdi-home`.
83
+ * @property {string} icon - Default: ''
84
+ * @see https://antoniandre.github.io/wave-ui/w-list
85
+ */
86
+ icon?: string;
87
+ /**
88
+ * The property name (aka "key") in each item object where to find the label of the item.
89
+ * @property {string} itemLabelKey - Default: 'label'
90
+ * @see https://antoniandre.github.io/wave-ui/w-list
91
+ */
92
+ itemLabelKey?: string;
93
+ /**
94
+ * The property name (aka "key") in each item object where to find the value of the item.
95
+ * @property {string} itemValueKey - Default: 'value'
96
+ * @see https://antoniandre.github.io/wave-ui/w-list
97
+ */
98
+ itemValueKey?: string;
99
+ /**
100
+ * The property name (aka "key") in each item object where to find an optional CSS class for this item.
101
+ * @property {string} itemClassKey - Default: 'class'
102
+ * @see https://antoniandre.github.io/wave-ui/w-list
103
+ */
104
+ itemClassKey?: string;
105
+ /**
106
+ * The property name (aka "key") in each item object where to find an optional color for this item.
107
+ * @property {string} itemColorKey - Default: 'color'
108
+ * @see https://antoniandre.github.io/wave-ui/w-list
109
+ */
110
+ itemColorKey?: string;
111
+ /**
112
+ * The property name (aka "key") in each item object where to find an optional route for this item, to be used in `nav` lists.
113
+ * Since we usually set a `to` prop for router-links/nuxt-links, and `href` for `<a>` tags, the `route` option unifies both.
114
+ * @property {string} itemRouteKey - Default: 'route'
115
+ * @see https://antoniandre.github.io/wave-ui/w-list
116
+ */
117
+ itemRouteKey?: string;
118
+ /**
119
+ * Applies a custom CSS class to every list item.
120
+ * @property {string} itemClass
121
+ * @see https://antoniandre.github.io/wave-ui/w-list
122
+ */
123
+ itemClass?: string;
124
+ /**
125
+ * TODO: Add Description
126
+ * @property {number} depth - Default: 0
127
+ * @see https://antoniandre.github.io/wave-ui/w-list
128
+ */
129
+ depth?: number;
130
+ /**
131
+ * The current list selection is returned via the `value` prop or `v-model` as an array of full objects or a single full object (returning the original as given) when `multiple` is set to false.
132
+ * @property {boolean} returnObject
133
+ * @see https://antoniandre.github.io/wave-ui/w-list
134
+ */
135
+ returnObject?: boolean;
136
+ /**
137
+ * Once at least one item is selected, prevents the list to have no selection. Clicking an item when only this one is selected will not unselect it.
138
+ * @property {boolean} noUnselect
139
+ * @see https://antoniandre.github.io/wave-ui/w-list
140
+ */
141
+ noUnselect?: boolean;
142
+ /**
143
+ * Allows the navigation through the list items with the keyboard arrows up and down, when set to true and when the items are selectable (the `w-list` has a `value` or `v-model`, or is a `nav` or `checklist`).
144
+ * @property {boolean} arrowsNavigation
145
+ * @see https://antoniandre.github.io/wave-ui/w-list
146
+ */
147
+ arrowsNavigation?: boolean;
148
+ }
149
+ export interface WaveListEmits {
150
+ /**
151
+ * Emitted each time the state of the list changes.<br>Updates the <code>v-model</code> value in Vue 2.x only.
152
+ * @param {any} renameMe1 - An array of values of all the selected list items.
153
+ * @see https://antoniandre.github.io/wave-ui/w-list
154
+ */
155
+ 'onInput'?: (renameMe1: any) => void;
156
+ /**
157
+ * Emitted each time the state of the list changes (when an item is selected or unselected).<br>Updates the v-model value in Vue 3 only.
158
+ * @param {any} renameMe1 - An array of values of all the selected list items.
159
+ * @see https://antoniandre.github.io/wave-ui/w-list
160
+ */
161
+ 'onUpdate:modelValue'?: (renameMe1: any) => void;
162
+ /**
163
+ * Emitted on each list item click.
164
+ * @param {any} renameMe1 - The clicked list item's object.
165
+ * @see https://antoniandre.github.io/wave-ui/w-list
166
+ */
167
+ 'onItemClick'?: (renameMe1: any) => void;
168
+ /**
169
+ * Emitted on each list item selection or unselection (via click or keyboard <kbd>enter</kbd> key when focused).
170
+ * @param {any} renameMe1 - The selected list item's object.
171
+ * @see https://antoniandre.github.io/wave-ui/w-list
172
+ */
173
+ 'onItemSelect'?: (renameMe1: any) => void;
174
+ /**
175
+ * Emitted on <kbd>escape</kbd> key down, when the focus is on any of the list items.
176
+ * @see https://antoniandre.github.io/wave-ui/w-list
177
+ */
178
+ 'onKeydown:escape'?: () => void;
179
+ /**
180
+ * Emitted on <kbd>enter</kbd> key down, when the focus is on any of the list items.
181
+ * @see https://antoniandre.github.io/wave-ui/w-list
182
+ */
183
+ 'onKeydown:enter'?: () => void;
184
+ }
185
+ export interface WaveListComputeds extends ComputedOptions {
186
+ /**
187
+ * TODO: Add Description
188
+ * @see https://antoniandre.github.io/wave-ui/w-list
189
+ */
190
+ hasRouter: ComputedGetter<any>;
191
+ /**
192
+ * TODO: Add Description
193
+ * @see https://antoniandre.github.io/wave-ui/w-list
194
+ */
195
+ listId: ComputedGetter<any>;
196
+ /**
197
+ * TODO: Add Description
198
+ * @see https://antoniandre.github.io/wave-ui/w-list
199
+ */
200
+ selectedItems: ComputedGetter<any>;
201
+ /**
202
+ * TODO: Add Description
203
+ * @see https://antoniandre.github.io/wave-ui/w-list
204
+ */
205
+ enabledItemsIndexes: ComputedGetter<any>;
206
+ /**
207
+ * TODO: Add Description
208
+ * @see https://antoniandre.github.io/wave-ui/w-list
209
+ */
210
+ isMultipleSelect: ComputedGetter<any>;
211
+ /**
212
+ * TODO: Add Description
213
+ * @see https://antoniandre.github.io/wave-ui/w-list
214
+ */
215
+ isSelectable: ComputedGetter<any>;
216
+ /**
217
+ * TODO: Add Description
218
+ * @see https://antoniandre.github.io/wave-ui/w-list
219
+ */
220
+ SelectionColor: ComputedGetter<any>;
221
+ /**
222
+ * TODO: Add Description
223
+ * @see https://antoniandre.github.io/wave-ui/w-list
224
+ */
225
+ classes: ComputedGetter<any>;
226
+ }
227
+ export interface WaveListMethods extends MethodOptions {
228
+ /**
229
+ * TODO: Add Description
230
+ * @param {any} item
231
+ * @see https://antoniandre.github.io/wave-ui/w-list
232
+ */
233
+ getItemValue(item: any): void;
234
+ /**
235
+ * TODO: Add Description
236
+ * @param {any} item
237
+ * @param {any} forcedValue
238
+ * @see https://antoniandre.github.io/wave-ui/w-list
239
+ */
240
+ selectItem(item: any, forcedValue: any): void;
241
+ /**
242
+ * TODO: Add Description
243
+ * @param {any} item
244
+ * @see https://antoniandre.github.io/wave-ui/w-list
245
+ */
246
+ liLabelClasses(item: any): void;
247
+ /**
248
+ * TODO: Add Description
249
+ * @param {any} li
250
+ * @param {any} index
251
+ * @param {any} selected
252
+ * @see https://antoniandre.github.io/wave-ui/w-list
253
+ */
254
+ liLabelProps(li: any, index: any, selected: any): void;
255
+ /**
256
+ * TODO: Add Description
257
+ * @param {any} items
258
+ * @see https://antoniandre.github.io/wave-ui/w-list
259
+ */
260
+ checkSelection(items: any): void;
261
+ /**
262
+ * TODO: Add Description
263
+ * @see https://antoniandre.github.io/wave-ui/w-list
264
+ */
265
+ emitSelection(): void;
266
+ /**
267
+ * TODO: Add Description
268
+ * @param {any} index
269
+ * @param {any} [next] - true
270
+ * @see https://antoniandre.github.io/wave-ui/w-list
271
+ */
272
+ focusPrevNextItem(index: any, next?: any): void;
273
+ /**
274
+ * TODO: Add Description
275
+ * @param {any} li
276
+ * @see https://antoniandre.github.io/wave-ui/w-list
277
+ */
278
+ cleanLi(li: any): void;
279
+ /**
280
+ * TODO: Add Description
281
+ * @see https://antoniandre.github.io/wave-ui/w-list
282
+ */
283
+ refreshListItems(): void;
284
+ /**
285
+ * TODO: Add Description
286
+ * @param {any} selection
287
+ * @see https://antoniandre.github.io/wave-ui/w-list
288
+ */
289
+ applySelectionOnItems(selection: any): void;
290
+ }
291
+ export type WaveListSlots = SlotsType<{
292
+ /**
293
+ * TODO: Add Description
294
+ * @param {any} item TODO: Describe me!
295
+ * @param {any} index TODO: Describe me!
296
+ * @param {any} selected TODO: Describe me!
297
+ * @see https://antoniandre.github.io/wave-ui/w-list
298
+ */
299
+ 'default': (_: {
300
+ item: any;
301
+ index: any;
302
+ selected: any;
303
+ }) => any;
304
+ /**
305
+ * `x` is an integer starting at `1`.
306
+ * Provide a custom content for a single item: the item at the index `x`.
307
+ * @param {any} item The current item object.
308
+ * @param {any} index The item index in the list. Starts at 1 to be consistent with the slot name.
309
+ * @param {any} selected A boolean representing the selected state of the current item.
310
+ * @see https://antoniandre.github.io/wave-ui/w-list
311
+ */
312
+ 'item.x': (_: {
313
+ item: any;
314
+ index: any;
315
+ selected: any;
316
+ }) => any;
317
+ /**
318
+ * Provide a custom content for every item. Applies to all the items, but can be overridden by the `item.x` slot.
319
+ * @param {any} item The current item object.
320
+ * @param {any} index The item index in the list. Starts at 1 to be consistent with the `item.x` slot.
321
+ * @param {any} selected A boolean representing the selected state of the current item.
322
+ * @see https://antoniandre.github.io/wave-ui/w-list
323
+ */
324
+ 'item': (_: {
325
+ item: any;
326
+ index: any;
327
+ selected: any;
328
+ }) => any;
329
+ } & {
330
+ [k in `item.${number}`]: (_: {
331
+ item: any;
332
+ index: any;
333
+ selected: any;
334
+ }) => any;
335
+ }>;
336
+ export type WList = DefineComponent<WaveListProps, {}, {}, WaveListComputeds, WaveListMethods, {}, {}, WaveListEmits & EmitsOptions, string, PublicProps, ResolveProps<WaveListProps & WaveListEmits, EmitsOptions>, ExtractDefaultPropTypes<WaveListProps>, WaveListSlots>;