@vonage/vivid-vue 4.12.1 → 4.13.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.
@@ -9,43 +9,43 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
9
9
  type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
10
10
  default: undefined;
11
11
  };
12
+ /**
13
+ * Allows setting a custom aria-label for the dismiss button.
14
+ */
12
15
  dismissButtonAriaLabel: {
13
16
  type: PropType<string>;
14
17
  default: undefined;
15
18
  };
16
19
  /**
17
- * if the alert is removable
18
- * accepts boolean
20
+ * Adds a close button to the Alert.
19
21
  */
20
22
  removable: {
21
23
  type: PropType<boolean>;
22
24
  default: undefined;
23
25
  };
24
26
  /**
25
- * the placement of the alert
27
+ * The placement of the Alert on the screen.
26
28
  */
27
29
  placement: {
28
30
  type: PropType<"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end">;
29
31
  default: undefined;
30
32
  };
31
33
  /**
32
- * the text of the alert heading
33
- * accepts string
34
+ * Adds a headline to the Alert.
34
35
  */
35
36
  headline: {
36
37
  type: PropType<string>;
37
38
  default: undefined;
38
39
  };
39
40
  /**
40
- * the main text of the alert
41
- * accepts string
41
+ * The main text of the Alert.
42
42
  */
43
43
  text: {
44
44
  type: PropType<string>;
45
45
  default: undefined;
46
46
  };
47
47
  /**
48
- * alert header icon
48
+ * The icon to display in the Alert. Takes precedence over the connotation's icon.
49
49
  * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
50
50
  */
51
51
  icon: {
@@ -53,29 +53,28 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
53
53
  default: undefined;
54
54
  };
55
55
  /**
56
- * the timeout ms to show the alert
57
- * accepts number
56
+ * Timeout after which the Alert will close.
58
57
  */
59
58
  timeoutms: {
60
59
  type: PropType<number>;
61
60
  default: undefined;
62
61
  };
63
62
  /**
64
- * alert connotation
63
+ * Sets an appropriate icon / icon color for the connotation.
65
64
  */
66
65
  connotation: {
67
66
  type: PropType<"accent" | "information" | "success" | "warning" | "announcement" | "alert">;
68
67
  default: undefined;
69
68
  };
70
69
  /**
71
- * alert state
70
+ * Controls the `position` of the Alert.
72
71
  */
73
72
  strategy: {
74
73
  type: PropType<"fixed" | "static">;
75
74
  default: undefined;
76
75
  };
77
76
  /**
78
- * indicates whether the alert is open
77
+ * Open state of the Alert.
79
78
  */
80
79
  open: {
81
80
  type: PropType<boolean>;
@@ -94,43 +93,43 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
94
93
  type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
95
94
  default: undefined;
96
95
  };
96
+ /**
97
+ * Allows setting a custom aria-label for the dismiss button.
98
+ */
97
99
  dismissButtonAriaLabel: {
98
100
  type: PropType<string>;
99
101
  default: undefined;
100
102
  };
101
103
  /**
102
- * if the alert is removable
103
- * accepts boolean
104
+ * Adds a close button to the Alert.
104
105
  */
105
106
  removable: {
106
107
  type: PropType<boolean>;
107
108
  default: undefined;
108
109
  };
109
110
  /**
110
- * the placement of the alert
111
+ * The placement of the Alert on the screen.
111
112
  */
112
113
  placement: {
113
114
  type: PropType<"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end">;
114
115
  default: undefined;
115
116
  };
116
117
  /**
117
- * the text of the alert heading
118
- * accepts string
118
+ * Adds a headline to the Alert.
119
119
  */
120
120
  headline: {
121
121
  type: PropType<string>;
122
122
  default: undefined;
123
123
  };
124
124
  /**
125
- * the main text of the alert
126
- * accepts string
125
+ * The main text of the Alert.
127
126
  */
128
127
  text: {
129
128
  type: PropType<string>;
130
129
  default: undefined;
131
130
  };
132
131
  /**
133
- * alert header icon
132
+ * The icon to display in the Alert. Takes precedence over the connotation's icon.
134
133
  * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
135
134
  */
136
135
  icon: {
@@ -138,29 +137,28 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
138
137
  default: undefined;
139
138
  };
140
139
  /**
141
- * the timeout ms to show the alert
142
- * accepts number
140
+ * Timeout after which the Alert will close.
143
141
  */
144
142
  timeoutms: {
145
143
  type: PropType<number>;
146
144
  default: undefined;
147
145
  };
148
146
  /**
149
- * alert connotation
147
+ * Sets an appropriate icon / icon color for the connotation.
150
148
  */
151
149
  connotation: {
152
150
  type: PropType<"accent" | "information" | "success" | "warning" | "announcement" | "alert">;
153
151
  default: undefined;
154
152
  };
