@dxc-technology/halstack-react 0.0.0-68dad03 → 0.0.0-694be29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/index.d.mts +1099 -600
- package/dist/index.d.ts +1099 -600
- package/dist/index.js +13941 -8171
- package/dist/index.mjs +13050 -7284
- package/package.json +43 -41
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
|
-
import { ReactNode, SVGProps, ReactElement,
|
|
3
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
+
import { ReactNode, SVGProps, ReactElement, JSX, Ref, ReactEventHandler } from 'react';
|
|
4
3
|
import { SortColumn } from 'react-data-grid';
|
|
5
4
|
import * as _emotion_styled from '@emotion/styled';
|
|
6
5
|
import * as _emotion_react from '@emotion/react';
|
|
@@ -59,7 +58,7 @@ type AccordionItemProps = {
|
|
|
59
58
|
*/
|
|
60
59
|
tabIndex?: number;
|
|
61
60
|
};
|
|
62
|
-
type CommonProps$
|
|
61
|
+
type CommonProps$a = {
|
|
63
62
|
/**
|
|
64
63
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
65
64
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
@@ -70,7 +69,7 @@ type CommonProps$9 = {
|
|
|
70
69
|
*/
|
|
71
70
|
children: ReactElement<AccordionItemProps>[] | ReactElement<AccordionItemProps>;
|
|
72
71
|
};
|
|
73
|
-
type IndependentProps = CommonProps$
|
|
72
|
+
type IndependentProps = CommonProps$a & {
|
|
74
73
|
/**
|
|
75
74
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
76
75
|
*/
|
|
@@ -91,7 +90,7 @@ type IndependentProps = CommonProps$9 & {
|
|
|
91
90
|
*/
|
|
92
91
|
onActiveChange?: (index: number) => void;
|
|
93
92
|
};
|
|
94
|
-
type NonIndependentProps = CommonProps$
|
|
93
|
+
type NonIndependentProps = CommonProps$a & {
|
|
95
94
|
/**
|
|
96
95
|
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
97
96
|
*/
|
|
@@ -112,10 +111,10 @@ type NonIndependentProps = CommonProps$9 & {
|
|
|
112
111
|
*/
|
|
113
112
|
onActiveChange?: (index: number[]) => void;
|
|
114
113
|
};
|
|
115
|
-
type Props$
|
|
114
|
+
type Props$M = IndependentProps | NonIndependentProps;
|
|
116
115
|
|
|
117
116
|
declare const DxcAccordion: {
|
|
118
|
-
(props: Props$
|
|
117
|
+
(props: Props$M): JSX.Element;
|
|
119
118
|
AccordionItem: ({ label, subLabel, badge, statusLight, icon, assistiveText, disabled, children, tabIndex, }: AccordionItemProps) => JSX.Element;
|
|
120
119
|
};
|
|
121
120
|
|
|
@@ -145,7 +144,7 @@ type Message = {
|
|
|
145
144
|
*/
|
|
146
145
|
text: ReactNode;
|
|
147
146
|
};
|
|
148
|
-
type CommonProps$
|
|
147
|
+
type CommonProps$9 = {
|
|
149
148
|
/**
|
|
150
149
|
* If true, the alert will have a close button that will remove the message from the alert,
|
|
151
150
|
* only in banner and inline modes. The rest of the functionality will depend
|
|
@@ -198,206 +197,152 @@ type ModeSpecificProps = {
|
|
|
198
197
|
*/
|
|
199
198
|
mode: "modal";
|
|
200
199
|
};
|
|
201
|
-
type Props$
|
|
200
|
+
type Props$L = CommonProps$9 & ModeSpecificProps;
|
|
202
201
|
|
|
203
|
-
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$
|
|
202
|
+
declare const DxcAlert: ({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$L) => react.JSX.Element;
|
|
204
203
|
|
|
205
|
-
type
|
|
206
|
-
/**
|
|
207
|
-
* The area inside the sidenav title. This area can be used to render custom content.
|
|
208
|
-
*/
|
|
209
|
-
children: ReactNode;
|
|
210
|
-
};
|
|
211
|
-
type SidenavSectionPropsType = {
|
|
212
|
-
/**
|
|
213
|
-
* The area inside the sidenav section. This area can be used to render sidenav groups, links and custom content.
|
|
214
|
-
*/
|
|
215
|
-
children: ReactNode;
|
|
216
|
-
};
|
|
217
|
-
type SidenavGroupPropsType = {
|
|
204
|
+
type SearchBarProps = {
|
|
218
205
|
/**
|
|
219
|
-
*
|
|
206
|
+
* If true, the search bar input will be focused when rendered.
|
|
220
207
|
*/
|
|
221
|
-
|
|
208
|
+
autoFocus?: boolean;
|
|
222
209
|
/**
|
|
223
|
-
* If true, the
|
|
224
|
-
* In addition, if it's collapsed and contains the currently selected link, the group title will also be marked as selected.
|
|
210
|
+
* If true, the component will be disabled.
|
|
225
211
|
*/
|
|
226
|
-
|
|
212
|
+
disabled?: boolean;
|
|
227
213
|
/**
|
|
228
|
-
*
|
|
214
|
+
* Function invoked when the search bar loses focus.
|
|
229
215
|
*/
|
|
230
|
-
|
|
216
|
+
onBlur?: (value: string) => void;
|
|
231
217
|
/**
|
|
232
|
-
*
|
|
218
|
+
* Function invoked when the user cancels the search.
|
|
233
219
|
*/
|
|
234
|
-
|
|
235
|
-
};
|
|
236
|
-
type SidenavLinkPropsType = {
|
|
220
|
+
onCancel?: () => void;
|
|
237
221
|
/**
|
|
238
|
-
*
|
|
222
|
+
* Function invoked when the user changes the input value.
|
|
239
223
|
*/
|
|
240
|
-
|
|
224
|
+
onChange?: (value: string) => void;
|
|
241
225
|
/**
|
|
242
|
-
*
|
|
226
|
+
* Function invoked when the Enter key is pressed.
|
|
243
227
|
*/
|
|
244
|
-
|
|
228
|
+
onEnter?: (value: string) => void;
|
|
245
229
|
/**
|
|
246
|
-
*
|
|
230
|
+
* Placeholder text displayed in the search bar input field.
|
|
247
231
|
*/
|
|
232
|
+
placeholder?: string;
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
type CommonItemProps = {
|
|
236
|
+
badge?: ReactElement;
|
|
248
237
|
icon?: string | SVG;
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
*/
|
|
238
|
+
label: string;
|
|
239
|
+
};
|
|
240
|
+
type Item$1 = CommonItemProps & {
|
|
241
|
+
onSelect?: () => void;
|
|
254
242
|
selected?: boolean;
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* The area inside the sidenav link.
|
|
261
|
-
*/
|
|
262
|
-
children: ReactNode;
|
|
263
|
-
/**
|
|
264
|
-
* Value of the tabindex.
|
|
265
|
-
*/
|
|
266
|
-
tabIndex?: number;
|
|
243
|
+
href?: string;
|
|
244
|
+
renderItem?: (props: {
|
|
245
|
+
children: ReactNode;
|
|
246
|
+
}) => ReactNode;
|
|
267
247
|
};
|
|
268
|
-
type
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
*/
|
|
272
|
-
title?: ReactNode;
|
|
273
|
-
/**
|
|
274
|
-
* The area inside the sidenav. This area can be used to render the content inside the sidenav.
|
|
275
|
-
*/
|
|
276
|
-
children: ReactNode;
|
|
248
|
+
type GroupItem$1 = CommonItemProps & {
|
|
249
|
+
items: (Item$1 | GroupItem$1)[];
|
|
250
|
+
defaultOpen?: boolean;
|
|
277
251
|
};
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
/**
|
|
282
|
-
* Option display value.
|
|
283
|
-
*/
|
|
284
|
-
label?: string;
|
|
285
|
-
/**
|
|
286
|
-
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
287
|
-
*/
|
|
288
|
-
icon?: string | SVG;
|
|
289
|
-
/**
|
|
290
|
-
* Option inner value.
|
|
291
|
-
*/
|
|
292
|
-
value: string;
|
|
252
|
+
type Section$1 = {
|
|
253
|
+
items: (Item$1 | GroupItem$1)[];
|
|
254
|
+
title?: string;
|
|
293
255
|
};
|
|
294
|
-
type Props$
|
|
295
|
-
/**
|
|
296
|
-
* An array of objects representing the options.
|
|
297
|
-
*/
|
|
298
|
-
options: Option$2[];
|
|
299
|
-
/**
|
|
300
|
-
* In case options include icons, whether the icon should appear
|
|
301
|
-
* after or before the label.
|
|
302
|
-
*/
|
|
303
|
-
optionsIconPosition?: "before" | "after";
|
|
304
|
-
/**
|
|
305
|
-
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
306
|
-
*/
|
|
307
|
-
icon?: string | SVG;
|
|
308
|
-
/**
|
|
309
|
-
* Whether the icon should appear after or before the label.
|
|
310
|
-
*/
|
|
311
|
-
iconPosition?: "before" | "after";
|
|
256
|
+
type Props$K = {
|
|
312
257
|
/**
|
|
313
|
-
*
|
|
314
|
-
|
|
315
|
-
label?: string;
|
|
316
|
-
/**
|
|
317
|
-
* Whether the arrow next to the label must be displayed or not.
|
|
318
|
-
*/
|
|
319
|
-
caretHidden?: boolean;
|
|
320
|
-
/**
|
|
321
|
-
* If true, the component will be disabled.
|
|
258
|
+
* Array of items to be displayed in the menu.
|
|
259
|
+
* Each item can be a single/simple item, a group item or a section.
|
|
322
260
|
*/
|
|
323
|
-
|
|
261
|
+
items: (Item$1 | GroupItem$1)[] | Section$1[];
|
|
324
262
|
/**
|
|
325
|
-
* If true
|
|
263
|
+
* If true the menu will be displayed with a border.
|
|
326
264
|
*/
|
|
327
|
-
|
|
265
|
+
displayBorder?: boolean;
|
|
328
266
|
/**
|
|
329
|
-
*
|
|
330
|
-
* The value of the selected option will be passed as a parameter.
|
|
267
|
+
* If true the menu will have lines marking the groups.
|
|
331
268
|
*/
|
|
332
|
-
|
|
269
|
+
displayGroupLines?: boolean;
|
|
333
270
|
/**
|
|
334
|
-
*
|
|
335
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right'
|
|
336
|
-
* properties in order to specify different margin sizes.
|
|
271
|
+
* If true the menu will have controls at the end.
|
|
337
272
|
*/
|
|
338
|
-
|
|
273
|
+
displayControlsAfter?: boolean;
|
|
339
274
|
/**
|
|
340
|
-
*
|
|
275
|
+
* If true the menu will be icons only and display a popover on click.
|
|
341
276
|
*/
|
|
342
|
-
|
|
277
|
+
hasPopOver?: boolean;
|
|
343
278
|
/**
|
|
344
|
-
*
|
|
279
|
+
* If true the menu will be displayed horizontally.
|
|
345
280
|
*/
|
|
346
|
-
|
|
281
|
+
isHorizontal?: boolean;
|
|
347
282
|
/**
|
|
348
|
-
*
|
|
349
|
-
*
|
|
283
|
+
* Function that will be called when an option is clicked.
|
|
284
|
+
* This is used to notify that an item has been selected to close any visible menu that is not managed by the navigation tree.
|
|
350
285
|
*/
|
|
351
|
-
|
|
286
|
+
onSelectItem?: () => void;
|
|
352
287
|
};
|
|
353
288
|
|
|
354
|
-
type
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
289
|
+
type Section = {
|
|
290
|
+
items: (Item$1 | GroupItem$1)[];
|
|
291
|
+
title?: string;
|
|
292
|
+
};
|
|
293
|
+
type SearchbarSidenavProps = Omit<SearchBarProps, "autoFocus" | "disabled" | "onCancel">;
|
|
294
|
+
type Props$J = {
|
|
359
295
|
/**
|
|
360
|
-
*
|
|
296
|
+
* The content rendered in the bottom part of the sidenav, under the navigation menu.
|
|
361
297
|
*/
|
|
362
|
-
|
|
298
|
+
bottomContent?: ReactNode;
|
|
363
299
|
/**
|
|
364
|
-
*
|
|
300
|
+
* Object with the properties of the branding placed at the top of the sidenav.
|
|
365
301
|
*/
|
|
366
|
-
|
|
367
|
-
};
|
|
368
|
-
type Props$E = {
|
|
302
|
+
appTitle?: string | ReactNode;
|
|
369
303
|
/**
|
|
370
|
-
*
|
|
304
|
+
* Initial state of the expansion of the sidenav, only when it is uncontrolled.
|
|
371
305
|
*/
|
|
372
|
-
|
|
306
|
+
defaultExpanded?: boolean;
|
|
373
307
|
/**
|
|
374
|
-
*
|
|
375
|
-
* for the first child in the content, so we recommend the use of Fragment
|
|
376
|
-
* to be applied correctly. Otherwise, the styles can be modified.
|
|
308
|
+
* If true the nav menu will have lines marking the groups.
|
|
377
309
|
*/
|
|
378
|
-
|
|
310
|
+
displayGroupLines?: boolean;
|
|
379
311
|
/**
|
|
380
|
-
*
|
|
381
|
-
* be
|
|
312
|
+
* If true, the sidenav is expanded.
|
|
313
|
+
* If undefined the component will be uncontrolled and the value will be managed internally by the component.
|
|
382
314
|
*/
|
|
383
|
-
|
|
315
|
+
expanded?: boolean;
|
|
384
316
|
/**
|
|
385
|
-
*
|
|
317
|
+
* Array of items to be displayed in the navigation menu.
|
|
318
|
+
* Each item can be a single/simple item, a group item or a section.
|
|
386
319
|
*/
|
|
387
|
-
|
|
320
|
+
navItems?: (Item$1 | GroupItem$1)[] | Section[];
|
|
388
321
|
/**
|
|
389
|
-
*
|
|
322
|
+
* Function called when the expansion state of the sidenav changes.
|
|
390
323
|
*/
|
|
391
|
-
|
|
324
|
+
onExpandedChange?: (value: boolean) => void;
|
|
392
325
|
/**
|
|
393
|
-
*
|
|
326
|
+
* When provided, a search bar will be rendered at the top of the sidenav.
|
|
394
327
|
*/
|
|
395
|
-
|
|
328
|
+
searchBar?: SearchbarSidenavProps;
|
|
396
329
|
/**
|
|
397
|
-
*
|
|
398
|
-
* custom area.
|
|
330
|
+
* The additional content rendered in the upper part of the sidenav, under the branding.
|
|
399
331
|
*/
|
|
400
|
-
|
|
332
|
+
topContent?: ReactNode;
|
|
333
|
+
};
|
|
334
|
+
|
|
335
|
+
type GroupItem = CommonItemProps & {
|
|
336
|
+
items: Item$1[];
|
|
337
|
+
};
|
|
338
|
+
type MainNavPropsType = (GroupItem | Item$1)[];
|
|
339
|
+
type SearchBarHeaderProps = Omit<SearchBarProps, "autoFocus" | "disabled">;
|
|
340
|
+
type Props$I = {
|
|
341
|
+
appTitle?: string;
|
|
342
|
+
navItems?: MainNavPropsType;
|
|
343
|
+
responsiveBottomContent?: ReactNode;
|
|
344
|
+
searchBar?: SearchBarHeaderProps;
|
|
345
|
+
sideContent?: ReactNode | ((isResponsive: boolean) => ReactNode);
|
|
401
346
|
};
|
|
402
347
|
|
|
403
348
|
type SocialLink = {
|
|
@@ -425,18 +370,14 @@ type BottomLink = {
|
|
|
425
370
|
text: string;
|
|
426
371
|
};
|
|
427
372
|
type Logo = {
|
|
428
|
-
/**
|
|
429
|
-
* URL to navigate when the logo is clicked.
|
|
430
|
-
*/
|
|
431
|
-
href?: string;
|
|
432
373
|
/**
|
|
433
374
|
* Source of the logo image.
|
|
434
375
|
*/
|
|
435
|
-
src: string;
|
|
376
|
+
src: string | SVG;
|
|
436
377
|
/**
|
|
437
378
|
* Alternative text for the logo image.
|
|
438
379
|
*/
|
|
439
|
-
|
|
380
|
+
alt: string;
|
|
440
381
|
};
|
|
441
382
|
type FooterPropsType = {
|
|
442
383
|
/**
|
|
@@ -444,29 +385,28 @@ type FooterPropsType = {
|
|
|
444
385
|
* the bottom part of the footer.
|
|
445
386
|
*/
|
|
446
387
|
bottomLinks?: BottomLink[];
|
|
447
|
-
/**
|
|
448
|
-
* The center section of the footer. Can be used to render custom
|
|
449
|
-
* content in this area.
|
|
450
|
-
*/
|
|
451
|
-
children?: ReactNode;
|
|
452
388
|
/**
|
|
453
389
|
* The text that will be displayed as copyright disclaimer.
|
|
454
390
|
*/
|
|
455
391
|
copyright?: string;
|
|
456
392
|
/**
|
|
457
|
-
*
|
|
393
|
+
* Content to be displayed on the left side of the footer under the logo.
|
|
458
394
|
*/
|
|
459
|
-
|
|
395
|
+
leftContent?: ReactNode;
|
|
460
396
|
/**
|
|
461
|
-
*
|
|
397
|
+
* Logo to be displayed inside the footer
|
|
462
398
|
*/
|
|
463
|
-
|
|
399
|
+
logo?: Logo;
|
|
464
400
|
/**
|
|
465
401
|
* Determines the visual style and layout
|
|
466
402
|
* - "default": The default mode with full content and styling.
|
|
467
403
|
* - "reduced": A reduced mode with minimal content and styling.
|
|
468
404
|
*/
|
|
469
405
|
mode?: "default" | "reduced";
|
|
406
|
+
/**
|
|
407
|
+
* Content to be displayed on the right side of the footer before the socialLinks if provided.
|
|
408
|
+
*/
|
|
409
|
+
rightContent?: ReactNode;
|
|
470
410
|
/**
|
|
471
411
|
* An array of objects representing the links that will be rendered as
|
|
472
412
|
* icons at the top-right side of the footer.
|
|
@@ -474,7 +414,7 @@ type FooterPropsType = {
|
|
|
474
414
|
socialLinks?: SocialLink[];
|
|
475
415
|
/**
|
|
476
416
|
* Value of the tabindex for all interactive elements, except those
|
|
477
|
-
* inside the
|
|
417
|
+
* inside the leftContent and rightContent.
|
|
478
418
|
*/
|
|
479
419
|
tabIndex?: number;
|
|
480
420
|
};
|
|
@@ -485,12 +425,29 @@ type AppLayoutMainPropsType = {
|
|
|
485
425
|
*/
|
|
486
426
|
children: ReactNode;
|
|
487
427
|
};
|
|
428
|
+
type LogoPropsType = {
|
|
429
|
+
/**
|
|
430
|
+
* Alternative text for the logo image.
|
|
431
|
+
*/
|
|
432
|
+
alt: string;
|
|
433
|
+
/**
|
|
434
|
+
* URL to navigate when the logo is clicked.
|
|
435
|
+
*/
|
|
436
|
+
href?: string;
|
|
437
|
+
/**
|
|
438
|
+
* Function to be called on logo click.
|
|
439
|
+
*/
|
|
440
|
+
onClick?: () => void;
|
|
441
|
+
/**
|
|
442
|
+
* URL or SVG of the image that will be placed in the logo.
|
|
443
|
+
*/
|
|
444
|
+
src: string | SVG;
|
|
445
|
+
};
|
|
488
446
|
type ApplicationLayoutPropsType = {
|
|
489
447
|
/**
|
|
490
|
-
*
|
|
491
|
-
* visibility of the sidenav.
|
|
448
|
+
* Logo properties.
|
|
492
449
|
*/
|
|
493
|
-
|
|
450
|
+
logo?: LogoPropsType;
|
|
494
451
|
/**
|
|
495
452
|
* Header content.
|
|
496
453
|
*/
|
|
@@ -510,23 +467,87 @@ type ApplicationLayoutPropsType = {
|
|
|
510
467
|
};
|
|
511
468
|
|
|
512
469
|
declare const DxcApplicationLayout: {
|
|
513
|
-
({
|
|
514
|
-
Footer: ({ bottomLinks,
|
|
515
|
-
Header: {
|
|
516
|
-
({ underlined, content, responsiveContent, logo, margin, onClick, tabIndex, }: Props$E): JSX.Element;
|
|
517
|
-
Dropdown: (props: react.ComponentProps<({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$F) => react_jsx_runtime.JSX.Element>) => react_jsx_runtime.JSX.Element;
|
|
518
|
-
};
|
|
470
|
+
({ logo, header, sidenav, footer, children }: ApplicationLayoutPropsType): JSX.Element;
|
|
471
|
+
Footer: ({ bottomLinks, copyright, leftContent, logo, mode, rightContent, socialLinks, tabIndex, }: FooterPropsType) => JSX.Element;
|
|
472
|
+
Header: ({ appTitle, navItems, responsiveBottomContent, searchBar, sideContent, }: Props$I) => JSX.Element;
|
|
519
473
|
Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
474
|
+
Sidenav: ({ topContent, bottomContent, navItems, appTitle, displayGroupLines, expanded, defaultExpanded, onExpandedChange, searchBar, }: Props$J) => JSX.Element;
|
|
475
|
+
};
|
|
476
|
+
|
|
477
|
+
type Size$5 = "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
478
|
+
type Shape = "circle" | "square";
|
|
479
|
+
type Color = "primary" | "secondary" | "tertiary" | "success" | "info" | "neutral" | "warning" | "error";
|
|
480
|
+
interface Status {
|
|
481
|
+
mode: "default" | "info" | "success" | "warning" | "error";
|
|
482
|
+
position: "top" | "bottom";
|
|
483
|
+
}
|
|
484
|
+
type Props$H = {
|
|
485
|
+
/**
|
|
486
|
+
* Affects the visual style of the avatar. It can be used following semantic purposes or not.
|
|
487
|
+
*/
|
|
488
|
+
color?: Color;
|
|
489
|
+
/**
|
|
490
|
+
* If true, the component will be disabled.
|
|
491
|
+
*/
|
|
492
|
+
disabled?: boolean;
|
|
493
|
+
/**
|
|
494
|
+
* Material Symbol name or SVG element as the icon that will be placed as avatar.
|
|
495
|
+
*/
|
|
496
|
+
icon?: string | SVG;
|
|
497
|
+
/**
|
|
498
|
+
* URL of the image.
|
|
499
|
+
*/
|
|
500
|
+
imageSrc?: string;
|
|
501
|
+
/**
|
|
502
|
+
* Text label associated with the avatar.
|
|
503
|
+
* Used to generate and display initials inside the avatar.
|
|
504
|
+
*/
|
|
505
|
+
label?: string;
|
|
506
|
+
/**
|
|
507
|
+
* Page to be opened when the user clicks on the link.
|
|
508
|
+
*/
|
|
509
|
+
linkHref?: string;
|
|
510
|
+
/**
|
|
511
|
+
* This function will be called when the user clicks the avatar. Makes it behave as a button.
|
|
512
|
+
*/
|
|
513
|
+
onClick?: () => void;
|
|
514
|
+
/**
|
|
515
|
+
* Text to be displayed as label next to the avatar.
|
|
516
|
+
*/
|
|
517
|
+
primaryText?: string;
|
|
518
|
+
/**
|
|
519
|
+
* Ref to the avatar container element.
|
|
520
|
+
*/
|
|
521
|
+
ref?: Ref<HTMLDivElement>;
|
|
522
|
+
/**
|
|
523
|
+
* Text to be displayed as sublabel next to the avatar.
|
|
524
|
+
*/
|
|
525
|
+
secondaryText?: string;
|
|
526
|
+
/**
|
|
527
|
+
* This will determine if the avatar will be rounded square or a circle.
|
|
528
|
+
*/
|
|
529
|
+
shape?: Shape;
|
|
530
|
+
/**
|
|
531
|
+
* Size of the component.
|
|
532
|
+
*/
|
|
533
|
+
size?: Size$5;
|
|
534
|
+
/**
|
|
535
|
+
* Defines the color of the status indicator displayed on the avatar and where it will be placed.
|
|
536
|
+
* If not provided, no indicator will be rendered.
|
|
537
|
+
*/
|
|
538
|
+
status?: Status;
|
|
539
|
+
/**
|
|
540
|
+
* Value of the tabindex attribute. It will only apply when the onClick property is passed.
|
|
541
|
+
*/
|
|
542
|
+
tabIndex?: number;
|
|
543
|
+
/**
|
|
544
|
+
* Text to be displayed inside a tooltip when hovering the avatar.
|
|
545
|
+
*/
|
|
546
|
+
title?: string;
|
|
528
547
|
};
|
|
529
548
|
|
|
549
|
+
declare const DxcAvatar: ({ color, disabled, icon, imageSrc, label, linkHref, onClick, primaryText, ref, secondaryText, shape, size, status, tabIndex, title, }: Props$H) => react.JSX.Element;
|
|
550
|
+
|
|
530
551
|
type ContextualProps = {
|
|
531
552
|
/**
|
|
532
553
|
* Text to be placed in the badge.
|
|
@@ -563,7 +584,7 @@ type NotificationProps = {
|
|
|
563
584
|
*/
|
|
564
585
|
color?: never;
|
|
565
586
|
};
|
|
566
|
-
type CommonProps$
|
|
587
|
+
type CommonProps$8 = {
|
|
567
588
|
/**
|
|
568
589
|
* Text representing advisory information related to the badge. Under the hood, this prop also serves as an accessible label for the component.
|
|
569
590
|
*/
|
|
@@ -572,16 +593,20 @@ type CommonProps$7 = {
|
|
|
572
593
|
* Material Symbol name or SVG element used as the icon that will be placed next to the badge label in contextual mode.
|
|
573
594
|
*/
|
|
574
595
|
icon?: string | SVG;
|
|
596
|
+
/**
|
|
597
|
+
* Ref to be forwarded to the badge container element.
|
|
598
|
+
*/
|
|
599
|
+
ref?: React.Ref<HTMLDivElement>;
|
|
575
600
|
/**
|
|
576
601
|
* Size of the component.
|
|
577
602
|
*/
|
|
578
603
|
size?: "small" | "medium" | "large";
|
|
579
604
|
};
|
|
580
|
-
type Props$
|
|
605
|
+
type Props$G = (ContextualProps | NotificationProps) & CommonProps$8;
|
|
581
606
|
|
|
582
|
-
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$
|
|
607
|
+
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, ref, size, }: Props$G) => react.JSX.Element;
|
|
583
608
|
|
|
584
|
-
type Props$
|
|
609
|
+
type Props$F = {
|
|
585
610
|
/**
|
|
586
611
|
* Applies the spacing scale to all sides.
|
|
587
612
|
*/
|
|
@@ -616,13 +641,13 @@ type Props$C = {
|
|
|
616
641
|
children: ReactNode;
|
|
617
642
|
};
|
|
618
643
|
|
|
619
|
-
declare
|
|
644
|
+
declare const DxcBleed: ({ space, horizontal, vertical, top, right, bottom, left, children }: Props$F) => react.JSX.Element;
|
|
620
645
|
|
|
621
|
-
type Item
|
|
646
|
+
type Item = {
|
|
622
647
|
href?: string;
|
|
623
648
|
label: string;
|
|
624
649
|
};
|
|
625
|
-
type Props$
|
|
650
|
+
type Props$E = {
|
|
626
651
|
/**
|
|
627
652
|
* Provides a label that describes the type of navigation enabled by
|
|
628
653
|
* the component.
|
|
@@ -631,7 +656,7 @@ type Props$B = {
|
|
|
631
656
|
/**
|
|
632
657
|
* Array of objects representing the items of the breadcrumbs.
|
|
633
658
|
*/
|
|
634
|
-
items: Item
|
|
659
|
+
items: Item[];
|
|
635
660
|
/**
|
|
636
661
|
* Number of items before showing a collapsed version of the
|
|
637
662
|
* breadcrumbs. It can't be lower than two (root/collapsed action and
|
|
@@ -654,7 +679,7 @@ type Props$B = {
|
|
|
654
679
|
showRoot?: boolean;
|
|
655
680
|
};
|
|
656
681
|
|
|
657
|
-
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$
|
|
682
|
+
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$E) => react.JSX.Element;
|
|
658
683
|
|
|
659
684
|
type IconProps = {
|
|
660
685
|
/**
|
|
@@ -684,7 +709,7 @@ type OtherProps = {
|
|
|
684
709
|
*/
|
|
685
710
|
children: ReactNode;
|
|
686
711
|
};
|
|
687
|
-
type Props$
|
|
712
|
+
type Props$D = IconProps | OtherProps;
|
|
688
713
|
type BulletedListItemPropsType = {
|
|
689
714
|
/**
|
|
690
715
|
* Text to be shown in the list.
|
|
@@ -693,136 +718,246 @@ type BulletedListItemPropsType = {
|
|
|
693
718
|
};
|
|
694
719
|
|
|
695
720
|
declare const DxcBulletedList: {
|
|
696
|
-
({ children, type, icon }: Props$
|
|
721
|
+
({ children, type, icon }: Props$D): JSX.Element;
|
|
697
722
|
Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
|
|
698
723
|
};
|
|
699
724
|
|
|
700
725
|
type Semantic = "default" | "error" | "warning" | "success" | "info";
|
|
701
726
|
type Mode$1 = "primary" | "secondary" | "tertiary";
|
|
702
|
-
type Size$
|
|
727
|
+
type Size$4 = {
|
|
703
728
|
/**
|
|
704
729
|
* Height of the button.
|
|
705
730
|
*/
|
|
706
731
|
height?: "small" | "medium" | "large";
|
|
707
732
|
width?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
708
733
|
};
|
|
709
|
-
type Props$
|
|
710
|
-
/**
|
|
711
|
-
* Text to be placed in the button.
|
|
712
|
-
*/
|
|
713
|
-
label?: string;
|
|
714
|
-
/**
|
|
715
|
-
* The available button modes.
|
|
716
|
-
*/
|
|
717
|
-
mode?: Mode$1;
|
|
718
|
-
/**
|
|
719
|
-
* Specifies the semantic meaning of the buttons, which determines its color.
|
|
720
|
-
*/
|
|
721
|
-
semantic?: Semantic;
|
|
734
|
+
type Props$C = {
|
|
722
735
|
/**
|
|
723
736
|
* If true, the component will be disabled.
|
|
724
737
|
*/
|
|
725
738
|
disabled?: boolean;
|
|
739
|
+
/**
|
|
740
|
+
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
741
|
+
*/
|
|
742
|
+
icon?: string | SVG;
|
|
726
743
|
/**
|
|
727
744
|
* Whether the icon should appear after or before the label.
|
|
728
745
|
*/
|
|
729
746
|
iconPosition?: "before" | "after";
|
|
730
747
|
/**
|
|
731
|
-
*
|
|
748
|
+
* Text to be placed in the button.
|
|
732
749
|
*/
|
|
733
|
-
|
|
750
|
+
label?: string;
|
|
734
751
|
/**
|
|
735
|
-
* '
|
|
752
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
753
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
736
754
|
*/
|
|
737
|
-
|
|
755
|
+
margin?: Space$1 | Margin;
|
|
738
756
|
/**
|
|
739
|
-
*
|
|
757
|
+
* The available button modes.
|
|
740
758
|
*/
|
|
741
|
-
|
|
759
|
+
mode?: Mode$1;
|
|
742
760
|
/**
|
|
743
761
|
* This function will be called when the user clicks the button.
|
|
744
762
|
*/
|
|
745
763
|
onClick?: () => void;
|
|
746
764
|
/**
|
|
747
|
-
*
|
|
748
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
765
|
+
* ref to the button element.
|
|
749
766
|
*/
|
|
750
|
-
|
|
767
|
+
ref?: React.Ref<HTMLButtonElement>;
|
|
768
|
+
/**
|
|
769
|
+
* Specifies the semantic meaning of the buttons, which determines its color.
|
|
770
|
+
*/
|
|
771
|
+
semantic?: Semantic;
|
|
751
772
|
/**
|
|
752
773
|
* Size of the component.
|
|
753
774
|
*/
|
|
754
|
-
size?: Size$
|
|
775
|
+
size?: Size$4;
|
|
755
776
|
/**
|
|
756
777
|
* Value of the tabindex attribute.
|
|
757
778
|
*/
|
|
758
779
|
tabIndex?: number;
|
|
759
|
-
|
|
780
|
+
/**
|
|
781
|
+
* Value for the HTML properties title and aria-label.
|
|
782
|
+
*/
|
|
783
|
+
title?: string;
|
|
784
|
+
/**
|
|
785
|
+
* 'type' html prop of the button.
|
|
786
|
+
*/
|
|
787
|
+
type?: "button" | "reset" | "submit";
|
|
788
|
+
};
|
|
760
789
|
|
|
761
|
-
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$
|
|
790
|
+
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, ref, semantic, size, tabIndex, title, type, }: Props$C) => react.JSX.Element;
|
|
762
791
|
|
|
763
|
-
type
|
|
764
|
-
top?: Space$1;
|
|
765
|
-
bottom?: Space$1;
|
|
766
|
-
left?: Space$1;
|
|
767
|
-
right?: Space$1;
|
|
768
|
-
};
|
|
769
|
-
type Props$y = {
|
|
792
|
+
type Props$B = {
|
|
770
793
|
/**
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
*
|
|
794
|
+
* Alternative text description displayed when the specified image is not loaded.
|
|
795
|
+
*
|
|
796
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
797
|
+
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
774
798
|
*/
|
|
775
|
-
|
|
799
|
+
alt: string;
|
|
776
800
|
/**
|
|
777
|
-
*
|
|
801
|
+
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
802
|
+
* which is required regardless of the presence of the caption or not.
|
|
778
803
|
*/
|
|
779
|
-
|
|
804
|
+
caption?: string;
|
|
780
805
|
/**
|
|
781
|
-
*
|
|
782
|
-
* component. You can pass an object with 'top', 'bottom', 'left'
|
|
783
|
-
* and 'right' properties in order to specify different padding sizes.
|
|
806
|
+
* Sets the rendered height of the image.
|
|
784
807
|
*/
|
|
785
|
-
|
|
808
|
+
height?: string;
|
|
786
809
|
/**
|
|
787
|
-
*
|
|
810
|
+
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
811
|
+
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
788
812
|
*/
|
|
789
|
-
|
|
813
|
+
lazyLoading?: boolean;
|
|
814
|
+
/**
|
|
815
|
+
* Sets the object-fit CSS property.
|
|
816
|
+
*
|
|
817
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
818
|
+
*/
|
|
819
|
+
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
790
820
|
/**
|
|
791
|
-
*
|
|
792
|
-
*
|
|
821
|
+
* Sets the object-position CSS property.
|
|
822
|
+
*
|
|
823
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
793
824
|
*/
|
|
794
|
-
|
|
825
|
+
objectPosition?: string;
|
|
795
826
|
/**
|
|
796
|
-
* This function will be called when the
|
|
797
|
-
* will show some visual feedback on hover.
|
|
827
|
+
* This function will be called when the image fails to load.
|
|
798
828
|
*/
|
|
799
|
-
|
|
829
|
+
onError?: ReactEventHandler<HTMLImageElement>;
|
|
800
830
|
/**
|
|
801
|
-
*
|
|
831
|
+
* This function will be called when the image is loaded.
|
|
802
832
|
*/
|
|
803
|
-
|
|
833
|
+
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
804
834
|
/**
|
|
805
|
-
*
|
|
806
|
-
*
|
|
835
|
+
* One or more strings separated by commas, indicating a set of source sizes.
|
|
836
|
+
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
837
|
+
* then this attribute has no effect.
|
|
838
|
+
*
|
|
839
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
807
840
|
*/
|
|
808
|
-
|
|
841
|
+
sizes?: string;
|
|
809
842
|
/**
|
|
810
|
-
*
|
|
843
|
+
* URL of the image. This prop is required and must be valid.
|
|
811
844
|
*/
|
|
812
|
-
|
|
845
|
+
src: string;
|
|
846
|
+
/**
|
|
847
|
+
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
848
|
+
*
|
|
849
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
850
|
+
*/
|
|
851
|
+
srcSet?: string;
|
|
813
852
|
/**
|
|
814
|
-
*
|
|
853
|
+
* Sets the rendered width of the image.
|
|
815
854
|
*/
|
|
816
|
-
|
|
855
|
+
width?: string;
|
|
856
|
+
};
|
|
857
|
+
|
|
858
|
+
type Size$3 = {
|
|
859
|
+
width?: "fillParent" | "fitContent";
|
|
860
|
+
height?: "fillParent" | "fitContent";
|
|
861
|
+
};
|
|
862
|
+
type Props$A = {
|
|
817
863
|
/**
|
|
818
864
|
* Custom content that will be placed inside the component.
|
|
819
865
|
*/
|
|
820
866
|
children?: ReactNode;
|
|
867
|
+
/**
|
|
868
|
+
* Initial state of the checkbox, only when it is uncontrolled.
|
|
869
|
+
*/
|
|
870
|
+
defaultSelected?: boolean;
|
|
871
|
+
/**
|
|
872
|
+
* Defines the direction of the content inside the card. It can be set to "row" or "column". The default value is "column".
|
|
873
|
+
*/
|
|
874
|
+
direction?: "row" | "column";
|
|
875
|
+
/**
|
|
876
|
+
* Defines the size of the card when it is empty.
|
|
877
|
+
*/
|
|
878
|
+
emptySize?: {
|
|
879
|
+
width?: string;
|
|
880
|
+
height?: string;
|
|
881
|
+
iconSize?: "small" | "medium" | "large";
|
|
882
|
+
};
|
|
883
|
+
/**
|
|
884
|
+
* URL to navigate to when the card is clicked.
|
|
885
|
+
* If href is defined selectable will be ignored and the link will be always considered as an anchor.
|
|
886
|
+
*/
|
|
887
|
+
href?: string;
|
|
888
|
+
/**
|
|
889
|
+
* Image to be displayed inside the card.
|
|
890
|
+
*/
|
|
891
|
+
image?: Props$B;
|
|
892
|
+
/**
|
|
893
|
+
* Position of the image inside the card. It can be set to "before" or "after" the content.
|
|
894
|
+
*/
|
|
895
|
+
imagePosition?: "before" | "after";
|
|
896
|
+
/**
|
|
897
|
+
* If true, the card will be displayed as empty state.
|
|
898
|
+
*/
|
|
899
|
+
isEmpty?: boolean;
|
|
900
|
+
/**
|
|
901
|
+
* If true, a loading state will be displayed inside the card.
|
|
902
|
+
*/
|
|
903
|
+
isLoading?: boolean;
|
|
904
|
+
/**
|
|
905
|
+
* Defines the size of the loading card when isLoading is true.
|
|
906
|
+
*/
|
|
907
|
+
loadingSize?: {
|
|
908
|
+
width?: string;
|
|
909
|
+
height?: string;
|
|
910
|
+
};
|
|
911
|
+
/**
|
|
912
|
+
* Defines the visual style of the card. It can be set to "elevated" or "outlined".
|
|
913
|
+
*/
|
|
914
|
+
mode?: "elevated" | "outlined";
|
|
915
|
+
/**
|
|
916
|
+
* If true, the link will open in a new window. href must be provided for this to work.
|
|
917
|
+
*/
|
|
918
|
+
newWindow?: boolean;
|
|
919
|
+
/**
|
|
920
|
+
* Callback function that is called when the card is clicked.
|
|
921
|
+
* It receives a boolean value indicating whether the card is selected or not.
|
|
922
|
+
* selectable must be true for this to work.
|
|
923
|
+
*/
|
|
924
|
+
onSelectionChange?: (selected: boolean) => void;
|
|
925
|
+
/**
|
|
926
|
+
* Callback function that is called when the card is clicked.
|
|
927
|
+
*/
|
|
928
|
+
onClick?: (event: React.MouseEvent | React.KeyboardEvent) => void;
|
|
929
|
+
/**
|
|
930
|
+
* Ref to the card element.
|
|
931
|
+
*/
|
|
932
|
+
ref?: React.Ref<HTMLDivElement | HTMLAnchorElement>;
|
|
933
|
+
/**
|
|
934
|
+
* If true, the card can be selected. When the card is clicked, the onSelectionChange callback will be called with the new selected state of the card.
|
|
935
|
+
* If href is defined, the card won't be selectable, even if this prop is true.
|
|
936
|
+
*/
|
|
937
|
+
selectable?: boolean;
|
|
938
|
+
/**
|
|
939
|
+
* If true, the card is selected and if defined it will behave as a controlled component.
|
|
940
|
+
*/
|
|
941
|
+
selected?: boolean;
|
|
942
|
+
/**
|
|
943
|
+
* Defines the size of the card. Width and height can be set to "fillParent" or "fitContent".
|
|
944
|
+
* The default value is { width: "fitContent", height: "fitContent" }.
|
|
945
|
+
*/
|
|
946
|
+
size?: Size$3;
|
|
947
|
+
/**
|
|
948
|
+
* Specifies the tab index of the card.
|
|
949
|
+
* The default value is 0.
|
|
950
|
+
*/
|
|
951
|
+
tabIndex?: number;
|
|
821
952
|
};
|
|
822
953
|
|
|
823
|
-
declare const DxcCard: ({
|
|
954
|
+
declare const DxcCard: ({ children, defaultSelected, direction, emptySize, href, imagePosition, image, isEmpty, isLoading, loadingSize, mode, newWindow, onSelectionChange, onClick, ref, selectable, selected, size, tabIndex, }: Props$A) => react.JSX.Element;
|
|
824
955
|
|
|
825
|
-
|
|
956
|
+
/**
|
|
957
|
+
* Reference to the component.
|
|
958
|
+
*/
|
|
959
|
+
type RefType$a = HTMLDivElement;
|
|
960
|
+
type Props$z = {
|
|
826
961
|
/**
|
|
827
962
|
* Specifies a string to be used as the name for the checkbox element when no `label` is provided.
|
|
828
963
|
*/
|
|
@@ -872,6 +1007,10 @@ type Props$x = {
|
|
|
872
1007
|
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
873
1008
|
*/
|
|
874
1009
|
readOnly?: boolean;
|
|
1010
|
+
/**
|
|
1011
|
+
* ref to the checkbox container element.
|
|
1012
|
+
*/
|
|
1013
|
+
ref?: React.Ref<RefType$a>;
|
|
875
1014
|
/**
|
|
876
1015
|
* Size of the component.
|
|
877
1016
|
*/
|
|
@@ -887,45 +1026,89 @@ type Props$x = {
|
|
|
887
1026
|
value?: string;
|
|
888
1027
|
};
|
|
889
1028
|
|
|
890
|
-
declare const DxcCheckbox:
|
|
1029
|
+
declare const DxcCheckbox: {
|
|
1030
|
+
({ ariaLabel, checked, defaultChecked, disabled, label, labelPosition, margin, name, onChange, optional, readOnly, ref, size, tabIndex, value, }: Props$z): react.JSX.Element;
|
|
1031
|
+
displayName: string;
|
|
1032
|
+
};
|
|
891
1033
|
|
|
892
|
-
type
|
|
1034
|
+
type ChipAvatarType = {
|
|
1035
|
+
color: Props$H["color"];
|
|
1036
|
+
profileName?: Props$H["label"];
|
|
1037
|
+
imageSrc?: Props$H["imageSrc"];
|
|
1038
|
+
icon?: Props$H["icon"];
|
|
1039
|
+
};
|
|
1040
|
+
type CommonProps$7 = {
|
|
893
1041
|
/**
|
|
894
|
-
*
|
|
1042
|
+
* Function to be called when the chip is clicked or the dismiss action is triggered.
|
|
895
1043
|
*/
|
|
896
|
-
|
|
1044
|
+
onClick?: () => void;
|
|
1045
|
+
/**
|
|
1046
|
+
* Ref to the chip element.
|
|
1047
|
+
*/
|
|
1048
|
+
ref?: React.Ref<HTMLDivElement>;
|
|
897
1049
|
/**
|
|
898
|
-
*
|
|
1050
|
+
* Value of the tabindex attribute.
|
|
1051
|
+
*/
|
|
1052
|
+
tabIndex?: number;
|
|
1053
|
+
};
|
|
1054
|
+
type SelectableChipProps = CommonProps$7 & {
|
|
1055
|
+
/**
|
|
1056
|
+
* If true, the component will be disabled.
|
|
1057
|
+
*/
|
|
1058
|
+
disabled?: boolean;
|
|
1059
|
+
/**
|
|
1060
|
+
* The whole chip is an interactive element that allows users to activate or clear options directly within the interface.
|
|
1061
|
+
*/
|
|
1062
|
+
mode?: "selectable";
|
|
1063
|
+
/**
|
|
1064
|
+
* If true, the component will be selected. This property is only applicable when the mode is "selectable".
|
|
1065
|
+
* If undefined, the component manages its own internal state (uncontrolled mode).
|
|
1066
|
+
*/
|
|
1067
|
+
selected?: boolean;
|
|
1068
|
+
} & ({
|
|
1069
|
+
/**
|
|
1070
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
1071
|
+
*/
|
|
1072
|
+
prefix: ChipAvatarType;
|
|
1073
|
+
/**
|
|
1074
|
+
* Text to be placed on the chip. Required when using an avatar prefix.
|
|
899
1075
|
*/
|
|
900
|
-
|
|
1076
|
+
label: string;
|
|
1077
|
+
} | {
|
|
901
1078
|
/**
|
|
902
1079
|
* Element or path used as icon to be placed before the chip label.
|
|
903
1080
|
*/
|
|
904
|
-
|
|
1081
|
+
prefix: string | SVG;
|
|
905
1082
|
/**
|
|
906
|
-
*
|
|
1083
|
+
* Text to be placed on the chip. Optional when using an icon prefix.
|
|
907
1084
|
*/
|
|
908
|
-
|
|
1085
|
+
label?: string;
|
|
1086
|
+
} | {
|
|
1087
|
+
prefix?: undefined;
|
|
909
1088
|
/**
|
|
910
|
-
*
|
|
1089
|
+
* Text to be placed on the chip.
|
|
911
1090
|
*/
|
|
912
|
-
|
|
1091
|
+
label: string;
|
|
1092
|
+
});
|
|
1093
|
+
type DismissibleChipProps = CommonProps$7 & {
|
|
913
1094
|
/**
|
|
914
|
-
*
|
|
1095
|
+
* Dismissible chip is used to represent information generated by user input within an interface.
|
|
915
1096
|
*/
|
|
916
|
-
|
|
1097
|
+
mode: "dismissible";
|
|
917
1098
|
/**
|
|
918
|
-
*
|
|
919
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1099
|
+
* Text to be placed on the chip.
|
|
920
1100
|
*/
|
|
921
|
-
|
|
1101
|
+
label: string;
|
|
922
1102
|
/**
|
|
923
|
-
*
|
|
1103
|
+
* Element, path or avatar used as icon to be placed before the chip label.
|
|
924
1104
|
*/
|
|
925
|
-
|
|
1105
|
+
prefix?: string | SVG | ChipAvatarType;
|
|
1106
|
+
selected?: never;
|
|
1107
|
+
disabled?: never;
|
|
926
1108
|
};
|
|
1109
|
+
type Props$y = SelectableChipProps | DismissibleChipProps;
|
|
927
1110
|
|
|
928
|
-
declare const DxcChip: ({
|
|
1111
|
+
declare const DxcChip: ({ disabled, label, mode, onClick, prefix, selected, tabIndex, ref, }: Props$y) => react.JSX.Element | null;
|
|
929
1112
|
|
|
930
1113
|
type Space = {
|
|
931
1114
|
top?: string;
|
|
@@ -968,7 +1151,7 @@ type Overflow = OverflowValues | {
|
|
|
968
1151
|
x?: OverflowValues;
|
|
969
1152
|
y?: OverflowValues;
|
|
970
1153
|
};
|
|
971
|
-
type Props$
|
|
1154
|
+
type Props$x = {
|
|
972
1155
|
/**
|
|
973
1156
|
* Based on the CSS property background allows configuring all properties related to the background of a container.
|
|
974
1157
|
*
|
|
@@ -1001,6 +1184,10 @@ type Props$v = {
|
|
|
1001
1184
|
* Custom content inside the container.
|
|
1002
1185
|
*/
|
|
1003
1186
|
children?: ReactNode;
|
|
1187
|
+
/**
|
|
1188
|
+
* Reference to the container element.
|
|
1189
|
+
*/
|
|
1190
|
+
ref?: Ref<HTMLDivElement>;
|
|
1004
1191
|
/**
|
|
1005
1192
|
* Sets the display CSS property.
|
|
1006
1193
|
* The set of values is limited to the ones related to the outer display type.
|
|
@@ -1090,34 +1277,91 @@ type Props$v = {
|
|
|
1090
1277
|
zIndex?: "auto" | number;
|
|
1091
1278
|
};
|
|
1092
1279
|
|
|
1093
|
-
declare
|
|
1280
|
+
declare const DxcContainer: ({ display, width, height, overflow, ref, ...props }: Props$x) => react.JSX.Element;
|
|
1094
1281
|
|
|
1095
|
-
type
|
|
1096
|
-
|
|
1282
|
+
type Props$w = Omit<Props$K, "displayBorder" | "displayGroupLines" | "displayControlsAfter" | "hasPopOver">;
|
|
1283
|
+
|
|
1284
|
+
declare function DxcContextualMenu({ items }: Props$w): react.JSX.Element;
|
|
1285
|
+
|
|
1286
|
+
type Size$2 = "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
1287
|
+
type Option$2 = {
|
|
1288
|
+
/**
|
|
1289
|
+
* Option display value.
|
|
1290
|
+
*/
|
|
1291
|
+
label?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
1294
|
+
*/
|
|
1097
1295
|
icon?: string | SVG;
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
};
|
|
1107
|
-
type Section = {
|
|
1108
|
-
items: (Item | GroupItem)[];
|
|
1109
|
-
title?: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Option inner value.
|
|
1298
|
+
*/
|
|
1299
|
+
value: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* Whether the option has a divider below it.
|
|
1302
|
+
*/
|
|
1303
|
+
hasDivider?: boolean;
|
|
1110
1304
|
};
|
|
1111
|
-
type Props$
|
|
1305
|
+
type Props$v = {
|
|
1112
1306
|
/**
|
|
1113
|
-
*
|
|
1114
|
-
|
|
1307
|
+
* An array of objects representing the options.
|
|
1308
|
+
*/
|
|
1309
|
+
options: Option$2[];
|
|
1310
|
+
/**
|
|
1311
|
+
* In case options include icons, whether the icon should appear
|
|
1312
|
+
* after or before the label.
|
|
1313
|
+
*/
|
|
1314
|
+
optionsIconPosition?: "before" | "after";
|
|
1315
|
+
/**
|
|
1316
|
+
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
1317
|
+
*/
|
|
1318
|
+
icon?: string | SVG;
|
|
1319
|
+
/**
|
|
1320
|
+
* Whether the icon should appear after or before the label.
|
|
1321
|
+
*/
|
|
1322
|
+
iconPosition?: "before" | "after";
|
|
1323
|
+
/**
|
|
1324
|
+
* Text to be placed within the dropdown.
|
|
1325
|
+
*/
|
|
1326
|
+
label?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* Whether the arrow next to the label must be displayed or not.
|
|
1329
|
+
*/
|
|
1330
|
+
caretHidden?: boolean;
|
|
1331
|
+
/**
|
|
1332
|
+
* If true, the component will be disabled.
|
|
1333
|
+
*/
|
|
1334
|
+
disabled?: boolean;
|
|
1335
|
+
/**
|
|
1336
|
+
* If true, the options are shown when the dropdown is hover.
|
|
1337
|
+
*/
|
|
1338
|
+
expandOnHover?: boolean;
|
|
1339
|
+
/**
|
|
1340
|
+
* This function will be called every time the selection changes.
|
|
1341
|
+
* The value of the selected option will be passed as a parameter.
|
|
1342
|
+
*/
|
|
1343
|
+
onSelectOption: (value: string) => void;
|
|
1344
|
+
/**
|
|
1345
|
+
* Size of the margin to be applied to the component.
|
|
1346
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right'
|
|
1347
|
+
* properties in order to specify different margin sizes.
|
|
1348
|
+
*/
|
|
1349
|
+
margin?: Space$1 | Margin;
|
|
1350
|
+
/**
|
|
1351
|
+
* Size of the component.
|
|
1352
|
+
*/
|
|
1353
|
+
size?: Size$2;
|
|
1354
|
+
/**
|
|
1355
|
+
* Value of the tabindex attribute.
|
|
1356
|
+
*/
|
|
1357
|
+
tabIndex?: number;
|
|
1358
|
+
/**
|
|
1359
|
+
* Text representing advisory information related to the dropdown's trigger action.
|
|
1360
|
+
* Under the hood, this prop also serves as an accessible label for the component.
|
|
1115
1361
|
*/
|
|
1116
|
-
|
|
1362
|
+
title?: string;
|
|
1117
1363
|
};
|
|
1118
1364
|
|
|
1119
|
-
declare function DxcContextualMenu({ items }: Props$u): react_jsx_runtime.JSX.Element;
|
|
1120
|
-
|
|
1121
1365
|
type BaseActionCell = {
|
|
1122
1366
|
disabled?: boolean;
|
|
1123
1367
|
tabIndex?: number;
|
|
@@ -1141,7 +1385,7 @@ type ActionsCellPropsType = {
|
|
|
1141
1385
|
*/
|
|
1142
1386
|
actions: ActionCell[];
|
|
1143
1387
|
};
|
|
1144
|
-
type Props$
|
|
1388
|
+
type Props$u = {
|
|
1145
1389
|
/**
|
|
1146
1390
|
* The center section of the table. Can be used to render custom
|
|
1147
1391
|
* content in this area.
|
|
@@ -1375,14 +1619,15 @@ type BasicGridProps = {
|
|
|
1375
1619
|
*/
|
|
1376
1620
|
expandable?: false;
|
|
1377
1621
|
};
|
|
1378
|
-
type Props$
|
|
1622
|
+
type Props$t = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((BasicGridProps & SelectableGridProps) | (ExpandableRows & SelectableGridProps) | (HierarchyRows & SelectableGridProps));
|
|
1379
1623
|
|
|
1380
1624
|
declare const DxcDataGrid: {
|
|
1381
|
-
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$
|
|
1382
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
1625
|
+
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$t): JSX.Element;
|
|
1626
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => JSX.Element;
|
|
1383
1627
|
};
|
|
1384
1628
|
|
|
1385
|
-
type
|
|
1629
|
+
type RefType$9 = React.Ref<HTMLDivElement>;
|
|
1630
|
+
type Props$s = {
|
|
1386
1631
|
/**
|
|
1387
1632
|
* Initial value of the input element, only when it is uncontrolled.
|
|
1388
1633
|
*/
|
|
@@ -1486,11 +1731,18 @@ type Props$r = {
|
|
|
1486
1731
|
* Specifies a string to be used as the name for the date input element when no `label` is provided.
|
|
1487
1732
|
*/
|
|
1488
1733
|
ariaLabel?: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* Ref object to access the date input element.
|
|
1736
|
+
*/
|
|
1737
|
+
ref?: RefType$9;
|
|
1489
1738
|
};
|
|
1490
1739
|
|
|
1491
|
-
declare const DxcDateInput:
|
|
1740
|
+
declare const DxcDateInput: {
|
|
1741
|
+
({ label, name, defaultValue, value, format, helperText, placeholder, clearable, disabled, readOnly, optional, onChange, onBlur, error, autocomplete, margin, size, tabIndex, ariaLabel, ref, }: Props$s): react.JSX.Element;
|
|
1742
|
+
displayName: string;
|
|
1743
|
+
};
|
|
1492
1744
|
|
|
1493
|
-
type Props$
|
|
1745
|
+
type Props$r = {
|
|
1494
1746
|
/**
|
|
1495
1747
|
* If true, the close button will be visible.
|
|
1496
1748
|
*/
|
|
@@ -1530,9 +1782,9 @@ type Props$q = {
|
|
|
1530
1782
|
disableFocusLock?: boolean;
|
|
1531
1783
|
};
|
|
1532
1784
|
|
|
1533
|
-
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, disableFocusLock, }: Props$
|
|
1785
|
+
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, disableFocusLock, }: Props$r) => JSX.Element;
|
|
1534
1786
|
|
|
1535
|
-
type Props$
|
|
1787
|
+
type Props$q = {
|
|
1536
1788
|
/**
|
|
1537
1789
|
* The divider can be shown in horizontal or vertical.
|
|
1538
1790
|
*/
|
|
@@ -1553,10 +1805,14 @@ type Props$p = {
|
|
|
1553
1805
|
decorative?: boolean;
|
|
1554
1806
|
};
|
|
1555
1807
|
|
|
1556
|
-
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$
|
|
1808
|
+
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$q): react.JSX.Element;
|
|
1557
1809
|
|
|
1558
|
-
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$
|
|
1810
|
+
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$v) => react.JSX.Element;
|
|
1559
1811
|
|
|
1812
|
+
/**
|
|
1813
|
+
* Reference to the component.
|
|
1814
|
+
*/
|
|
1815
|
+
type RefType$8 = React.Ref<HTMLDivElement>;
|
|
1560
1816
|
type FileData = {
|
|
1561
1817
|
/**
|
|
1562
1818
|
* Error of the file. If it is defined, it will be shown and the file item will be mark as invalid.
|
|
@@ -1620,10 +1876,18 @@ type CommonProps$5 = {
|
|
|
1620
1876
|
* next to the label.
|
|
1621
1877
|
*/
|
|
1622
1878
|
optional?: boolean;
|
|
1879
|
+
/**
|
|
1880
|
+
* Reference to the component.
|
|
1881
|
+
*/
|
|
1882
|
+
ref?: RefType$8;
|
|
1623
1883
|
/**
|
|
1624
1884
|
* If true, if the file is an image, a preview of it will be shown. If not, an icon refering to the file type will be shown.
|
|
1625
1885
|
*/
|
|
1626
1886
|
showPreview?: boolean;
|
|
1887
|
+
/**
|
|
1888
|
+
* Size of the component.
|
|
1889
|
+
*/
|
|
1890
|
+
size?: "medium" | "fillParent";
|
|
1627
1891
|
/**
|
|
1628
1892
|
* Value of the tabindex attribute.
|
|
1629
1893
|
*/
|
|
@@ -1661,9 +1925,12 @@ type FileModeProps = CommonProps$5 & {
|
|
|
1661
1925
|
*/
|
|
1662
1926
|
mode?: "file";
|
|
1663
1927
|
};
|
|
1664
|
-
type Props$
|
|
1928
|
+
type Props$p = DropModeProps | FileModeProps;
|
|
1665
1929
|
|
|
1666
|
-
declare const DxcFileInput:
|
|
1930
|
+
declare const DxcFileInput: {
|
|
1931
|
+
({ mode, label, buttonLabel, dropAreaLabel, helperText, accept, minSize, maxSize, showPreview, multiple, disabled, callbackFile, size, value, margin, tabIndex, optional, ref, }: Props$p): react.JSX.Element;
|
|
1932
|
+
displayName: string;
|
|
1933
|
+
};
|
|
1667
1934
|
|
|
1668
1935
|
type Gap$1 = {
|
|
1669
1936
|
rowGap: string;
|
|
@@ -1698,7 +1965,7 @@ type CommonProps$4 = {
|
|
|
1698
1965
|
*/
|
|
1699
1966
|
alignSelf?: "auto" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
|
|
1700
1967
|
};
|
|
1701
|
-
type Props$
|
|
1968
|
+
type Props$o = CommonProps$4 & {
|
|
1702
1969
|
/**
|
|
1703
1970
|
* Sets the flex-direction CSS property.
|
|
1704
1971
|
*
|
|
@@ -1723,6 +1990,10 @@ type Props$n = CommonProps$4 & {
|
|
|
1723
1990
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/order
|
|
1724
1991
|
*/
|
|
1725
1992
|
order?: number;
|
|
1993
|
+
/**
|
|
1994
|
+
* If true, the flex container will take the full height of its parent.
|
|
1995
|
+
*/
|
|
1996
|
+
fullHeight?: boolean;
|
|
1726
1997
|
/**
|
|
1727
1998
|
* Sets the flex-grow CSS property.
|
|
1728
1999
|
*
|
|
@@ -1751,7 +2022,7 @@ type Props$n = CommonProps$4 & {
|
|
|
1751
2022
|
children: ReactNode;
|
|
1752
2023
|
};
|
|
1753
2024
|
|
|
1754
|
-
declare const DxcFlex: ({ basis, direction, gap, grow, order, shrink, wrap, ...props }: Props$
|
|
2025
|
+
declare const DxcFlex: ({ basis, direction, fullHeight, gap, grow, order, shrink, wrap, ...props }: Props$o) => react.JSX.Element;
|
|
1755
2026
|
|
|
1756
2027
|
type Gap = string | {
|
|
1757
2028
|
columnGap?: string;
|
|
@@ -1768,7 +2039,7 @@ type PlaceSelfValues = "auto" | "baseline" | "center" | "end" | "start" | "stret
|
|
|
1768
2039
|
type PlaceContentValues = "baseline" | "center" | "end" | "normal" | "space-around" | "space-between" | "space-evenly" | "start" | "stretch";
|
|
1769
2040
|
type PlaceItemsValues = "baseline" | "center" | "end" | "normal" | "start" | "stretch";
|
|
1770
2041
|
type PlaceObject<Type, Suffix extends string> = {
|
|
1771
|
-
[Property in keyof Type as `${
|
|
2042
|
+
[Property in Extract<keyof Type, string> as `${Property}${Capitalize<Suffix>}`]: Type[Property];
|
|
1772
2043
|
};
|
|
1773
2044
|
type PlaceGeneric<PlaceValues, Element extends string> = PlaceObject<{
|
|
1774
2045
|
align: PlaceValues;
|
|
@@ -1809,7 +2080,7 @@ type GridItemProps = {
|
|
|
1809
2080
|
*/
|
|
1810
2081
|
row?: number | string | GridCell;
|
|
1811
2082
|
};
|
|
1812
|
-
type Props$
|
|
2083
|
+
type Props$n = GridItemProps & {
|
|
1813
2084
|
/**
|
|
1814
2085
|
* Sets the grid-auto-columns CSS property.
|
|
1815
2086
|
*
|
|
@@ -1867,14 +2138,14 @@ type Props$m = GridItemProps & {
|
|
|
1867
2138
|
};
|
|
1868
2139
|
|
|
1869
2140
|
declare const DxcGrid: {
|
|
1870
|
-
(props: Props$
|
|
2141
|
+
(props: Props$n): react.JSX.Element;
|
|
1871
2142
|
Item: _emotion_styled.StyledComponent<{
|
|
1872
2143
|
theme?: _emotion_react.Theme;
|
|
1873
2144
|
as?: React.ElementType;
|
|
1874
2145
|
} & GridItemProps, react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
|
|
1875
2146
|
};
|
|
1876
2147
|
|
|
1877
|
-
type Props$
|
|
2148
|
+
type Props$m = {
|
|
1878
2149
|
/**
|
|
1879
2150
|
* Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
|
|
1880
2151
|
* The html tag of the heading will be the one specified in the 'as' prop.
|
|
@@ -1900,77 +2171,11 @@ type Props$l = {
|
|
|
1900
2171
|
margin?: Space$1 | Margin;
|
|
1901
2172
|
};
|
|
1902
2173
|
|
|
1903
|
-
declare function DxcHeading({ as, level, margin, text, weight }: Props$
|
|
1904
|
-
|
|
1905
|
-
type Props$k = {
|
|
1906
|
-
/**
|
|
1907
|
-
* Alternative text description displayed when the specified image is not loaded.
|
|
1908
|
-
*
|
|
1909
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
|
|
1910
|
-
* See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
|
|
1911
|
-
*/
|
|
1912
|
-
alt: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
|
|
1915
|
-
* which is required regardless of the presence of the caption or not.
|
|
1916
|
-
*/
|
|
1917
|
-
caption?: string;
|
|
1918
|
-
/**
|
|
1919
|
-
* Sets the rendered height of the image.
|
|
1920
|
-
*/
|
|
1921
|
-
height?: string;
|
|
1922
|
-
/**
|
|
1923
|
-
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
1924
|
-
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
1925
|
-
*/
|
|
1926
|
-
lazyLoading?: boolean;
|
|
1927
|
-
/**
|
|
1928
|
-
* Sets the object-fit CSS property.
|
|
1929
|
-
*
|
|
1930
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1931
|
-
*/
|
|
1932
|
-
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
1933
|
-
/**
|
|
1934
|
-
* Sets the object-position CSS property.
|
|
1935
|
-
*
|
|
1936
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
1937
|
-
*/
|
|
1938
|
-
objectPosition?: string;
|
|
1939
|
-
/**
|
|
1940
|
-
* This function will be called when the image fails to load.
|
|
1941
|
-
*/
|
|
1942
|
-
onError?: ReactEventHandler<HTMLImageElement>;
|
|
1943
|
-
/**
|
|
1944
|
-
* This function will be called when the image is loaded.
|
|
1945
|
-
*/
|
|
1946
|
-
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
1947
|
-
/**
|
|
1948
|
-
* One or more strings separated by commas, indicating a set of source sizes.
|
|
1949
|
-
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
1950
|
-
* then this attribute has no effect.
|
|
1951
|
-
*
|
|
1952
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
|
|
1953
|
-
*/
|
|
1954
|
-
sizes?: string;
|
|
1955
|
-
/**
|
|
1956
|
-
* URL of the image. This prop is required and must be valid.
|
|
1957
|
-
*/
|
|
1958
|
-
src: string;
|
|
1959
|
-
/**
|
|
1960
|
-
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
1961
|
-
*
|
|
1962
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
1963
|
-
*/
|
|
1964
|
-
srcSet?: string;
|
|
1965
|
-
/**
|
|
1966
|
-
* Sets the rendered width of the image.
|
|
1967
|
-
*/
|
|
1968
|
-
width?: string;
|
|
1969
|
-
};
|
|
2174
|
+
declare function DxcHeading({ as, level, margin, text, weight }: Props$m): react.JSX.Element;
|
|
1970
2175
|
|
|
1971
|
-
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$
|
|
2176
|
+
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$B): react.JSX.Element;
|
|
1972
2177
|
|
|
1973
|
-
type Props$
|
|
2178
|
+
type Props$l = {
|
|
1974
2179
|
/**
|
|
1975
2180
|
* Applies the spacing scale to the bottom side.
|
|
1976
2181
|
*/
|
|
@@ -2005,13 +2210,21 @@ type Props$j = {
|
|
|
2005
2210
|
vertical?: string;
|
|
2006
2211
|
};
|
|
2007
2212
|
|
|
2008
|
-
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$
|
|
2213
|
+
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$l): react.JSX.Element;
|
|
2009
2214
|
|
|
2010
2215
|
type LinkProps = {
|
|
2011
2216
|
/**
|
|
2012
|
-
*
|
|
2217
|
+
* Text of the link.
|
|
2218
|
+
*/
|
|
2219
|
+
children: string;
|
|
2220
|
+
/**
|
|
2221
|
+
* If true, the link will be disabled.
|
|
2013
2222
|
*/
|
|
2014
2223
|
disabled?: boolean;
|
|
2224
|
+
/**
|
|
2225
|
+
* Page to be opened when the user clicks on the link.
|
|
2226
|
+
*/
|
|
2227
|
+
href?: string;
|
|
2015
2228
|
/**
|
|
2016
2229
|
* If true, the color is inherited from parent.
|
|
2017
2230
|
*/
|
|
@@ -2025,9 +2238,10 @@ type LinkProps = {
|
|
|
2025
2238
|
*/
|
|
2026
2239
|
iconPosition?: "before" | "after";
|
|
2027
2240
|
/**
|
|
2028
|
-
*
|
|
2241
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2242
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2029
2243
|
*/
|
|
2030
|
-
|
|
2244
|
+
margin?: Space$1 | Margin;
|
|
2031
2245
|
/**
|
|
2032
2246
|
* If true, the page is opened in a new browser tab.
|
|
2033
2247
|
*/
|
|
@@ -2038,21 +2252,134 @@ type LinkProps = {
|
|
|
2038
2252
|
*/
|
|
2039
2253
|
onClick?: () => void;
|
|
2040
2254
|
/**
|
|
2041
|
-
*
|
|
2255
|
+
* Ref of the link element.
|
|
2042
2256
|
*/
|
|
2043
|
-
|
|
2257
|
+
ref?: React.Ref<HTMLAnchorElement>;
|
|
2044
2258
|
/**
|
|
2045
|
-
*
|
|
2046
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2259
|
+
* Value of the tabindex.
|
|
2047
2260
|
*/
|
|
2048
|
-
|
|
2261
|
+
tabIndex?: number;
|
|
2262
|
+
};
|
|
2263
|
+
|
|
2264
|
+
declare const DxcLink: {
|
|
2265
|
+
({ children, disabled, href, icon, iconPosition, inheritColor, margin, newWindow, onClick, tabIndex, ref, ...otherProps }: LinkProps): react.JSX.Element;
|
|
2266
|
+
displayName: string;
|
|
2267
|
+
};
|
|
2268
|
+
|
|
2269
|
+
type SelectOption = {
|
|
2270
|
+
label?: string;
|
|
2271
|
+
value: string;
|
|
2272
|
+
onSelect: (value: string) => void;
|
|
2273
|
+
selected?: boolean;
|
|
2274
|
+
};
|
|
2275
|
+
type Props$k = {
|
|
2049
2276
|
/**
|
|
2050
|
-
*
|
|
2277
|
+
* If true, the voice recording button will be shown.
|
|
2278
|
+
*/
|
|
2279
|
+
allowRecording?: boolean;
|
|
2280
|
+
/**
|
|
2281
|
+
* This function will be called when the selection of top items changes.
|
|
2282
|
+
* If this function is provided the message input will allow file selection.
|
|
2283
|
+
*/
|
|
2284
|
+
callbackFile?: (files: File[]) => void;
|
|
2285
|
+
/**
|
|
2286
|
+
* Initial value of the input, only when it is uncontrolled.
|
|
2287
|
+
*/
|
|
2288
|
+
defaultValue?: string;
|
|
2289
|
+
/**
|
|
2290
|
+
* If true, the component will be disabled.
|
|
2291
|
+
*/
|
|
2292
|
+
disabled?: boolean;
|
|
2293
|
+
/**
|
|
2294
|
+
* If it is a defined value and also a truthy string, the component will
|
|
2295
|
+
* change its appearance, showing the error below the input component. If
|
|
2296
|
+
* the defined value is an empty string, it will reserve a space below
|
|
2297
|
+
* the component for a future error, but it would not change its look. In
|
|
2298
|
+
* case of being undefined or null, both the appearance and the space for
|
|
2299
|
+
* the error message would not be modified.
|
|
2300
|
+
*/
|
|
2301
|
+
error?: string;
|
|
2302
|
+
/**
|
|
2303
|
+
* Items to be shown at the top.
|
|
2304
|
+
*/
|
|
2305
|
+
files?: File[];
|
|
2306
|
+
/**
|
|
2307
|
+
* If true, it indicates that a request is being processed after the user submits a query.
|
|
2308
|
+
*/
|
|
2309
|
+
isGenerating?: boolean;
|
|
2310
|
+
/**
|
|
2311
|
+
* Specifies the maximum length allowed by the input.
|
|
2312
|
+
* This will be checked both when the input element loses the
|
|
2313
|
+
* focus and while typing within it. If the string entered does not
|
|
2314
|
+
* comply the maximum length, the onBlur and onChange functions will be called
|
|
2315
|
+
* with the current value and an internal error informing that the value
|
|
2316
|
+
* length does not comply the specified range. If a valid length is
|
|
2317
|
+
* reached, the error parameter of both events will not be defined.
|
|
2318
|
+
*/
|
|
2319
|
+
maxLength?: number;
|
|
2320
|
+
/**
|
|
2321
|
+
* Specifies the minimum length allowed by the input.
|
|
2322
|
+
* This will be checked both when the input element loses the
|
|
2323
|
+
* focus and while typing within it. If the string entered does not
|
|
2324
|
+
* comply the minimum length, the onBlur and onChange functions will be called
|
|
2325
|
+
* with the current value and an internal error informing that the value
|
|
2326
|
+
* length does not comply the specified range. If a valid length is
|
|
2327
|
+
* reached, the error parameter of both events will not be defined.
|
|
2328
|
+
*/
|
|
2329
|
+
minLength?: number;
|
|
2330
|
+
/**
|
|
2331
|
+
* Options to be shown on the dropdown under the input.
|
|
2332
|
+
*/
|
|
2333
|
+
selectOptions?: SelectOption[];
|
|
2334
|
+
/**
|
|
2335
|
+
* This function will be called when the input element loses the focus.
|
|
2336
|
+
* An object including the input value and the error (if the value
|
|
2337
|
+
* entered is not valid) will be passed to this function. If there is no error,
|
|
2338
|
+
* error will not be defined.
|
|
2339
|
+
*/
|
|
2340
|
+
onBlur?: (val: {
|
|
2341
|
+
value: string;
|
|
2342
|
+
error?: string;
|
|
2343
|
+
}) => void;
|
|
2344
|
+
/**
|
|
2345
|
+
* This function will be called when the user types within the input
|
|
2346
|
+
* element of the component. An object including the current value and
|
|
2347
|
+
* the error (if the value entered is not valid) will be passed to this
|
|
2348
|
+
* function. If there is no error, error will not be defined.
|
|
2349
|
+
*/
|
|
2350
|
+
onChange?: (val: {
|
|
2351
|
+
value: string;
|
|
2352
|
+
error?: string;
|
|
2353
|
+
}) => void;
|
|
2354
|
+
/**
|
|
2355
|
+
* This function will be called when the user clicks on the button (submit or stop) or presses enter.
|
|
2356
|
+
* The type parameter indicates whether it's a "submit" or "stop" event. For submit events, "value", "files" and "selectedOption" are provided.
|
|
2357
|
+
*/
|
|
2358
|
+
onButtonClick?: (val: {
|
|
2359
|
+
type: "submit" | "stop";
|
|
2360
|
+
value?: string;
|
|
2361
|
+
files?: File[];
|
|
2362
|
+
selectedOption?: SelectOption;
|
|
2363
|
+
}) => void;
|
|
2364
|
+
/**
|
|
2365
|
+
* Text to be put as placeholder of the input.
|
|
2366
|
+
*/
|
|
2367
|
+
placeholder?: string;
|
|
2368
|
+
/**
|
|
2369
|
+
* Specifies the size of the component. The size will affect the width of the input.
|
|
2370
|
+
*/
|
|
2371
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
2372
|
+
/**
|
|
2373
|
+
* Value of the tabindex attribute.
|
|
2051
2374
|
*/
|
|
2052
2375
|
tabIndex?: number;
|
|
2376
|
+
/**
|
|
2377
|
+
* Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
2378
|
+
*/
|
|
2379
|
+
value?: string;
|
|
2053
2380
|
};
|
|
2054
2381
|
|
|
2055
|
-
declare const
|
|
2382
|
+
declare const DxcMessageInput: ({ allowRecording, callbackFile, defaultValue, disabled, error, files, isGenerating, maxLength, minLength, selectOptions, onBlur, onButtonClick, onChange, placeholder, size, tabIndex, value, }: Props$k) => react.JSX.Element;
|
|
2056
2383
|
|
|
2057
2384
|
type TabProps$1 = {
|
|
2058
2385
|
/**
|
|
@@ -2064,7 +2391,7 @@ type TabProps$1 = {
|
|
|
2064
2391
|
*/
|
|
2065
2392
|
children: string;
|
|
2066
2393
|
/**
|
|
2067
|
-
*
|
|
2394
|
+
* If true, the tab will be disabled.
|
|
2068
2395
|
*/
|
|
2069
2396
|
disabled?: boolean;
|
|
2070
2397
|
/**
|
|
@@ -2075,10 +2402,6 @@ type TabProps$1 = {
|
|
|
2075
2402
|
* Material Symbol name or SVG element used as the icon that will be displayed in the tab.
|
|
2076
2403
|
*/
|
|
2077
2404
|
icon?: string | SVG;
|
|
2078
|
-
/**
|
|
2079
|
-
* This function will be called when the user clicks on this tab.
|
|
2080
|
-
*/
|
|
2081
|
-
onClick?: () => void;
|
|
2082
2405
|
/**
|
|
2083
2406
|
* If the value is 'true', an empty badge will appear.
|
|
2084
2407
|
* If it is 'false', no badge will appear.
|
|
@@ -2087,8 +2410,16 @@ type TabProps$1 = {
|
|
|
2087
2410
|
* it will appear as '+99' in the badge.
|
|
2088
2411
|
*/
|
|
2089
2412
|
notificationNumber?: boolean | number;
|
|
2413
|
+
/**
|
|
2414
|
+
* This function will be called when the user clicks on this tab.
|
|
2415
|
+
*/
|
|
2416
|
+
onClick?: () => void;
|
|
2417
|
+
/**
|
|
2418
|
+
* Ref of the tab element.
|
|
2419
|
+
*/
|
|
2420
|
+
ref?: React.Ref<HTMLAnchorElement | HTMLDivElement>;
|
|
2090
2421
|
};
|
|
2091
|
-
type Props$
|
|
2422
|
+
type Props$j = {
|
|
2092
2423
|
/**
|
|
2093
2424
|
* Contains one or more DxcNavTabs.Tab.
|
|
2094
2425
|
*/
|
|
@@ -2104,11 +2435,18 @@ type Props$i = {
|
|
|
2104
2435
|
};
|
|
2105
2436
|
|
|
2106
2437
|
declare const DxcNavTabs: {
|
|
2107
|
-
({ iconPosition, tabIndex, children }: Props$
|
|
2108
|
-
Tab:
|
|
2438
|
+
({ iconPosition, tabIndex, children }: Props$j): JSX.Element;
|
|
2439
|
+
Tab: {
|
|
2440
|
+
({ active, children, disabled, href, icon, notificationNumber, onClick, ref, ...otherProps }: TabProps$1): JSX.Element;
|
|
2441
|
+
displayName: string;
|
|
2442
|
+
};
|
|
2109
2443
|
};
|
|
2110
2444
|
|
|
2111
|
-
|
|
2445
|
+
/**
|
|
2446
|
+
* Reference to the component.
|
|
2447
|
+
*/
|
|
2448
|
+
type RefType$7 = React.Ref<HTMLInputElement>;
|
|
2449
|
+
type Props$i = {
|
|
2112
2450
|
/**
|
|
2113
2451
|
* Text to be placed above the number.
|
|
2114
2452
|
*/
|
|
@@ -2144,6 +2482,10 @@ type Props$h = {
|
|
|
2144
2482
|
* functions when it has not been filled.
|
|
2145
2483
|
*/
|
|
2146
2484
|
optional?: boolean;
|
|
2485
|
+
/**
|
|
2486
|
+
* Prefix to be placed before the number value.
|
|
2487
|
+
*/
|
|
2488
|
+
prefix?: string;
|
|
2147
2489
|
/**
|
|
2148
2490
|
* If true, the component will not be mutable, meaning the user can
|
|
2149
2491
|
* not edit the control. The value won't change when pressing on the
|
|
@@ -2151,9 +2493,9 @@ type Props$h = {
|
|
|
2151
2493
|
*/
|
|
2152
2494
|
readOnly?: boolean;
|
|
2153
2495
|
/**
|
|
2154
|
-
*
|
|
2496
|
+
* Ref of the component.
|
|
2155
2497
|
*/
|
|
2156
|
-
|
|
2498
|
+
ref?: RefType$7;
|
|
2157
2499
|
/**
|
|
2158
2500
|
* Suffix to be placed after the number value.
|
|
2159
2501
|
*/
|
|
@@ -2235,9 +2577,12 @@ type Props$h = {
|
|
|
2235
2577
|
showControls?: boolean;
|
|
2236
2578
|
};
|
|
2237
2579
|
|
|
2238
|
-
declare const DxcNumberInput:
|
|
2580
|
+
declare const DxcNumberInput: {
|
|
2581
|
+
({ ariaLabel, autocomplete, defaultValue, disabled, error, helperText, label, margin, max, min, name, onBlur, onChange, optional, placeholder, prefix, readOnly, ref, showControls, size, step, suffix, tabIndex, value, }: Props$i): react.JSX.Element;
|
|
2582
|
+
displayName: string;
|
|
2583
|
+
};
|
|
2239
2584
|
|
|
2240
|
-
type Props$
|
|
2585
|
+
type Props$h = {
|
|
2241
2586
|
/**
|
|
2242
2587
|
* Number of the current selected page.
|
|
2243
2588
|
*/
|
|
@@ -2275,53 +2620,30 @@ type Props$g = {
|
|
|
2275
2620
|
tabIndex?: number;
|
|
2276
2621
|
};
|
|
2277
2622
|
|
|
2278
|
-
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$
|
|
2623
|
+
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$h) => JSX.Element;
|
|
2279
2624
|
|
|
2280
2625
|
declare function DxcParagraph({ children }: {
|
|
2281
2626
|
children: ReactNode;
|
|
2282
|
-
}):
|
|
2627
|
+
}): react.JSX.Element;
|
|
2283
2628
|
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
/**
|
|
2290
|
-
* Name attribute of the input element.
|
|
2291
|
-
*/
|
|
2292
|
-
name?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Reference to the component.
|
|
2631
|
+
*/
|
|
2632
|
+
type RefType$6 = React.Ref<HTMLDivElement>;
|
|
2633
|
+
type Props$g = {
|
|
2293
2634
|
/**
|
|
2294
|
-
*
|
|
2635
|
+
* Specifies a string to be used as the name for the password input element when no `label` is provided.
|
|
2295
2636
|
*/
|
|
2296
|
-
|
|
2637
|
+
ariaLabel?: string;
|
|
2297
2638
|
/**
|
|
2298
|
-
*
|
|
2639
|
+
* HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value.
|
|
2640
|
+
* Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
|
|
2299
2641
|
*/
|
|
2300
|
-
|
|
2642
|
+
autocomplete?: string;
|
|
2301
2643
|
/**
|
|
2302
2644
|
* If true, the password input will have an action to clear the entered value.
|
|
2303
2645
|
*/
|
|
2304
2646
|
clearable?: boolean;
|
|
2305
|
-
/**
|
|
2306
|
-
* This function will be called when the user types within the input
|
|
2307
|
-
* element of the component. An object including the current value and
|
|
2308
|
-
* the error (if the value entered is not valid) will be passed to this
|
|
2309
|
-
* function. If there is no error, error will not be defined.
|
|
2310
|
-
* */
|
|
2311
|
-
onChange?: (val: {
|
|
2312
|
-
value: string;
|
|
2313
|
-
error?: string;
|
|
2314
|
-
}) => void;
|
|
2315
|
-
/**
|
|
2316
|
-
* This function will be called when the input element loses the focus.
|
|
2317
|
-
* An object including the input value and the error (if the value entered is
|
|
2318
|
-
* not valid) will be passed to this function. If there is no error, error will
|
|
2319
|
-
* not be defined.
|
|
2320
|
-
*/
|
|
2321
|
-
onBlur?: (val: {
|
|
2322
|
-
value: string;
|
|
2323
|
-
error?: string;
|
|
2324
|
-
}) => void;
|
|
2325
2647
|
/**
|
|
2326
2648
|
* If it is a defined value and also a truthy string, the component will
|
|
2327
2649
|
* change its appearance, showing the error below the password input
|
|
@@ -2332,45 +2654,76 @@ type Props$f = {
|
|
|
2332
2654
|
*/
|
|
2333
2655
|
error?: string;
|
|
2334
2656
|
/**
|
|
2335
|
-
*
|
|
2336
|
-
* password input. This will be checked both when the input element loses the
|
|
2337
|
-
* focus and while typing within it. If the string entered does not match
|
|
2338
|
-
* the pattern, the onBlur and onChange functions will be called with the
|
|
2339
|
-
* current value and an internal error informing that this value does not
|
|
2340
|
-
* match the pattern. If the pattern is met, the error parameter of both
|
|
2341
|
-
* events will not be defined.
|
|
2657
|
+
* Helper text to be placed above the password.
|
|
2342
2658
|
*/
|
|
2343
|
-
|
|
2659
|
+
helperText?: string;
|
|
2344
2660
|
/**
|
|
2345
|
-
*
|
|
2661
|
+
* Text to be placed above the password input.
|
|
2662
|
+
*/
|
|
2663
|
+
label?: string;
|
|
2664
|
+
/**
|
|
2665
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2666
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2667
|
+
*/
|
|
2668
|
+
margin?: Space$1 | Margin;
|
|
2669
|
+
/**
|
|
2670
|
+
* Specifies the maximum length allowed by the password input.
|
|
2346
2671
|
* This will be checked both when the input element loses the
|
|
2347
2672
|
* focus and while typing within it. If the string entered does not
|
|
2348
|
-
* comply the
|
|
2673
|
+
* comply the maximum length, the onBlur and onChange functions will be called
|
|
2349
2674
|
* with the current value and an internal error informing that the value
|
|
2350
2675
|
* length does not comply the specified range. If a valid length is
|
|
2351
2676
|
* reached, the error parameter of both events will not be defined.
|
|
2352
2677
|
*/
|
|
2353
|
-
|
|
2678
|
+
maxLength?: number;
|
|
2354
2679
|
/**
|
|
2355
|
-
* Specifies the
|
|
2680
|
+
* Specifies the minimum length allowed by the password input.
|
|
2356
2681
|
* This will be checked both when the input element loses the
|
|
2357
2682
|
* focus and while typing within it. If the string entered does not
|
|
2358
|
-
* comply the
|
|
2683
|
+
* comply the minimum length, the onBlur and onChange functions will be called
|
|
2359
2684
|
* with the current value and an internal error informing that the value
|
|
2360
2685
|
* length does not comply the specified range. If a valid length is
|
|
2361
2686
|
* reached, the error parameter of both events will not be defined.
|
|
2362
2687
|
*/
|
|
2363
|
-
|
|
2688
|
+
minLength?: number;
|
|
2689
|
+
/**
|
|
2690
|
+
* Name attribute of the input element.
|
|
2691
|
+
*/
|
|
2692
|
+
name?: string;
|
|
2693
|
+
/**
|
|
2694
|
+
* This function will be called when the input element loses the focus.
|
|
2695
|
+
* An object including the input value and the error (if the value entered is
|
|
2696
|
+
* not valid) will be passed to this function. If there is no error, error will
|
|
2697
|
+
* not be defined.
|
|
2698
|
+
*/
|
|
2699
|
+
onBlur?: (val: {
|
|
2700
|
+
value: string;
|
|
2701
|
+
error?: string;
|
|
2702
|
+
}) => void;
|
|
2364
2703
|
/**
|
|
2365
|
-
*
|
|
2366
|
-
*
|
|
2704
|
+
* This function will be called when the user types within the input
|
|
2705
|
+
* element of the component. An object including the current value and
|
|
2706
|
+
* the error (if the value entered is not valid) will be passed to this
|
|
2707
|
+
* function. If there is no error, error will not be defined.
|
|
2708
|
+
* */
|
|
2709
|
+
onChange?: (val: {
|
|
2710
|
+
value: string;
|
|
2711
|
+
error?: string;
|
|
2712
|
+
}) => void;
|
|
2713
|
+
/**
|
|
2714
|
+
* Regular expression that defines the valid format allowed by the
|
|
2715
|
+
* password input. This will be checked both when the input element loses the
|
|
2716
|
+
* focus and while typing within it. If the string entered does not match
|
|
2717
|
+
* the pattern, the onBlur and onChange functions will be called with the
|
|
2718
|
+
* current value and an internal error informing that this value does not
|
|
2719
|
+
* match the pattern. If the pattern is met, the error parameter of both
|
|
2720
|
+
* events will not be defined.
|
|
2367
2721
|
*/
|
|
2368
|
-
|
|
2722
|
+
pattern?: string;
|
|
2369
2723
|
/**
|
|
2370
|
-
*
|
|
2371
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2724
|
+
* Reference to the input element.
|
|
2372
2725
|
*/
|
|
2373
|
-
|
|
2726
|
+
ref?: RefType$6;
|
|
2374
2727
|
/**
|
|
2375
2728
|
* Size of the component.
|
|
2376
2729
|
*/
|
|
@@ -2380,12 +2733,49 @@ type Props$f = {
|
|
|
2380
2733
|
*/
|
|
2381
2734
|
tabIndex?: number;
|
|
2382
2735
|
/**
|
|
2383
|
-
*
|
|
2736
|
+
* Value of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
2384
2737
|
*/
|
|
2385
|
-
|
|
2738
|
+
value?: string;
|
|
2739
|
+
};
|
|
2740
|
+
|
|
2741
|
+
declare const DxcPasswordInput: {
|
|
2742
|
+
({ label, name, value, helperText, clearable, onChange, onBlur, error, pattern, minLength, maxLength, autocomplete, margin, size, tabIndex, ariaLabel, ref, }: Props$g): react.JSX.Element;
|
|
2743
|
+
displayName: string;
|
|
2744
|
+
};
|
|
2745
|
+
|
|
2746
|
+
type PopoverPropsType = {
|
|
2747
|
+
/** Action that triggers the popover to open. */
|
|
2748
|
+
actionToOpen?: "click" | "hover";
|
|
2749
|
+
/** Alignment of the popover relative to the trigger element. */
|
|
2750
|
+
align?: "start" | "center" | "end";
|
|
2751
|
+
/** Set to true if child controls the events. It will render the child directly without wrapping it. */
|
|
2752
|
+
asChild?: boolean;
|
|
2753
|
+
/** Element that triggers the popover and works as the anchor. */
|
|
2754
|
+
children: React.ReactNode;
|
|
2755
|
+
/** Whether the popover should display a tip (arrow). */
|
|
2756
|
+
hasTip?: boolean;
|
|
2757
|
+
/** Controlled open state of the popover. If it is left undefined, it will be uncontrolled. */
|
|
2758
|
+
isOpen?: boolean;
|
|
2759
|
+
/** Distance in pixels from the trigger element to the popover. */
|
|
2760
|
+
offset?: number;
|
|
2761
|
+
/** Callback function when the popover is opened.
|
|
2762
|
+
* Used only in controlled mode and if the trigger lacks the events to manage the controlled behavior. */
|
|
2763
|
+
onOpen?: () => void;
|
|
2764
|
+
/** Callback function when the popover is opened and the focus is set to the first focusable element inside the popover.
|
|
2765
|
+
* */
|
|
2766
|
+
onOpenAutoFocus?: (event: Event) => void;
|
|
2767
|
+
/** Callback function when the popover is closed. */
|
|
2768
|
+
onClose?: () => void;
|
|
2769
|
+
/** Callback function when the popover is closed and the focus is set back to the trigger element.
|
|
2770
|
+
* */
|
|
2771
|
+
onCloseAutoFocus?: (event: Event) => void;
|
|
2772
|
+
/** Content to be displayed inside the popover. */
|
|
2773
|
+
popoverContent: React.ReactNode;
|
|
2774
|
+
/** Side of the trigger where the popover will appear. */
|
|
2775
|
+
side?: "top" | "bottom" | "left" | "right";
|
|
2386
2776
|
};
|
|
2387
2777
|
|
|
2388
|
-
declare const
|
|
2778
|
+
declare const DxcPopover: ({ actionToOpen, align, asChild, children, hasTip, isOpen, offset, onOpen, onOpenAutoFocus, onClose, onCloseAutoFocus, popoverContent, side, }: PopoverPropsType) => JSX.Element;
|
|
2389
2779
|
|
|
2390
2780
|
type Size$1 = {
|
|
2391
2781
|
top?: Space$1;
|
|
@@ -2393,7 +2783,7 @@ type Size$1 = {
|
|
|
2393
2783
|
left?: Space$1;
|
|
2394
2784
|
right?: Space$1;
|
|
2395
2785
|
};
|
|
2396
|
-
type Props$
|
|
2786
|
+
type Props$f = {
|
|
2397
2787
|
/**
|
|
2398
2788
|
* Text to be placed above the progress bar.
|
|
2399
2789
|
*/
|
|
@@ -2427,7 +2817,7 @@ type Props$e = {
|
|
|
2427
2817
|
ariaLabel?: string;
|
|
2428
2818
|
};
|
|
2429
2819
|
|
|
2430
|
-
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$
|
|
2820
|
+
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$f) => JSX.Element;
|
|
2431
2821
|
|
|
2432
2822
|
type Link = {
|
|
2433
2823
|
/**
|
|
@@ -2439,7 +2829,7 @@ type Link = {
|
|
|
2439
2829
|
*/
|
|
2440
2830
|
links?: Link[];
|
|
2441
2831
|
};
|
|
2442
|
-
type Props$
|
|
2832
|
+
type Props$e = {
|
|
2443
2833
|
/**
|
|
2444
2834
|
* Title of the quick nav component.
|
|
2445
2835
|
*/
|
|
@@ -2450,8 +2840,12 @@ type Props$d = {
|
|
|
2450
2840
|
links: Link[];
|
|
2451
2841
|
};
|
|
2452
2842
|
|
|
2453
|
-
declare function DxcQuickNav({ links, title }: Props$
|
|
2843
|
+
declare function DxcQuickNav({ links, title }: Props$e): react.JSX.Element;
|
|
2454
2844
|
|
|
2845
|
+
/**
|
|
2846
|
+
* Reference to the component.
|
|
2847
|
+
*/
|
|
2848
|
+
type RefType$5 = React.Ref<HTMLDivElement>;
|
|
2455
2849
|
type Option$1 = {
|
|
2456
2850
|
/**
|
|
2457
2851
|
* Label of the option placed next to the radio input.
|
|
@@ -2537,6 +2931,10 @@ type RadioGroupProps = {
|
|
|
2537
2931
|
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
2538
2932
|
*/
|
|
2539
2933
|
readOnly?: boolean;
|
|
2934
|
+
/**
|
|
2935
|
+
* Reference to the component.
|
|
2936
|
+
*/
|
|
2937
|
+
ref?: RefType$5;
|
|
2540
2938
|
/**
|
|
2541
2939
|
* Sets the orientation of the options within the radio group.
|
|
2542
2940
|
*/
|
|
@@ -2553,7 +2951,10 @@ type RadioGroupProps = {
|
|
|
2553
2951
|
value?: string;
|
|
2554
2952
|
};
|
|
2555
2953
|
|
|
2556
|
-
declare const DxcRadioGroup:
|
|
2954
|
+
declare const DxcRadioGroup: {
|
|
2955
|
+
({ ariaLabel, defaultValue, disabled, error, helperText, label, name, onBlur, onChange, optional, optionalItemLabel, options, readOnly, ref, stacking, tabIndex, value, }: RadioGroupProps): react.JSX.Element;
|
|
2956
|
+
displayName: string;
|
|
2957
|
+
};
|
|
2557
2958
|
|
|
2558
2959
|
type Column = {
|
|
2559
2960
|
/**
|
|
@@ -2651,13 +3052,17 @@ type NonPaginatedProps = CommonProps$3 & {
|
|
|
2651
3052
|
*/
|
|
2652
3053
|
showGoToPage?: never;
|
|
2653
3054
|
};
|
|
2654
|
-
type Props$
|
|
3055
|
+
type Props$d = PaginatedProps | NonPaginatedProps;
|
|
2655
3056
|
|
|
2656
3057
|
declare const DxcResultsetTable: {
|
|
2657
|
-
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$
|
|
2658
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
3058
|
+
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, virtualizedHeight, }: Props$d): react.JSX.Element;
|
|
3059
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react.JSX.Element;
|
|
2659
3060
|
};
|
|
2660
3061
|
|
|
3062
|
+
/**
|
|
3063
|
+
* Reference to the select component.
|
|
3064
|
+
*/
|
|
3065
|
+
type RefType$4 = React.Ref<HTMLDivElement>;
|
|
2661
3066
|
type ListOptionType = {
|
|
2662
3067
|
/**
|
|
2663
3068
|
* Element used as the icon that will be placed before the option label.
|
|
@@ -2742,10 +3147,20 @@ type CommonProps$2 = {
|
|
|
2742
3147
|
* Text to be put as placeholder of the select.
|
|
2743
3148
|
*/
|
|
2744
3149
|
placeholder?: string;
|
|
3150
|
+
/**
|
|
3151
|
+
* Reference to the select component.
|
|
3152
|
+
*/
|
|
3153
|
+
ref?: RefType$4;
|
|
2745
3154
|
/**
|
|
2746
3155
|
* If true, enables search functionality.
|
|
2747
3156
|
*/
|
|
2748
3157
|
searchable?: boolean;
|
|
3158
|
+
/**
|
|
3159
|
+
* Defines the search mode when searchable is true.
|
|
3160
|
+
* If true, matches options that start with the search text.
|
|
3161
|
+
* If false, matches options that contain the search text anywhere in their label.
|
|
3162
|
+
*/
|
|
3163
|
+
searchByStartsWith?: boolean;
|
|
2749
3164
|
/**
|
|
2750
3165
|
* Size of the component.
|
|
2751
3166
|
*/
|
|
@@ -2840,11 +3255,18 @@ type MultipleSelect = CommonProps$2 & {
|
|
|
2840
3255
|
*/
|
|
2841
3256
|
value?: string[];
|
|
2842
3257
|
};
|
|
2843
|
-
type Props$
|
|
3258
|
+
type Props$c = SingleSelect | MultipleSelect;
|
|
2844
3259
|
|
|
2845
|
-
declare const DxcSelect:
|
|
3260
|
+
declare const DxcSelect: {
|
|
3261
|
+
({ ariaLabel, defaultValue, disabled, enableSelectAll, error, helperText, label, margin, multiple, name, onBlur, onChange, optional, options, placeholder, ref, searchable, searchByStartsWith, size, tabIndex, value, virtualizedHeight, }: Props$c): react.JSX.Element;
|
|
3262
|
+
displayName: string;
|
|
3263
|
+
};
|
|
2846
3264
|
|
|
2847
|
-
|
|
3265
|
+
/**
|
|
3266
|
+
* Reference to the component.
|
|
3267
|
+
*/
|
|
3268
|
+
type RefType$3 = React.Ref<HTMLDivElement>;
|
|
3269
|
+
type Props$b = {
|
|
2848
3270
|
/**
|
|
2849
3271
|
* Specifies a string to be used as the name for the slider element when no `label` is provided.
|
|
2850
3272
|
*/
|
|
@@ -2901,6 +3323,10 @@ type Props$a = {
|
|
|
2901
3323
|
* The new value will be passed as a parameter when this function is executed.
|
|
2902
3324
|
*/
|
|
2903
3325
|
onDragEnd?: (value: number) => void;
|
|
3326
|
+
/**
|
|
3327
|
+
* Reference to the component.
|
|
3328
|
+
*/
|
|
3329
|
+
ref?: RefType$3;
|
|
2904
3330
|
/**
|
|
2905
3331
|
* Whether the input element for displaying/controlling the slider value should be displayed next to the slider.
|
|
2906
3332
|
*/
|
|
@@ -2923,9 +3349,12 @@ type Props$a = {
|
|
|
2923
3349
|
value?: number;
|
|
2924
3350
|
};
|
|
2925
3351
|
|
|
2926
|
-
declare const DxcSlider:
|
|
3352
|
+
declare const DxcSlider: {
|
|
3353
|
+
({ ariaLabel, defaultValue, disabled, helperText, label, labelFormatCallback, margin, marks, maxValue, minValue, name, onChange, onDragEnd, ref, showLimitsValues, showInput, size, step, value, }: Props$b): react.JSX.Element;
|
|
3354
|
+
displayName: string;
|
|
3355
|
+
};
|
|
2927
3356
|
|
|
2928
|
-
type Props$
|
|
3357
|
+
type Props$a = {
|
|
2929
3358
|
/**
|
|
2930
3359
|
* Specifies a string to be used as the name for the spinner element when no `label` is provided or the `mode` is set to small.
|
|
2931
3360
|
*/
|
|
@@ -2959,11 +3388,11 @@ type Props$9 = {
|
|
|
2959
3388
|
value?: number;
|
|
2960
3389
|
};
|
|
2961
3390
|
|
|
2962
|
-
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$
|
|
3391
|
+
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$a) => react.JSX.Element;
|
|
2963
3392
|
|
|
2964
3393
|
type Mode = "default" | "info" | "success" | "warning" | "error";
|
|
2965
3394
|
type Size = "small" | "medium" | "large";
|
|
2966
|
-
type Props$
|
|
3395
|
+
type Props$9 = {
|
|
2967
3396
|
/**
|
|
2968
3397
|
* It will define the color of the light based on its semantic meaning.
|
|
2969
3398
|
*/
|
|
@@ -2978,9 +3407,13 @@ type Props$8 = {
|
|
|
2978
3407
|
size?: Size;
|
|
2979
3408
|
};
|
|
2980
3409
|
|
|
2981
|
-
declare function DxcStatusLight({ label, mode, size }: Props$
|
|
3410
|
+
declare function DxcStatusLight({ label, mode, size }: Props$9): react.JSX.Element;
|
|
2982
3411
|
|
|
2983
|
-
|
|
3412
|
+
/**
|
|
3413
|
+
* Reference to the component.
|
|
3414
|
+
*/
|
|
3415
|
+
type RefType$2 = React.Ref<HTMLDivElement>;
|
|
3416
|
+
type Props$8 = {
|
|
2984
3417
|
/**
|
|
2985
3418
|
* Specifies a string to be used as the name for the switch element when no `label` is provided.
|
|
2986
3419
|
*/
|
|
@@ -3024,6 +3457,10 @@ type Props$7 = {
|
|
|
3024
3457
|
* If true, the component will display '(Optional)' next to the label.
|
|
3025
3458
|
*/
|
|
3026
3459
|
optional?: boolean;
|
|
3460
|
+
/**
|
|
3461
|
+
* Reference to the component.
|
|
3462
|
+
*/
|
|
3463
|
+
ref?: RefType$2;
|
|
3027
3464
|
/**
|
|
3028
3465
|
* Size of the component.
|
|
3029
3466
|
*/
|
|
@@ -3039,11 +3476,14 @@ type Props$7 = {
|
|
|
3039
3476
|
value?: string;
|
|
3040
3477
|
};
|
|
3041
3478
|
|
|
3042
|
-
declare const DxcSwitch:
|
|
3479
|
+
declare const DxcSwitch: {
|
|
3480
|
+
({ ariaLabel, checked, defaultChecked, disabled, label, labelPosition, margin, name, onChange, optional, ref, size, tabIndex, value, }: Props$8): react.JSX.Element;
|
|
3481
|
+
displayName: string;
|
|
3482
|
+
};
|
|
3043
3483
|
|
|
3044
3484
|
declare const DxcTable: {
|
|
3045
|
-
({ children, margin, mode }: Props$
|
|
3046
|
-
ActionsCell: ({ actions }: ActionsCellPropsType) =>
|
|
3485
|
+
({ children, margin, mode }: Props$u): react.JSX.Element;
|
|
3486
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react.JSX.Element;
|
|
3047
3487
|
};
|
|
3048
3488
|
|
|
3049
3489
|
type CommonTabProps = {
|
|
@@ -3055,6 +3495,7 @@ type CommonTabProps = {
|
|
|
3055
3495
|
children: ReactNode;
|
|
3056
3496
|
onClick?: () => void;
|
|
3057
3497
|
onHover?: () => void;
|
|
3498
|
+
ref?: React.Ref<HTMLButtonElement>;
|
|
3058
3499
|
};
|
|
3059
3500
|
type TabProps = (CommonTabProps & {
|
|
3060
3501
|
tabId: string;
|
|
@@ -3084,14 +3525,21 @@ type TabsProps = {
|
|
|
3084
3525
|
*/
|
|
3085
3526
|
children?: ReactNode;
|
|
3086
3527
|
};
|
|
3087
|
-
type Props$
|
|
3528
|
+
type Props$7 = TabsProps;
|
|
3088
3529
|
|
|
3089
3530
|
declare const DxcTabs: {
|
|
3090
|
-
({ children, iconPosition, margin, tabIndex }: Props$
|
|
3091
|
-
Tab:
|
|
3531
|
+
({ children, iconPosition, margin, tabIndex }: Props$7): react.JSX.Element;
|
|
3532
|
+
Tab: {
|
|
3533
|
+
({ active, disabled, icon, label, notificationNumber, onClick, onHover, ref, title, tabId, }: TabProps): react.JSX.Element;
|
|
3534
|
+
displayName: string;
|
|
3535
|
+
};
|
|
3092
3536
|
};
|
|
3093
3537
|
|
|
3094
|
-
|
|
3538
|
+
/**
|
|
3539
|
+
* Reference to the component.
|
|
3540
|
+
*/
|
|
3541
|
+
type RefType$1 = React.Ref<HTMLDivElement>;
|
|
3542
|
+
type Props$6 = {
|
|
3095
3543
|
/**
|
|
3096
3544
|
* Specifies a string to be used as the name for the textarea element when no `label` is provided.
|
|
3097
3545
|
*/
|
|
@@ -3200,6 +3648,10 @@ type Props$5 = {
|
|
|
3200
3648
|
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3201
3649
|
*/
|
|
3202
3650
|
readOnly?: boolean;
|
|
3651
|
+
/**
|
|
3652
|
+
* Reference to the container element of the textarea component.
|
|
3653
|
+
*/
|
|
3654
|
+
ref?: RefType$1;
|
|
3203
3655
|
/**
|
|
3204
3656
|
* Number of rows of the textarea.
|
|
3205
3657
|
*/
|
|
@@ -3225,7 +3677,10 @@ type Props$5 = {
|
|
|
3225
3677
|
verticalGrow?: "auto" | "manual" | "none";
|
|
3226
3678
|
};
|
|
3227
3679
|
|
|
3228
|
-
declare const DxcTextarea:
|
|
3680
|
+
declare const DxcTextarea: {
|
|
3681
|
+
({ ariaLabel, autocomplete, defaultValue, disabled, error, helperText, label, margin, maxLength, minLength, name, onBlur, onChange, optional, pattern, placeholder, readOnly, ref, rows, size, tabIndex, value, verticalGrow, }: Props$6): react.JSX.Element;
|
|
3682
|
+
displayName: string;
|
|
3683
|
+
};
|
|
3229
3684
|
|
|
3230
3685
|
type Action$1 = {
|
|
3231
3686
|
/**
|
|
@@ -3243,7 +3698,7 @@ type Action$1 = {
|
|
|
3243
3698
|
*/
|
|
3244
3699
|
title?: string;
|
|
3245
3700
|
};
|
|
3246
|
-
type Props$
|
|
3701
|
+
type Props$5 = {
|
|
3247
3702
|
/**
|
|
3248
3703
|
* Sets the alignment inside the input.
|
|
3249
3704
|
*/
|
|
@@ -3290,6 +3745,10 @@ type Props$4 = {
|
|
|
3290
3745
|
* and the custom action will not execute its onClick event.
|
|
3291
3746
|
*/
|
|
3292
3747
|
readOnly?: boolean;
|
|
3748
|
+
/**
|
|
3749
|
+
* Ref to the input element.
|
|
3750
|
+
*/
|
|
3751
|
+
ref?: React.Ref<HTMLInputElement>;
|
|
3293
3752
|
/**
|
|
3294
3753
|
* If true, the input will be optional, showing '(Optional)'
|
|
3295
3754
|
* next to the label. Otherwise, the field will be considered required and an error will be
|
|
@@ -3396,7 +3855,107 @@ type Props$4 = {
|
|
|
3396
3855
|
ariaLabel?: string;
|
|
3397
3856
|
};
|
|
3398
3857
|
|
|
3399
|
-
declare const DxcTextInput:
|
|
3858
|
+
declare const DxcTextInput: {
|
|
3859
|
+
({ alignment, action, ariaLabel, autocomplete, clearable, defaultValue, disabled, error, helperText, label, margin, maxLength, minLength, name, optional, placeholder, prefix, readOnly, suffix, onBlur, onChange, pattern, ref, size, suggestions, tabIndex, value, }: Props$5): JSX.Element;
|
|
3860
|
+
displayName: string;
|
|
3861
|
+
};
|
|
3862
|
+
|
|
3863
|
+
/**
|
|
3864
|
+
* Reference to the component.
|
|
3865
|
+
*/
|
|
3866
|
+
type RefType = React.Ref<HTMLDivElement>;
|
|
3867
|
+
type Props$4 = {
|
|
3868
|
+
/**
|
|
3869
|
+
* Specifies a string to be used as the name for the timeInput element when no `label` is provided.
|
|
3870
|
+
*/
|
|
3871
|
+
ariaLabel?: string;
|
|
3872
|
+
/**
|
|
3873
|
+
* If true, the input will have an action to clear the entered value.
|
|
3874
|
+
*/
|
|
3875
|
+
clearable?: boolean;
|
|
3876
|
+
/**
|
|
3877
|
+
* Initial value of the input, only when it is uncontrolled.
|
|
3878
|
+
*/
|
|
3879
|
+
defaultValue?: string;
|
|
3880
|
+
/**
|
|
3881
|
+
* If true, the component will be disabled.
|
|
3882
|
+
*/
|
|
3883
|
+
disabled?: boolean;
|
|
3884
|
+
/**
|
|
3885
|
+
* If it is a defined value and also a truthy string, the component will
|
|
3886
|
+
* change its appearance, showing the error below the input component. If
|
|
3887
|
+
* the defined value is an empty string, it will reserve a space below
|
|
3888
|
+
* the component for a future error, but it would not change its look. In
|
|
3889
|
+
* case of being undefined or null, both the appearance and the space for
|
|
3890
|
+
* the error message would not be modified.
|
|
3891
|
+
*/
|
|
3892
|
+
error?: string;
|
|
3893
|
+
/**
|
|
3894
|
+
* Helper text to be placed above the input.
|
|
3895
|
+
*/
|
|
3896
|
+
helperText?: string;
|
|
3897
|
+
/**
|
|
3898
|
+
* Text to be placed above the input.
|
|
3899
|
+
*/
|
|
3900
|
+
label?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* Name attribute of the input element.
|
|
3903
|
+
*/
|
|
3904
|
+
name?: string;
|
|
3905
|
+
/**
|
|
3906
|
+
* This function will be called when the input element loses the focus.
|
|
3907
|
+
* An object including the input value and the error (if the value
|
|
3908
|
+
* entered is not valid) will be passed to this function. If there is no error,
|
|
3909
|
+
* error will not be defined.
|
|
3910
|
+
*/
|
|
3911
|
+
onBlur?: (val: {
|
|
3912
|
+
value: string;
|
|
3913
|
+
error?: string;
|
|
3914
|
+
}) => void;
|
|
3915
|
+
/**
|
|
3916
|
+
* This function will be called when the user types within the input
|
|
3917
|
+
* or selects a value in the dropdown element of the component.
|
|
3918
|
+
*/
|
|
3919
|
+
onChange?: (value: string) => void;
|
|
3920
|
+
/**
|
|
3921
|
+
* If true, the input will be optional, showing '(Optional)'
|
|
3922
|
+
* next to the label. Otherwise, the field will be considered required and an error will be
|
|
3923
|
+
* passed as a parameter to the OnBlur function when it has
|
|
3924
|
+
* not been filled.
|
|
3925
|
+
*/
|
|
3926
|
+
optional?: boolean;
|
|
3927
|
+
/**
|
|
3928
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3929
|
+
* In addition, the clear action will not be displayed even if the flag is set to true.
|
|
3930
|
+
*/
|
|
3931
|
+
readOnly?: boolean;
|
|
3932
|
+
/**
|
|
3933
|
+
* Reference to the component.
|
|
3934
|
+
*/
|
|
3935
|
+
ref?: RefType;
|
|
3936
|
+
/**
|
|
3937
|
+
* If true, the component will display seconds and allow the user to input them. Otherwise, seconds will not be shown and the user will not be able to input them.
|
|
3938
|
+
*/
|
|
3939
|
+
showSeconds?: boolean;
|
|
3940
|
+
/**
|
|
3941
|
+
* Size of the component.
|
|
3942
|
+
*/
|
|
3943
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
3944
|
+
/**
|
|
3945
|
+
* Value of the tabindex attribute.
|
|
3946
|
+
*/
|
|
3947
|
+
tabIndex?: number;
|
|
3948
|
+
/**
|
|
3949
|
+
* Time format of the input. It can be either 12 or 24.
|
|
3950
|
+
*/
|
|
3951
|
+
timeFormat?: "12" | "24";
|
|
3952
|
+
/**
|
|
3953
|
+
* Value of the input. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3954
|
+
*/
|
|
3955
|
+
value?: string;
|
|
3956
|
+
};
|
|
3957
|
+
|
|
3958
|
+
declare const DxcTimeInput: ({ ariaLabel, clearable, defaultValue, disabled, error, helperText, label, name, optional, readOnly, onBlur, onChange, ref, showSeconds, size, tabIndex, timeFormat, value, }: Props$4) => react.JSX.Element;
|
|
3400
3959
|
|
|
3401
3960
|
type Action = {
|
|
3402
3961
|
/**
|
|
@@ -3451,7 +4010,7 @@ type ToastsQueuePropsType = {
|
|
|
3451
4010
|
duration?: number;
|
|
3452
4011
|
};
|
|
3453
4012
|
|
|
3454
|
-
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType):
|
|
4013
|
+
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType): react.JSX.Element;
|
|
3455
4014
|
|
|
3456
4015
|
type OptionIcon = {
|
|
3457
4016
|
/**
|
|
@@ -3554,7 +4113,7 @@ type SingleSelectionToggleGroup = {
|
|
|
3554
4113
|
};
|
|
3555
4114
|
type Props$3 = CommonProps & (MultipleSelectionToggleGroup | SingleSelectionToggleGroup);
|
|
3556
4115
|
|
|
3557
|
-
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3):
|
|
4116
|
+
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3): react.JSX.Element;
|
|
3558
4117
|
|
|
3559
4118
|
type Props$2 = {
|
|
3560
4119
|
/**
|
|
@@ -3571,7 +4130,7 @@ type Props$2 = {
|
|
|
3571
4130
|
position?: "bottom" | "top" | "left" | "right";
|
|
3572
4131
|
};
|
|
3573
4132
|
|
|
3574
|
-
declare const DxcTooltip: (props: Props$2) =>
|
|
4133
|
+
declare const DxcTooltip: (props: Props$2) => react.JSX.Element;
|
|
3575
4134
|
|
|
3576
4135
|
type Props$1 = {
|
|
3577
4136
|
as?: "a" | "blockquote" | "cite" | "code" | "div" | "em" | "figcaption" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "pre" | "small" | "span" | "strong";
|
|
@@ -3590,7 +4149,7 @@ type Props$1 = {
|
|
|
3590
4149
|
whiteSpace?: "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap";
|
|
3591
4150
|
};
|
|
3592
4151
|
|
|
3593
|
-
declare function DxcTypography({ children, ...props }: Props$1):
|
|
4152
|
+
declare function DxcTypography({ children, ...props }: Props$1): react.JSX.Element;
|
|
3594
4153
|
|
|
3595
4154
|
type StepProps = {
|
|
3596
4155
|
/**
|
|
@@ -3606,7 +4165,7 @@ type StepProps = {
|
|
|
3606
4165
|
*/
|
|
3607
4166
|
icon?: string | SVG;
|
|
3608
4167
|
/**
|
|
3609
|
-
*
|
|
4168
|
+
* If true, the step will be disabled.
|
|
3610
4169
|
*/
|
|
3611
4170
|
disabled?: boolean;
|
|
3612
4171
|
/**
|
|
@@ -3647,7 +4206,7 @@ type Props = {
|
|
|
3647
4206
|
tabIndex?: number;
|
|
3648
4207
|
};
|
|
3649
4208
|
|
|
3650
|
-
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props):
|
|
4209
|
+
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props): react.JSX.Element;
|
|
3651
4210
|
|
|
3652
4211
|
declare const defaultTranslatedComponentLabels: {
|
|
3653
4212
|
applicationLayout: {
|
|
@@ -3665,8 +4224,12 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3665
4224
|
previousMonthTitle: string;
|
|
3666
4225
|
nextMonthTitle: string;
|
|
3667
4226
|
};
|
|
4227
|
+
card: {
|
|
4228
|
+
noContent: string;
|
|
4229
|
+
};
|
|
3668
4230
|
dateInput: {
|
|
3669
4231
|
invalidDateErrorMessage: string;
|
|
4232
|
+
datePickerActionTitle: string;
|
|
3670
4233
|
};
|
|
3671
4234
|
dialog: {
|
|
3672
4235
|
closeIconAriaLabel: string;
|
|
@@ -3689,13 +4252,21 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3689
4252
|
requiredSelectionErrorMessage: string;
|
|
3690
4253
|
requiredValueErrorMessage: string;
|
|
3691
4254
|
formatRequestedErrorMessage: string;
|
|
3692
|
-
|
|
3693
|
-
|
|
4255
|
+
minLengthErrorMessage: (minLength: number) => string;
|
|
4256
|
+
maxLengthErrorMessage: (maxLength: number) => string;
|
|
3694
4257
|
};
|
|
3695
4258
|
header: {
|
|
3696
4259
|
closeIcon: string;
|
|
3697
4260
|
hamburgerTitle: string;
|
|
3698
4261
|
};
|
|
4262
|
+
messageInput: {
|
|
4263
|
+
inputAriaLabel: string;
|
|
4264
|
+
sendButtonTitle: string;
|
|
4265
|
+
stopButtonTitle: string;
|
|
4266
|
+
attachFileButtonTitle: string;
|
|
4267
|
+
recordAudioButtonTitle: string;
|
|
4268
|
+
stopRecordingButtonTitle: string;
|
|
4269
|
+
};
|
|
3699
4270
|
numberInput: {
|
|
3700
4271
|
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
3701
4272
|
valueLessThanOrEqualToErrorMessage: (value: number) => string;
|
|
@@ -3722,6 +4293,12 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3722
4293
|
radioGroup: {
|
|
3723
4294
|
optionalItemLabelDefault: string;
|
|
3724
4295
|
};
|
|
4296
|
+
searchBar: {
|
|
4297
|
+
clearFieldActionTitle: string;
|
|
4298
|
+
inputAriaLabel: string;
|
|
4299
|
+
triggerTitle: string;
|
|
4300
|
+
cancelButtonLabel: string;
|
|
4301
|
+
};
|
|
3725
4302
|
select: {
|
|
3726
4303
|
actionClearSelectionTitle: string;
|
|
3727
4304
|
actionClearSearchTitle: string;
|
|
@@ -3737,11 +4314,20 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
3737
4314
|
searchingMessage: string;
|
|
3738
4315
|
fetchingDataErrorMessage: string;
|
|
3739
4316
|
};
|
|
4317
|
+
timeInput: {
|
|
4318
|
+
timePickerActionTitle: string;
|
|
4319
|
+
timePeriodAM: string;
|
|
4320
|
+
timePeriodPM: string;
|
|
4321
|
+
};
|
|
3740
4322
|
toast: {
|
|
3741
4323
|
clearToastActionTitle: string;
|
|
3742
4324
|
};
|
|
3743
4325
|
};
|
|
3744
4326
|
type TranslatedLabels = typeof defaultTranslatedComponentLabels;
|
|
4327
|
+
type LocalizedContext = {
|
|
4328
|
+
labels: TranslatedLabels;
|
|
4329
|
+
locale?: string;
|
|
4330
|
+
};
|
|
3745
4331
|
|
|
3746
4332
|
/**
|
|
3747
4333
|
* This type is used to allow labels objects to be passed to the HalstackProvider.
|
|
@@ -3750,105 +4336,18 @@ type TranslatedLabels = typeof defaultTranslatedComponentLabels;
|
|
|
3750
4336
|
type DeepPartial<T> = {
|
|
3751
4337
|
[P in keyof T]?: Partial<T[P]>;
|
|
3752
4338
|
};
|
|
3753
|
-
declare const HalstackLanguageContext: react.Context<
|
|
3754
|
-
|
|
3755
|
-
|
|
3756
|
-
|
|
3757
|
-
|
|
3758
|
-
previousMessageActionTitle: string;
|
|
3759
|
-
nextMessageActionTitle: string;
|
|
3760
|
-
closeAlertActionTitle: string;
|
|
3761
|
-
closeMessageActionTitle: string;
|
|
3762
|
-
};
|
|
3763
|
-
calendar: {
|
|
3764
|
-
daysShort: string[];
|
|
3765
|
-
months: string[];
|
|
3766
|
-
previousMonthTitle: string;
|
|
3767
|
-
nextMonthTitle: string;
|
|
3768
|
-
};
|
|
3769
|
-
dateInput: {
|
|
3770
|
-
invalidDateErrorMessage: string;
|
|
3771
|
-
};
|
|
3772
|
-
dialog: {
|
|
3773
|
-
closeIconAriaLabel: string;
|
|
3774
|
-
};
|
|
3775
|
-
fileInput: {
|
|
3776
|
-
fileSizeGreaterThanErrorMessage: string;
|
|
3777
|
-
fileSizeLessThanErrorMessage: string;
|
|
3778
|
-
multipleButtonLabelDefault: string;
|
|
3779
|
-
singleButtonLabelDefault: string;
|
|
3780
|
-
dropAreaButtonLabelDefault: string;
|
|
3781
|
-
multipleDropAreaLabelDefault: string;
|
|
3782
|
-
singleDropAreaLabelDefault: string;
|
|
3783
|
-
deleteFileActionTitle: string;
|
|
3784
|
-
};
|
|
3785
|
-
footer: {
|
|
3786
|
-
copyrightText: (year: number) => string;
|
|
3787
|
-
};
|
|
3788
|
-
formFields: {
|
|
3789
|
-
optionalLabel: string;
|
|
3790
|
-
requiredSelectionErrorMessage: string;
|
|
3791
|
-
requiredValueErrorMessage: string;
|
|
3792
|
-
formatRequestedErrorMessage: string;
|
|
3793
|
-
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
3794
|
-
logoAlternativeText: string;
|
|
3795
|
-
};
|
|
3796
|
-
header: {
|
|
3797
|
-
closeIcon: string;
|
|
3798
|
-
hamburgerTitle: string;
|
|
3799
|
-
};
|
|
3800
|
-
numberInput: {
|
|
3801
|
-
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
3802
|
-
valueLessThanOrEqualToErrorMessage: (value: number) => string;
|
|
3803
|
-
decrementValueTitle: string;
|
|
3804
|
-
incrementValueTitle: string;
|
|
3805
|
-
};
|
|
3806
|
-
paginator: {
|
|
3807
|
-
itemsPerPageText: string;
|
|
3808
|
-
minToMaxOfText: (minNumberOfItems: number, maxNumberOfItems: number, totalItems: number) => string;
|
|
3809
|
-
goToPageText: string;
|
|
3810
|
-
pageOfText: (pageNumber: number, totalPagesNumber: number) => string;
|
|
3811
|
-
firstResultsTitle: string;
|
|
3812
|
-
previousResultsTitle: string;
|
|
3813
|
-
nextResultsTitle: string;
|
|
3814
|
-
lastResultsTitle: string;
|
|
3815
|
-
};
|
|
3816
|
-
passwordInput: {
|
|
3817
|
-
inputShowPasswordTitle: string;
|
|
3818
|
-
inputHidePasswordTitle: string;
|
|
3819
|
-
};
|
|
3820
|
-
quickNav: {
|
|
3821
|
-
contentTitle: string;
|
|
3822
|
-
};
|
|
3823
|
-
radioGroup: {
|
|
3824
|
-
optionalItemLabelDefault: string;
|
|
3825
|
-
};
|
|
3826
|
-
select: {
|
|
3827
|
-
actionClearSelectionTitle: string;
|
|
3828
|
-
actionClearSearchTitle: string;
|
|
3829
|
-
noMatchesErrorMessage: string;
|
|
3830
|
-
selectAllLabel: string;
|
|
3831
|
-
};
|
|
3832
|
-
tabs: {
|
|
3833
|
-
scrollLeft: string;
|
|
3834
|
-
scrollRight: string;
|
|
3835
|
-
};
|
|
3836
|
-
textInput: {
|
|
3837
|
-
clearFieldActionTitle: string;
|
|
3838
|
-
searchingMessage: string;
|
|
3839
|
-
fetchingDataErrorMessage: string;
|
|
3840
|
-
};
|
|
3841
|
-
toast: {
|
|
3842
|
-
clearToastActionTitle: string;
|
|
3843
|
-
};
|
|
3844
|
-
}>;
|
|
3845
|
-
type ThemeType = Record<string, string | number>;
|
|
4339
|
+
declare const HalstackLanguageContext: react.Context<LocalizedContext>;
|
|
4340
|
+
type ThemeType = {
|
|
4341
|
+
tokens?: Record<string, string | number>;
|
|
4342
|
+
logos?: Record<string, string | undefined>;
|
|
4343
|
+
};
|
|
3846
4344
|
type HalstackProviderPropsType = {
|
|
3847
4345
|
labels?: DeepPartial<TranslatedLabels>;
|
|
3848
4346
|
children: ReactNode;
|
|
3849
4347
|
opinionatedTheme?: ThemeType;
|
|
4348
|
+
localeTag?: string;
|
|
3850
4349
|
};
|
|
3851
|
-
declare const HalstackProvider: ({ labels, children, opinionatedTheme }: HalstackProviderPropsType) => JSX.Element;
|
|
4350
|
+
declare const HalstackProvider: ({ labels, children, opinionatedTheme, localeTag, }: HalstackProviderPropsType) => JSX.Element;
|
|
3852
4351
|
|
|
3853
4352
|
declare function useToast(): {
|
|
3854
4353
|
default: (toast: DefaultToast) => (() => void) | undefined;
|
|
@@ -3858,4 +4357,4 @@ declare function useToast(): {
|
|
|
3858
4357
|
loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
|
|
3859
4358
|
};
|
|
3860
4359
|
|
|
3861
|
-
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcBadge, DxcBleed, DxcBreadcrumbs, DxcBulletedList, DxcButton, DxcCard, DxcCheckbox, DxcChip, DxcContainer, DxcContextualMenu, DxcDataGrid, DxcDateInput, DxcDialog, DxcDivider, DxcDropdown, DxcFileInput, DxcFlex, DxcGrid, DxcHeading, DxcImage, DxcInset, DxcLink, DxcNavTabs, DxcNumberInput, DxcPaginator, DxcParagraph, DxcPasswordInput, DxcProgressBar, DxcQuickNav, DxcRadioGroup, DxcResultsetTable, DxcSelect, DxcSlider, DxcSpinner, DxcStatusLight, DxcSwitch, DxcTable, DxcTabs, DxcTextInput, DxcTextarea, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackLanguageContext, HalstackProvider, useToast };
|
|
4360
|
+
export { DxcAccordion, DxcAlert, DxcApplicationLayout, DxcAvatar, DxcBadge, DxcBleed, DxcBreadcrumbs, DxcBulletedList, DxcButton, DxcCard, DxcCheckbox, DxcChip, DxcContainer, DxcContextualMenu, DxcDataGrid, DxcDateInput, DxcDialog, DxcDivider, DxcDropdown, DxcFileInput, DxcFlex, DxcGrid, DxcHeading, DxcImage, DxcInset, DxcLink, DxcMessageInput, DxcNavTabs, DxcNumberInput, DxcPaginator, DxcParagraph, DxcPasswordInput, DxcPopover, DxcProgressBar, DxcQuickNav, DxcRadioGroup, DxcResultsetTable, DxcSelect, DxcSlider, DxcSpinner, DxcStatusLight, DxcSwitch, DxcTable, DxcTabs, DxcTextInput, DxcTextarea, DxcTimeInput, DxcToastsQueue, DxcToggleGroup, DxcTooltip, DxcTypography, DxcWizard, HalstackLanguageContext, HalstackProvider, useToast };
|