155
153
  /**
156
- * alert state
154
+ * Controls the `position` of the Alert.
157
155
  */
158
156
  strategy: {
159
157
  type: PropType<"fixed" | "static">;
160
158
  default: undefined;
161
159
  };
162
160
  /**
163
- * indicates whether the alert is open
161
+ * Open state of the Alert.
164
162
  */
165
163
  open: {
166
164
  type: PropType<boolean>;
@@ -10,43 +10,43 @@ declare const _default: import("vue").DefineComponent<{
10
10
  type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
11
11
  default: undefined;
12
12
  };
13
+ /**
14
+ * Allows setting a custom aria-label for the dismiss button.
15
+ */
13
16
  dismissButtonAriaLabel: {
14
17
  type: PropType<string>;
15
18
  default: undefined;
16
19
  };
17
20
  /**
18
- * if the alert is removable
19
- * accepts boolean
21
+ * Adds a close button to the Alert.
20
22
  */
21
23
  removable: {
22
24
  type: PropType<boolean>;
23
25
  default: undefined;
24
26
  };
25
27
  /**
26
- * the placement of the alert
28
+ * The placement of the Alert on the screen.
27
29
  */
28
30
  placement: {
29
31
  type: PropType<"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end">;
30
32
  default: undefined;
31
33
  };
32
34
  /**
33
- * the text of the alert heading
34
- * accepts string
35
+ * Adds a headline to the Alert.
35
36
  */
36
37
  headline: {
37
38
  type: PropType<string>;
38
39
  default: undefined;
39
40
  };
40
41
  /**
41
- * the main text of the alert
42
- * accepts string
42
+ * The main text of the Alert.
43
43
  */
44
44
  text: {
45
45
  type: PropType<string>;
46
46
  default: undefined;
47
47
  };
48
48
  /**
49
- * alert header icon
49
+ * The icon to display in the Alert. Takes precedence over the connotation's icon.
50
50
  * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
51
51
  */
52
52
  icon: {
@@ -54,29 +54,28 @@ declare const _default: import("vue").DefineComponent<{
54
54
  default: undefined;
55
55
  };
56
56
  /**
57
- * the timeout ms to show the alert
58
- * accepts number
57
+ * Timeout after which the Alert will close.
59
58
  */
60
59
  timeoutms: {
61
60
  type: PropType<number>;
62
61
  default: undefined;
63
62
  };
64
63
  /**
65
- * alert connotation
64
+ * Sets an appropriate icon / icon color for the connotation.
66
65
  */
67
66
  connotation: {
68
67
  type: PropType<"accent" | "information" | "success" | "warning" | "announcement" | "alert">;
69
68
  default: undefined;
70
69
  };
71
70
  /**
72
- * alert state
71
+ * Controls the `position` of the Alert.
73
72
  */
74
73
  strategy: {
75
74
  type: PropType<"fixed" | "static">;
76
75
  default: undefined;
77
76
  };
78
77
  /**
79
- * indicates whether the alert is open
78
+ * Open state of the Alert.
80
79
  */
81
80
  open: {
82
81
  type: PropType<boolean>;
@@ -131,14 +130,14 @@ declare const _default: import("vue").DefineComponent<{
131
130
  target: Alert;
132
131
  }): true;
133
132
  /**
134
- * Fired when the alert is opened
133
+ * Fired when the Alert is opened
135
134
  * @type {CustomEvent<undefined>}
136
135
  */
137
136
  open(event: CustomEvent<undefined> & {
138
137
  target: Alert;
139
138
  }): true;
140
139
  /**
141
- * Fired when the alert is closed
140
+ * Fired when the Alert is closed
142
141
  * @type {CustomEvent<undefined>}
143
142
  */
144
143
  close(event: CustomEvent<undefined> & {
@@ -152,43 +151,43 @@ declare const _default: import("vue").DefineComponent<{
152
151
  type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
153
152
  default: undefined;
154
153
  };
154
+ /**
155
+ * Allows setting a custom aria-label for the dismiss button.
156
+ */
155
157
  dismissButtonAriaLabel: {
156
158
  type: PropType<string>;
157
159
  default: undefined;
158
160
  };
159
161
  /**
160
- * if the alert is removable
161
- * accepts boolean
162
+ * Adds a close button to the Alert.
162
163
  */
163
164
  removable: {
164
165
  type: PropType<boolean>;
165
166
  default: undefined;
166
167
  };
167
168
  /**
168
- * the placement of the alert
169
+ * The placement of the Alert on the screen.
169
170
  */
170
171
  placement: {
171
172
  type: PropType<"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end">;
172
173
  default: undefined;
173
174
  };
174
175
  /**
175
- * the text of the alert heading
176
- * accepts string
176
+ * Adds a headline to the Alert.
177
177
  */
178
178
  headline: {
179
179
  type: PropType<string>;
180
180
  default: undefined;
181
181
  };
182
182
  /**
183
- * the main text of the alert
184
- * accepts string
183
+ * The main text of the Alert.
185
184
  */
186
185
  text: {
187
186
  type: PropType<string>;
188
187
  default: undefined;
189
188
  };
190
189
  /**
191
- * alert header icon
190
+ * The icon to display in the Alert. Takes precedence over the connotation's icon.
192
191
  * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
193
192
  */
194
193
  icon: {
@@ -196,29 +195,28 @@ declare const _default: import("vue").DefineComponent<{
196
195
  default: undefined;
197
196
  };
198
197
  /**
199
- * the timeout ms to show the alert
200
- * accepts number
198
+ * Timeout after which the Alert will close.
201
199
  */
202
200
  timeoutms: {
203
201
  type: PropType<number>;
204
202
  default: undefined;
205
203
  };
206
204
  /**
207
- * alert connotation
205
+ * Sets an appropriate icon / icon color for the connotation.
208
206
  */
209
207
  connotation: {
210
208
  type: PropType<"accent" | "information" | "success" | "warning" | "announcement" | "alert">;
211
209
  default: undefined;
212
210
  };
213
211
  /**
214
- * alert state
212
+ * Controls the `position` of the Alert.
215
213
  */
216
214
  strategy: {
217
215
  type: PropType<"fixed" | "static">;
218
216
  default: undefined;
219
217
  };
220
218
  /**
221
- * indicates whether the alert is open
219
+ * Open state of the Alert.
222
220
  */
223
221
  open: {
224
222
  type: PropType<boolean>;
@@ -263,11 +261,11 @@ declare const _default: import("vue").DefineComponent<{
263
261
  open: boolean;
264
262
  }, SlotsType<{
265
263
  /**
266
- * The main content of the alert.
264
+ * The main content of the Alert.
267
265
  */
268
266
  main: Record<string, never>;
269
267
  /**
270
- * Add action items to alert using this slot.
268
+ * Add action items to the Alert using this slot.
271
269
  */
272
270
  'action-items': Record<string, never>;
273
271
  /**
@@ -104,6 +104,27 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
104
104
  type: PropType<"normal" | "expanded">;
105
105
  default: undefined;
106
106
  };
107
+ /**
108
+ * Overrides the localized error message for invalid file type
109
+ */
110
+ invalidFileTypeError: {
111
+ type: PropType<string>;
112
+ default: undefined;
113
+ };
114
+ /**
115
+ * Overrides the localized error message for max file exceed
116
+ */
117
+ maxFilesExceededError: {
118
+ type: PropType<string>;
119
+ default: undefined;
120
+ };
121
+ /**
122
+ * Overrides the localized error message for file too big
123
+ */
124
+ fileTooBigError: {
125
+ type: PropType<string>;
126
+ default: undefined;
127
+ };
107
128
  }, {
108
129
  componentName: import("vue").Ref<string>;
109
130
  element: import("vue").Ref<FilePicker | null>;
@@ -112,6 +133,9 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
112
133
  maxFilesChanged(_oldValue: number, newValue: number): void;
113
134
  maxFileSizeChanged(_oldValue: number, newValue: number): void;
114
135
  acceptChanged(_oldValue: string, newValue: string): void;
136
+ invalidFileTypeErrorChanged(_oldValue: string, newValue: string): void;
137
+ maxFilesExceededErrorChanged(_oldValue: string, newValue: string): void;
138
+ fileTooBigErrorChanged(_oldValue: string, newValue: string): void;
115
139
  nameChanged(previous: string, next: string): unknown;
116
140
  validate(): void;
117
141
  formResetCallback(): void;
@@ -223,6 +247,27 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
223
247
  type: PropType<"normal" | "expanded">;
224
248
  default: undefined;
225
249
  };
250
+ /**
251
+ * Overrides the localized error message for invalid file type
252
+ */
253
+ invalidFileTypeError: {
254
+ type: PropType<string>;
255
+ default: undefined;
256
+ };
257
+ /**
258
+ * Overrides the localized error message for max file exceed
259
+ */
260
+ maxFilesExceededError: {
261
+ type: PropType<string>;
262
+ default: undefined;
263
+ };
264
+ /**
265
+ * Overrides the localized error message for file too big
266
+ */
267
+ fileTooBigError: {
268
+ type: PropType<string>;
269
+ default: undefined;
270
+ };
226
271
  }>>, {
227
272
  name: string;
228
273
  ariaCurrent: "page" | "step" | "location" | "date" | "time" | "true" | "false";
@@ -238,5 +283,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
238
283
  maxFiles: number;
239
284
  maxFileSize: number;
240
285
  accept: string;
286
+ invalidFileTypeError: string;
287
+ maxFilesExceededError: string;
288
+ fileTooBigError: string;
241
289
  }>;
242
290
  export default _default;
@@ -105,6 +105,27 @@ declare const _default: import("vue").DefineComponent<{
105
105
  type: PropType<"normal" | "expanded">;
106
106
  default: undefined;
107
107
  };
108
+ /**
109
+ * Overrides the localized error message for invalid file type
110
+ */
111
+ invalidFileTypeError: {
112
+ type: PropType<string>;
113
+ default: undefined;
114
+ };
115
+ /**
116
+ * Overrides the localized error message for max file exceed
117
+ */
118
+ maxFilesExceededError: {
119
+ type: PropType<string>;
120
+ default: undefined;
121
+ };
122
+ /**
123
+ * Overrides the localized error message for file too big
124
+ */
125
+ fileTooBigError: {
126
+ type: PropType<string>;
127
+ default: undefined;
128
+ };
108
129
  }, {
109
130
  componentName: import("vue").Ref<string>;
110
131
  element: import("vue").Ref<FilePicker | null>;
@@ -113,6 +134,9 @@ declare const _default: import("vue").DefineComponent<{
113
134
  maxFilesChanged(_oldValue: number, newValue: number): void;
114
135
  maxFileSizeChanged(_oldValue: number, newValue: number): void;
115
136
  acceptChanged(_oldValue: string, newValue: string): void;
137
+ invalidFileTypeErrorChanged(_oldValue: string, newValue: string): void;
138
+ maxFilesExceededErrorChanged(_oldValue: string, newValue: string): void;
139
+ fileTooBigErrorChanged(_oldValue: string, newValue: string): void;
116
140
  nameChanged(previous: string, next: string): unknown;
117
141
  validate(): void;
118
142
  formResetCallback(): void;
@@ -274,6 +298,27 @@ declare const _default: import("vue").DefineComponent<{
274
298
  type: PropType<"normal" | "expanded">;
275
299
  default: undefined;
276
300
  };
301
+ /**
302
+ * Overrides the localized error message for invalid file type
303
+ */
304
+ invalidFileTypeError: {
305
+ type: PropType<string>;
306
+ default: undefined;
307
+ };
308
+ /**
309
+ * Overrides the localized error message for max file exceed
310
+ */
311
+ maxFilesExceededError: {
312
+ type: PropType<string>;
313
+ default: undefined;
314
+ };
315
+ /**
316
+ * Overrides the localized error message for file too big
317
+ */
318
+ fileTooBigError: {
319
+ type: PropType<string>;
320
+ default: undefined;
321
+ };
277
322
  }>> & {
278
323
  onKeydown?: ((event: KeyboardEvent & {
279
324
  target: FilePicker;
@@ -311,6 +356,9 @@ declare const _default: import("vue").DefineComponent<{
311
356
  maxFiles: number;
312
357
  maxFileSize: number;
313
358
  accept: string;
359
+ invalidFileTypeError: string;
360
+ maxFilesExceededError: string;
361
+ fileTooBigError: string;
314
362
  }, SlotsType<{
315
363
  /**
316
364
  * Describes how to use the file-picker. Alternative to the `helper-text` attribute.
@@ -59,11 +59,12 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
59
59
  element: import("vue").Ref<Menu | null>;
60
60
  }, import("vue").Data, {}, {
61
61
  /**
62
- * Focuses the first item in the menu.
62
+ * Moves focus into the menu. If there is a child with the `autofocus` attribute, it will be focused.
63
+ * Otherwise, the first focusable child will be focused.
63
64
  */
64
65
  focus(): void;
65
66
  /**
66
- * Collapses any expanded menu items.
67
+ * Collapses any expanded Menu Items.
67
68
  */
68
69
  collapseExpandedItem(): void;
69
70
  openChanged(_: boolean, newValue: boolean): void;
@@ -60,11 +60,12 @@ declare const _default: import("vue").DefineComponent<{
60
60
  element: import("vue").Ref<Menu | null>;
61
61
  }, unknown, {}, {
62
62
  /**
63
- * Focuses the first item in the menu.
63
+ * Moves focus into the menu. If there is a child with the `autofocus` attribute, it will be focused.
64
+ * Otherwise, the first focusable child will be focused.
64
65
  */
65
66
  focus(): void;
66
67
  /**
67
- * Collapses any expanded menu items.
68
+ * Collapses any expanded Menu Items.
68
69
  */
69
70
  collapseExpandedItem(): void;
70
71
  openChanged(_: boolean, newValue: boolean): void;