@dxc-technology/halstack-react 0.0.0-99edeb7 → 0.0.0-99ee508
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/dist/index.d.mts +1415 -1394
- package/dist/index.d.ts +1415 -1394
- package/dist/index.js +10317 -9665
- package/dist/index.mjs +10308 -9626
- package/package.json +14 -16
package/dist/index.d.mts
CHANGED
|
@@ -1,34 +1,45 @@
|
|
|
1
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
1
|
import * as react from 'react';
|
|
2
|
+
import { ReactNode, SVGProps, ReactElement, MouseEvent, ReactEventHandler } from 'react';
|
|
3
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
+
import { SortColumn } from 'react-data-grid';
|
|
3
5
|
import * as styled_components from 'styled-components';
|
|
4
6
|
|
|
5
|
-
type Space$
|
|
6
|
-
type Margin
|
|
7
|
-
top?: Space$
|
|
8
|
-
bottom?: Space$
|
|
9
|
-
left?: Space$
|
|
10
|
-
right?: Space$
|
|
7
|
+
type Space$1 = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
8
|
+
type Margin = {
|
|
9
|
+
top?: Space$1;
|
|
10
|
+
bottom?: Space$1;
|
|
11
|
+
left?: Space$1;
|
|
12
|
+
right?: Space$1;
|
|
11
13
|
};
|
|
12
|
-
type SVG
|
|
13
|
-
|
|
14
|
+
type SVG = ReactNode & SVGProps<SVGSVGElement>;
|
|
15
|
+
|
|
16
|
+
type AccordionItemProps = {
|
|
14
17
|
/**
|
|
15
18
|
* The panel label.
|
|
16
19
|
*/
|
|
17
20
|
label: string;
|
|
18
21
|
/**
|
|
19
|
-
*
|
|
22
|
+
* Additional info label positioned under the label.
|
|
23
|
+
*/
|
|
24
|
+
subLabel?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Badge component to add extra value to the accordion.
|
|
20
27
|
*/
|
|
21
|
-
|
|
28
|
+
badge?: {
|
|
29
|
+
position: "before" | "after";
|
|
30
|
+
element: ReactNode;
|
|
31
|
+
};
|
|
22
32
|
/**
|
|
23
|
-
*
|
|
24
|
-
* expanded. If undefined, the component will be uncontrolled and its
|
|
25
|
-
* value will be managed internally by the component.
|
|
33
|
+
* Status light component to add extra value to the accordion.
|
|
26
34
|
*/
|
|
27
|
-
|
|
35
|
+
statusLight?: ReactNode;
|
|
28
36
|
/**
|
|
29
|
-
* Material Symbol name or SVG element used as the icon that will be
|
|
37
|
+
* Material Symbol name or SVG element used as the icon that will be
|
|
38
|
+
* placed next to panel label. When using Material Symbols, replace spaces with underscores.
|
|
39
|
+
* By default they are outlined if you want it to be filled
|
|
40
|
+
* prefix the symbol name with "filled_".
|
|
30
41
|
*/
|
|
31
|
-
icon?: string | SVG
|
|
42
|
+
icon?: string | SVG;
|
|
32
43
|
/**
|
|
33
44
|
* Assistive text to be placed on the right side of the panel.
|
|
34
45
|
*/
|
|
@@ -37,156 +48,170 @@ type Props$K = {
|
|
|
37
48
|
* If true, the component will be disabled.
|
|
38
49
|
*/
|
|
39
50
|
disabled?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* This function will be called when the user clicks the accordion to expand or collapse
|
|
42
|
-
* the panel. The new state of the panel will be passed as a parameter.
|
|
43
|
-
*/
|
|
44
|
-
onChange?: (isExpanded: boolean) => void;
|
|
45
51
|
/**
|
|
46
52
|
* The expanded panel of the accordion. This area can be used to render
|
|
47
53
|
* custom content.
|
|
48
54
|
*/
|
|
49
|
-
children:
|
|
50
|
-
/**
|
|
51
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
52
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
53
|
-
*/
|
|
54
|
-
margin?: Space$u | Margin$p;
|
|
55
|
+
children: ReactNode;
|
|
55
56
|
/**
|
|
56
57
|
* Value of the tabindex attribute.
|
|
57
58
|
*/
|
|
58
59
|
tabIndex?: number;
|
|
59
60
|
};
|
|
60
|
-
|
|
61
|
-
declare const DxcAccordion: ({ label, defaultIsExpanded, isExpanded, icon, assistiveText, disabled, onChange, children, margin, tabIndex, }: Props$K) => JSX.Element;
|
|
62
|
-
|
|
63
|
-
type Space$t = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
64
|
-
type Margin$o = {
|
|
65
|
-
top?: Space$t;
|
|
66
|
-
bottom?: Space$t;
|
|
67
|
-
left?: Space$t;
|
|
68
|
-
right?: Space$t;
|
|
69
|
-
};
|
|
70
|
-
type SVG$h = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
71
|
-
type AccordionPropsType = {
|
|
61
|
+
type CommonProps$9 = {
|
|
72
62
|
/**
|
|
73
|
-
*
|
|
63
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
64
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
74
65
|
*/
|
|
75
|
-
|
|
66
|
+
margin?: Space$1 | Margin;
|
|
76
67
|
/**
|
|
77
|
-
*
|
|
68
|
+
* Contains one or more accordion items.
|
|
78
69
|
*/
|
|
79
|
-
|
|
70
|
+
children: ReactElement<AccordionItemProps>[] | ReactElement<AccordionItemProps>;
|
|
71
|
+
};
|
|
72
|
+
type IndependentProps = CommonProps$9 & {
|
|
80
73
|
/**
|
|
81
|
-
*
|
|
74
|
+
* When true, limits the user to single-open section at a time. When false, multiple sections can be opened simultaneously.
|
|
82
75
|
*/
|
|
83
|
-
|
|
76
|
+
independent: true;
|
|
84
77
|
/**
|
|
85
|
-
*
|
|
78
|
+
* Initially active accordion, only when it is uncontrolled.If the accordion is not independent,
|
|
79
|
+
* several accordions can be activated by default.
|
|
86
80
|
*/
|
|
87
|
-
|
|
81
|
+
defaultIndexActive?: number;
|
|
88
82
|
/**
|
|
89
|
-
* The
|
|
90
|
-
*
|
|
83
|
+
* The index of the active accordion. If undefined, the component will be uncontrolled and the active
|
|
84
|
+
* accordion will be managed internally by the component. If null, the component will be controlled and all
|
|
85
|
+
* accordions will be closed. If the accordion is not independent, several accordions can be activated.
|
|
86
|
+
*/
|
|
87
|
+
indexActive?: number;
|
|
88
|
+
/**
|
|
89
|
+
* This function will be called when the user clicks on an accordion. The index of the clicked accordion will be passed as a parameter.
|
|
91
90
|
*/
|
|
92
|
-
|
|
91
|
+
onActiveChange?: (index: number) => void;
|
|
93
92
|
};
|
|
94
|
-
type
|
|
93
|
+
type NonIndependentProps = CommonProps$9 & {
|
|
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
|
*/
|
|
98
|
-
|
|
97
|
+
independent?: false;
|
|
99
98
|
/**
|
|
100
|
-
*
|
|
101
|
-
*
|
|
99
|
+
* Initially active accordion, only when it is uncontrolled. If the accordion is not independent,
|
|
100
|
+
* several accordions can be activated by default.
|
|
102
101
|
*/
|
|
103
|
-
|
|
102
|
+
defaultIndexActive?: number[];
|
|
104
103
|
/**
|
|
105
|
-
* If
|
|
104
|
+
* The index of the active accordion. If undefined, the component will be uncontrolled and the active
|
|
105
|
+
* accordion will be managed internally by the component. If null, the component will be controlled and all
|
|
106
|
+
* accordions will be closed. If the accordion is not independent, several accordions can be activated.
|
|
106
107
|
*/
|
|
107
|
-
|
|
108
|
+
indexActive?: number[];
|
|
108
109
|
/**
|
|
109
110
|
* This function will be called when the user clicks on an accordion. The index of the clicked accordion will be passed as a parameter.
|
|
110
111
|
*/
|
|
111
|
-
onActiveChange?: (
|
|
112
|
+
onActiveChange?: (index: number[]) => void;
|
|
113
|
+
};
|
|
114
|
+
type Props$I = IndependentProps | NonIndependentProps;
|
|
115
|
+
|
|
116
|
+
declare const DxcAccordion: {
|
|
117
|
+
(props: Props$I): JSX.Element;
|
|
118
|
+
AccordionItem: ({ label, subLabel, badge, statusLight, icon, assistiveText, disabled, children, tabIndex, }: AccordionItemProps) => JSX.Element;
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
type Action$2 = {
|
|
112
122
|
/**
|
|
113
|
-
*
|
|
114
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
123
|
+
* The icon of the action. It can be a string with the name of the icon or an SVG component.
|
|
115
124
|
*/
|
|
116
|
-
|
|
125
|
+
icon?: string | SVG;
|
|
117
126
|
/**
|
|
118
|
-
*
|
|
127
|
+
* The label of the action.
|
|
119
128
|
*/
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
Accordion: ({ ...childProps }: AccordionPropsType) => JSX.Element;
|
|
129
|
+
label: string;
|
|
130
|
+
/**
|
|
131
|
+
* The function that will be executed when the user clicks on the action button.
|
|
132
|
+
*/
|
|
133
|
+
onClick: () => void;
|
|
126
134
|
};
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
135
|
+
type Message = {
|
|
136
|
+
/**
|
|
137
|
+
* The function that will be executed when the user clicks on the close action button.
|
|
138
|
+
*/
|
|
139
|
+
onClose?: () => void;
|
|
140
|
+
/**
|
|
141
|
+
* The content of the message. The only Halstack component allowed within the text of an alert is the Link component,
|
|
142
|
+
* and it should be used exclusively to direct users to additional resources or relevant pages.
|
|
143
|
+
* No other components are permitted within the content of an alert.
|
|
144
|
+
*/
|
|
145
|
+
text: ReactNode;
|
|
134
146
|
};
|
|
135
|
-
type
|
|
147
|
+
type CommonProps$8 = {
|
|
136
148
|
/**
|
|
137
|
-
*
|
|
149
|
+
* If true, the alert will have a close button that will remove the message from the alert,
|
|
150
|
+
* only in banner and inline modes. The rest of the functionality will depend
|
|
151
|
+
* on the onClose event of each message (e.g. closing the modal alert).
|
|
138
152
|
*/
|
|
139
|
-
|
|
153
|
+
closable?: boolean;
|
|
140
154
|
/**
|
|
141
|
-
*
|
|
142
|
-
* 'inline': If onClose function is received, close button will be visible and the function will be executed when it's clicked.
|
|
143
|
-
* There is no overlay layer. Position should be decided by the user.
|
|
144
|
-
* 'modal': The alert will be displayed in the middle of the screen with an overlay layer behind.
|
|
145
|
-
* The onClose function will be executed when the X button or the overlay is clicked. d
|
|
146
|
-
* The user has the responsibility of hiding the modal in the onClose function, otherwise the modal will remain visible.
|
|
155
|
+
* Primary action of the alert.
|
|
147
156
|
*/
|
|
148
|
-
|
|
157
|
+
primaryAction?: Action$2;
|
|
149
158
|
/**
|
|
150
|
-
*
|
|
159
|
+
* Secondary action of the alert.
|
|
151
160
|
*/
|
|
152
|
-
|
|
161
|
+
secondaryAction?: Action$2;
|
|
153
162
|
/**
|
|
154
|
-
*
|
|
163
|
+
* Specifies the semantic meaning of the alert.
|
|
155
164
|
*/
|
|
156
|
-
|
|
165
|
+
semantic?: "error" | "info" | "success" | "warning";
|
|
166
|
+
/**
|
|
167
|
+
* Title of the alert.
|
|
168
|
+
*/
|
|
169
|
+
title: string;
|
|
170
|
+
};
|
|
171
|
+
type ModeSpecificProps = {
|
|
157
172
|
/**
|
|
158
|
-
*
|
|
173
|
+
* List of messages to be displayed. Each message has a close action that will,
|
|
174
|
+
* apart from remove from the alert the current message, call the onClose if it is defined.
|
|
175
|
+
* If the message is an array, the alert will show a navigation bar to move between the messages.
|
|
176
|
+
* The modal mode only allows one message per alert. In this case, the message must be an object
|
|
177
|
+
* and the presence of the onClose attribute is mandatory, since the management of the closing
|
|
178
|
+
* of the alert relies completely on the user.
|
|
159
179
|
*/
|
|
160
|
-
|
|
180
|
+
message?: Message | Message[];
|
|
161
181
|
/**
|
|
162
|
-
*
|
|
163
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
182
|
+
* The mode of the alert.
|
|
164
183
|
*/
|
|
165
|
-
|
|
184
|
+
mode?: "inline" | "banner";
|
|
185
|
+
} | {
|
|
166
186
|
/**
|
|
167
|
-
*
|
|
187
|
+
* List of messages to be displayed. Each message has a close action that will,
|
|
188
|
+
* apart from remove from the alert the current message, call the onClose if it is defined.
|
|
189
|
+
* If the message is an array, the alert will show a navigation bar to move between the messages.
|
|
190
|
+
* The modal mode only allows one message per alert. In this case, the message must be an object
|
|
191
|
+
* and the presence of the onClose attribute is mandatory, since the management of the closing
|
|
192
|
+
* of the alert relies completely on the user.
|
|
168
193
|
*/
|
|
169
|
-
|
|
194
|
+
message: Required<Message>;
|
|
170
195
|
/**
|
|
171
|
-
*
|
|
196
|
+
* The mode of the alert.
|
|
172
197
|
*/
|
|
173
|
-
|
|
198
|
+
mode: "modal";
|
|
174
199
|
};
|
|
200
|
+
type Props$H = CommonProps$8 & ModeSpecificProps;
|
|
175
201
|
|
|
176
|
-
declare
|
|
202
|
+
declare function DxcAlert({ closable, message, mode, primaryAction, secondaryAction, semantic, title, }: Props$H): react_jsx_runtime.JSX.Element;
|
|
177
203
|
|
|
178
|
-
type SVG$g = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
179
204
|
type SidenavTitlePropsType = {
|
|
180
205
|
/**
|
|
181
206
|
* The area inside the sidenav title. This area can be used to render custom content.
|
|
182
207
|
*/
|
|
183
|
-
children:
|
|
208
|
+
children: ReactNode;
|
|
184
209
|
};
|
|
185
210
|
type SidenavSectionPropsType = {
|
|
186
211
|
/**
|
|
187
212
|
* The area inside the sidenav section. This area can be used to render sidenav groups, links and custom content.
|
|
188
213
|
*/
|
|
189
|
-
children:
|
|
214
|
+
children: ReactNode;
|
|
190
215
|
};
|
|
191
216
|
type SidenavGroupPropsType = {
|
|
192
217
|
/**
|
|
@@ -201,11 +226,11 @@ type SidenavGroupPropsType = {
|
|
|
201
226
|
/**
|
|
202
227
|
* Material Symbol name or SVG icon to be displayed next to the title of the group.
|
|
203
228
|
*/
|
|
204
|
-
icon?: string | SVG
|
|
229
|
+
icon?: string | SVG;
|
|
205
230
|
/**
|
|
206
231
|
* The area inside the sidenav group. This area can be used to render sidenav links.
|
|
207
232
|
*/
|
|
208
|
-
children:
|
|
233
|
+
children: ReactNode;
|
|
209
234
|
};
|
|
210
235
|
type SidenavLinkPropsType = {
|
|
211
236
|
/**
|
|
@@ -219,7 +244,7 @@ type SidenavLinkPropsType = {
|
|
|
219
244
|
/**
|
|
220
245
|
* The Material symbol or SVG element used as the icon that will be placed to the left of the link text.
|
|
221
246
|
*/
|
|
222
|
-
icon?: string | SVG
|
|
247
|
+
icon?: string | SVG;
|
|
223
248
|
/**
|
|
224
249
|
* If true, the link will be marked as selected. Moreover, in that same case,
|
|
225
250
|
* if it is contained within a collapsed group, and consequently, the currently selected link is not visible,
|
|
@@ -229,100 +254,29 @@ type SidenavLinkPropsType = {
|
|
|
229
254
|
/**
|
|
230
255
|
* This function will be called when the user clicks the link and the event will be passed to this function.
|
|
231
256
|
*/
|
|
232
|
-
onClick?: (event:
|
|
257
|
+
onClick?: (event: MouseEvent<HTMLAnchorElement>) => void;
|
|
233
258
|
/**
|
|
234
259
|
* The area inside the sidenav link.
|
|
235
260
|
*/
|
|
236
|
-
children:
|
|
261
|
+
children: ReactNode;
|
|
237
262
|
/**
|
|
238
263
|
* Value of the tabindex.
|
|
239
264
|
*/
|
|
240
265
|
tabIndex?: number;
|
|
241
266
|
};
|
|
242
|
-
type Props$
|
|
267
|
+
type Props$G = {
|
|
243
268
|
/**
|
|
244
269
|
* The area assigned to render the sidenav title. It is highly recommended to use the sidenav title.
|
|
245
270
|
*/
|
|
246
|
-
title?:
|
|
271
|
+
title?: ReactNode;
|
|
247
272
|
/**
|
|
248
273
|
* The area inside the sidenav. This area can be used to render the content inside the sidenav.
|
|
249
274
|
*/
|
|
250
|
-
children:
|
|
275
|
+
children: ReactNode;
|
|
251
276
|
};
|
|
252
277
|
|
|
253
|
-
type Space$r = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
254
|
-
type SVG$f = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
255
|
-
type SocialLink = {
|
|
256
|
-
/**
|
|
257
|
-
* URL of the page the link goes to.
|
|
258
|
-
*/
|
|
259
|
-
href: string;
|
|
260
|
-
/**
|
|
261
|
-
* Material Symbol name or SVG element as the icon used for the link.
|
|
262
|
-
*/
|
|
263
|
-
logo: string | SVG$f;
|
|
264
|
-
/**
|
|
265
|
-
* Value for the HTML properties title and aria-label.
|
|
266
|
-
*/
|
|
267
|
-
title: string;
|
|
268
|
-
};
|
|
269
|
-
type BottomLink = {
|
|
270
|
-
/**
|
|
271
|
-
* URL of the page the link goes to.
|
|
272
|
-
*/
|
|
273
|
-
href: string;
|
|
274
|
-
/**
|
|
275
|
-
* Text for the link.
|
|
276
|
-
*/
|
|
277
|
-
text: string;
|
|
278
|
-
};
|
|
279
|
-
type FooterPropsType = {
|
|
280
|
-
/**
|
|
281
|
-
* An array of objects representing the links that will be rendered as
|
|
282
|
-
* icons at the top-right side of the footer.
|
|
283
|
-
*/
|
|
284
|
-
socialLinks?: SocialLink[];
|
|
285
|
-
/**
|
|
286
|
-
* An array of objects representing the links that will be rendered at
|
|
287
|
-
* the bottom part of the footer.
|
|
288
|
-
*/
|
|
289
|
-
bottomLinks?: BottomLink[];
|
|
290
|
-
/**
|
|
291
|
-
* The text that will be displayed as copyright disclaimer.
|
|
292
|
-
*/
|
|
293
|
-
copyright?: string;
|
|
294
|
-
/**
|
|
295
|
-
* The center section of the footer. Can be used to render custom
|
|
296
|
-
* content in this area.
|
|
297
|
-
*/
|
|
298
|
-
children?: React.ReactNode;
|
|
299
|
-
/**
|
|
300
|
-
* Size of the top margin to be applied to the footer.
|
|
301
|
-
*/
|
|
302
|
-
margin?: Space$r;
|
|
303
|
-
/**
|
|
304
|
-
* Value of the tabindex for all interactive elements, except those
|
|
305
|
-
* inside the custom area.
|
|
306
|
-
*/
|
|
307
|
-
tabIndex?: number;
|
|
308
|
-
/**
|
|
309
|
-
* Determines the visual style and layout
|
|
310
|
-
* - "default": The default mode with full content and styling.
|
|
311
|
-
* - "reduced": A reduced mode with minimal content and styling.
|
|
312
|
-
*/
|
|
313
|
-
mode?: "default" | "reduced";
|
|
314
|
-
};
|
|
315
|
-
|
|
316
|
-
type Space$q = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
317
|
-
type Margin$m = {
|
|
318
|
-
top?: Space$q;
|
|
319
|
-
bottom?: Space$q;
|
|
320
|
-
left?: Space$q;
|
|
321
|
-
right?: Space$q;
|
|
322
|
-
};
|
|
323
278
|
type Size$4 = "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
324
|
-
type
|
|
325
|
-
type Option$1 = {
|
|
279
|
+
type Option$2 = {
|
|
326
280
|
/**
|
|
327
281
|
* Option display value.
|
|
328
282
|
*/
|
|
@@ -330,17 +284,17 @@ type Option$1 = {
|
|
|
330
284
|
/**
|
|
331
285
|
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
332
286
|
*/
|
|
333
|
-
icon?: string | SVG
|
|
287
|
+
icon?: string | SVG;
|
|
334
288
|
/**
|
|
335
289
|
* Option inner value.
|
|
336
290
|
*/
|
|
337
291
|
value: string;
|
|
338
292
|
};
|
|
339
|
-
type Props$
|
|
293
|
+
type Props$F = {
|
|
340
294
|
/**
|
|
341
295
|
* An array of objects representing the options.
|
|
342
296
|
*/
|
|
343
|
-
options: Option$
|
|
297
|
+
options: Option$2[];
|
|
344
298
|
/**
|
|
345
299
|
* In case options include icons, whether the icon should appear
|
|
346
300
|
* after or before the label.
|
|
@@ -349,7 +303,7 @@ type Props$G = {
|
|
|
349
303
|
/**
|
|
350
304
|
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
351
305
|
*/
|
|
352
|
-
icon?: string | SVG
|
|
306
|
+
icon?: string | SVG;
|
|
353
307
|
/**
|
|
354
308
|
* Whether the icon should appear after or before the label.
|
|
355
309
|
*/
|
|
@@ -380,7 +334,7 @@ type Props$G = {
|
|
|
380
334
|
* You can pass an object with 'top', 'bottom', 'left' and 'right'
|
|
381
335
|
* properties in order to specify different margin sizes.
|
|
382
336
|
*/
|
|
383
|
-
margin?: Space$
|
|
337
|
+
margin?: Space$1 | Margin;
|
|
384
338
|
/**
|
|
385
339
|
* Size of the component.
|
|
386
340
|
*/
|
|
@@ -389,10 +343,28 @@ type Props$G = {
|
|
|
389
343
|
* Value of the tabindex attribute.
|
|
390
344
|
*/
|
|
391
345
|
tabIndex?: number;
|
|
346
|
+
/**
|
|
347
|
+
* Text representing advisory information related to the dropdown's trigger action.
|
|
348
|
+
* Under the hood, this prop also serves as an accessible label for the component.
|
|
349
|
+
*/
|
|
350
|
+
title?: string;
|
|
392
351
|
};
|
|
393
352
|
|
|
394
|
-
type
|
|
395
|
-
|
|
353
|
+
type Logo$1 = {
|
|
354
|
+
/**
|
|
355
|
+
* URL to navigate when the logo is clicked.
|
|
356
|
+
*/
|
|
357
|
+
href?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Source of the logo image.
|
|
360
|
+
*/
|
|
361
|
+
src: string;
|
|
362
|
+
/**
|
|
363
|
+
* Alternative text for the logo image.
|
|
364
|
+
*/
|
|
365
|
+
title?: string;
|
|
366
|
+
};
|
|
367
|
+
type Props$E = {
|
|
396
368
|
/**
|
|
397
369
|
* Whether a contrast line should appear at the bottom of the header.
|
|
398
370
|
*/
|
|
@@ -402,20 +374,24 @@ type Props$F = {
|
|
|
402
374
|
* for the first child in the content, so we recommend the use of React.Fragment
|
|
403
375
|
* to be applied correctly. Otherwise, the styles can be modified.
|
|
404
376
|
*/
|
|
405
|
-
content?:
|
|
377
|
+
content?: ReactNode;
|
|
406
378
|
/**
|
|
407
379
|
* Content shown in responsive version. It receives the close menu handler that can
|
|
408
380
|
* be used to add that functionality when a element is clicked.
|
|
409
381
|
*/
|
|
410
|
-
responsiveContent?: (closeHandler: () => void) =>
|
|
382
|
+
responsiveContent?: (closeHandler: () => void) => ReactNode;
|
|
411
383
|
/**
|
|
412
|
-
*
|
|
384
|
+
* Logo to be displayed inside the header
|
|
413
385
|
*/
|
|
414
|
-
|
|
386
|
+
logo?: Logo$1;
|
|
415
387
|
/**
|
|
416
388
|
* Size of the bottom margin to be applied to the header.
|
|
417
389
|
*/
|
|
418
|
-
margin?: Space$
|
|
390
|
+
margin?: Space$1;
|
|
391
|
+
/**
|
|
392
|
+
* This function will be called when the user clicks the header logo.
|
|
393
|
+
*/
|
|
394
|
+
onClick?: () => void;
|
|
419
395
|
/**
|
|
420
396
|
* Value of the tabindex for all interactive elements, except those inside the
|
|
421
397
|
* custom area.
|
|
@@ -423,13 +399,92 @@ type Props$F = {
|
|
|
423
399
|
tabIndex?: number;
|
|
424
400
|
};
|
|
425
401
|
|
|
402
|
+
type SocialLink = {
|
|
403
|
+
/**
|
|
404
|
+
* URL of the page the link goes to.
|
|
405
|
+
*/
|
|
406
|
+
href: string;
|
|
407
|
+
/**
|
|
408
|
+
* Material Symbol name or SVG element as the icon used for the link.
|
|
409
|
+
*/
|
|
410
|
+
logo: string | SVG;
|
|
411
|
+
/**
|
|
412
|
+
* Value for the HTML properties title and aria-label.
|
|
413
|
+
*/
|
|
414
|
+
title: string;
|
|
415
|
+
};
|
|
416
|
+
type BottomLink = {
|
|
417
|
+
/**
|
|
418
|
+
* URL of the page the link goes to.
|
|
419
|
+
*/
|
|
420
|
+
href: string;
|
|
421
|
+
/**
|
|
422
|
+
* Text for the link.
|
|
423
|
+
*/
|
|
424
|
+
text: string;
|
|
425
|
+
};
|
|
426
|
+
type Logo = {
|
|
427
|
+
/**
|
|
428
|
+
* URL to navigate when the logo is clicked.
|
|
429
|
+
*/
|
|
430
|
+
href?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Source of the logo image.
|
|
433
|
+
*/
|
|
434
|
+
src: string;
|
|
435
|
+
/**
|
|
436
|
+
* Alternative text for the logo image.
|
|
437
|
+
*/
|
|
438
|
+
title?: string;
|
|
439
|
+
};
|
|
440
|
+
type FooterPropsType = {
|
|
441
|
+
/**
|
|
442
|
+
* An array of objects representing the links that will be rendered at
|
|
443
|
+
* the bottom part of the footer.
|
|
444
|
+
*/
|
|
445
|
+
bottomLinks?: BottomLink[];
|
|
446
|
+
/**
|
|
447
|
+
* The center section of the footer. Can be used to render custom
|
|
448
|
+
* content in this area.
|
|
449
|
+
*/
|
|
450
|
+
children?: ReactNode;
|
|
451
|
+
/**
|
|
452
|
+
* The text that will be displayed as copyright disclaimer.
|
|
453
|
+
*/
|
|
454
|
+
copyright?: string;
|
|
455
|
+
/**
|
|
456
|
+
* Logo to be displayed inside the footer
|
|
457
|
+
*/
|
|
458
|
+
logo?: Logo;
|
|
459
|
+
/**
|
|
460
|
+
* Size of the top margin to be applied to the footer.
|
|
461
|
+
*/
|
|
462
|
+
margin?: Space$1;
|
|
463
|
+
/**
|
|
464
|
+
* Determines the visual style and layout
|
|
465
|
+
* - "default": The default mode with full content and styling.
|
|
466
|
+
* - "reduced": A reduced mode with minimal content and styling.
|
|
467
|
+
*/
|
|
468
|
+
mode?: "default" | "reduced";
|
|
469
|
+
/**
|
|
470
|
+
* An array of objects representing the links that will be rendered as
|
|
471
|
+
* icons at the top-right side of the footer.
|
|
472
|
+
*/
|
|
473
|
+
socialLinks?: SocialLink[];
|
|
474
|
+
/**
|
|
475
|
+
* Value of the tabindex for all interactive elements, except those
|
|
476
|
+
* inside the custom area.
|
|
477
|
+
*/
|
|
478
|
+
tabIndex?: number;
|
|
479
|
+
};
|
|
480
|
+
|
|
426
481
|
type AppLayoutMainPropsType = {
|
|
427
482
|
/**
|
|
428
483
|
* Everything between the tags will be displayed as the content of the main part of the application.
|
|
429
484
|
*/
|
|
430
|
-
children:
|
|
485
|
+
children: ReactNode;
|
|
431
486
|
};
|
|
432
|
-
type
|
|
487
|
+
type ApplicationLayoutPropsType = {
|
|
433
488
|
/**
|
|
434
489
|
* Text to be placed next to the hamburger button that toggles the
|
|
435
490
|
* visibility of the sidenav.
|
|
@@ -438,40 +493,39 @@ type AppLayoutPropsType = {
|
|
|
438
493
|
/**
|
|
439
494
|
* Header content.
|
|
440
495
|
*/
|
|
441
|
-
header?:
|
|
496
|
+
header?: ReactNode;
|
|
442
497
|
/**
|
|
443
498
|
* Sidenav content
|
|
444
499
|
*/
|
|
445
|
-
sidenav?:
|
|
500
|
+
sidenav?: ReactNode;
|
|
446
501
|
/**
|
|
447
502
|
* Footer content
|
|
448
503
|
*/
|
|
449
|
-
footer?:
|
|
504
|
+
footer?: ReactNode;
|
|
450
505
|
/**
|
|
451
506
|
* Use the DxcApplicationLayout.Main provided to render main content.
|
|
452
507
|
*/
|
|
453
|
-
children:
|
|
508
|
+
children: ReactElement<AppLayoutMainPropsType>;
|
|
454
509
|
};
|
|
455
510
|
|
|
456
511
|
declare const DxcApplicationLayout: {
|
|
457
|
-
({ visibilityToggleLabel, header, sidenav, footer, children, }:
|
|
512
|
+
({ visibilityToggleLabel, header, sidenav, footer, children, }: ApplicationLayoutPropsType): JSX.Element;
|
|
513
|
+
Footer: ({ bottomLinks, children, copyright, logo, margin, mode, socialLinks, tabIndex, }: FooterPropsType) => JSX.Element;
|
|
458
514
|
Header: {
|
|
459
|
-
({ underlined, content, responsiveContent,
|
|
460
|
-
Dropdown: (props: react.ComponentProps<({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, }: Props$
|
|
515
|
+
({ underlined, content, responsiveContent, logo, margin, onClick, tabIndex, }: Props$E): JSX.Element;
|
|
516
|
+
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;
|
|
461
517
|
};
|
|
462
518
|
Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
|
|
463
|
-
Footer: ({ socialLinks, bottomLinks, copyright, children, margin, tabIndex, mode, }: FooterPropsType) => JSX.Element;
|
|
464
519
|
SideNav: {
|
|
465
|
-
({ title, children }: Props$
|
|
520
|
+
({ title, children }: Props$G): JSX.Element;
|
|
466
521
|
Section: ({ children }: SidenavSectionPropsType) => JSX.Element;
|
|
467
522
|
Group: ({ title, collapsable, icon, children }: SidenavGroupPropsType) => JSX.Element;
|
|
468
523
|
Link: react.ForwardRefExoticComponent<SidenavLinkPropsType & react.RefAttributes<HTMLAnchorElement>>;
|
|
469
524
|
Title: ({ children }: SidenavTitlePropsType) => JSX.Element;
|
|
470
525
|
};
|
|
471
|
-
useResponsiveSidenavVisibility: () => (
|
|
526
|
+
useResponsiveSidenavVisibility: () => ((_isSidenavVisible: boolean) => void) | null;
|
|
472
527
|
};
|
|
473
528
|
|
|
474
|
-
type SVG$d = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
475
529
|
type ContextualProps = {
|
|
476
530
|
/**
|
|
477
531
|
* Text to be placed in the badge.
|
|
@@ -508,7 +562,7 @@ type NotificationProps = {
|
|
|
508
562
|
*/
|
|
509
563
|
color?: never;
|
|
510
564
|
};
|
|
511
|
-
type CommonProps$
|
|
565
|
+
type CommonProps$7 = {
|
|
512
566
|
/**
|
|
513
567
|
* Text representing advisory information related to the badge. Under the hood, this prop also serves as an accessible label for the component.
|
|
514
568
|
*/
|
|
@@ -516,89 +570,52 @@ type CommonProps$5 = {
|
|
|
516
570
|
/**
|
|
517
571
|
* Material Symbol name or SVG element used as the icon that will be placed next to the badge label in contextual mode.
|
|
518
572
|
*/
|
|
519
|
-
icon?: string | SVG
|
|
573
|
+
icon?: string | SVG;
|
|
520
574
|
/**
|
|
521
575
|
* Size of the component.
|
|
522
576
|
*/
|
|
523
577
|
size?: "small" | "medium" | "large";
|
|
524
578
|
};
|
|
525
|
-
type Props$
|
|
579
|
+
type Props$D = (ContextualProps | NotificationProps) & CommonProps$7;
|
|
526
580
|
|
|
527
|
-
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$
|
|
581
|
+
declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: Props$D) => JSX.Element;
|
|
528
582
|
|
|
529
|
-
type
|
|
530
|
-
type Props$D = {
|
|
583
|
+
type Props$C = {
|
|
531
584
|
/**
|
|
532
585
|
* Applies the spacing scale to all sides.
|
|
533
586
|
*/
|
|
534
|
-
space?:
|
|
587
|
+
space?: string;
|
|
535
588
|
/**
|
|
536
589
|
* Applies the spacing scale to the left and right sides.
|
|
537
590
|
*/
|
|
538
|
-
horizontal?:
|
|
591
|
+
horizontal?: string;
|
|
539
592
|
/**
|
|
540
593
|
* Applies the spacing scale to the top and bottom sides.
|
|
541
594
|
*/
|
|
542
|
-
vertical?:
|
|
595
|
+
vertical?: string;
|
|
543
596
|
/**
|
|
544
597
|
* Applies the spacing scale to the top side.
|
|
545
598
|
*/
|
|
546
|
-
top?:
|
|
599
|
+
top?: string;
|
|
547
600
|
/**
|
|
548
601
|
* Applies the spacing scale to the right side.
|
|
549
602
|
*/
|
|
550
|
-
right?:
|
|
603
|
+
right?: string;
|
|
551
604
|
/**
|
|
552
605
|
* Applies the spacing scale to the bottom side.
|
|
553
606
|
*/
|
|
554
|
-
bottom?:
|
|
607
|
+
bottom?: string;
|
|
555
608
|
/**
|
|
556
609
|
* Applies the spacing scale to the left side.
|
|
557
610
|
*/
|
|
558
|
-
left?:
|
|
611
|
+
left?: string;
|
|
559
612
|
/**
|
|
560
613
|
* Custom content inside the bleed.
|
|
561
614
|
*/
|
|
562
|
-
children:
|
|
615
|
+
children: ReactNode;
|
|
563
616
|
};
|
|
564
617
|
|
|
565
|
-
declare function
|
|
566
|
-
|
|
567
|
-
type Space$o = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
568
|
-
type Margin$l = {
|
|
569
|
-
top?: Space$o;
|
|
570
|
-
bottom?: Space$o;
|
|
571
|
-
left?: Space$o;
|
|
572
|
-
right?: Space$o;
|
|
573
|
-
};
|
|
574
|
-
type Props$C = {
|
|
575
|
-
/**
|
|
576
|
-
* The size of the shadow to be displayed around the box.
|
|
577
|
-
*/
|
|
578
|
-
shadowDepth?: 0 | 1 | 2;
|
|
579
|
-
/**
|
|
580
|
-
* Changes the display CSS property of the box div.
|
|
581
|
-
*/
|
|
582
|
-
display?: string;
|
|
583
|
-
/**
|
|
584
|
-
* Custom content that will be placed in the box component.
|
|
585
|
-
*/
|
|
586
|
-
children: React.ReactNode;
|
|
587
|
-
/**
|
|
588
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
589
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
590
|
-
*/
|
|
591
|
-
margin?: Space$o | Margin$l;
|
|
592
|
-
/**
|
|
593
|
-
* Size of the component.
|
|
594
|
-
*/
|
|
595
|
-
size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
596
|
-
};
|
|
597
|
-
|
|
598
|
-
/**
|
|
599
|
-
* @deprecated
|
|
600
|
-
*/
|
|
601
|
-
declare const DxcBox: ({ shadowDepth, display, children, margin, size, }: Props$C) => JSX.Element;
|
|
618
|
+
declare function DxcBleed({ space, horizontal, vertical, top, right, bottom, left, children }: Props$C): react_jsx_runtime.JSX.Element;
|
|
602
619
|
|
|
603
620
|
type Item$1 = {
|
|
604
621
|
href?: string;
|
|
@@ -638,7 +655,6 @@ type Props$B = {
|
|
|
638
655
|
|
|
639
656
|
declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: Props$B) => react_jsx_runtime.JSX.Element;
|
|
640
657
|
|
|
641
|
-
type SVG$c = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
642
658
|
type IconProps = {
|
|
643
659
|
/**
|
|
644
660
|
* Defines the style of the bullet point in the list.
|
|
@@ -647,11 +663,11 @@ type IconProps = {
|
|
|
647
663
|
/**
|
|
648
664
|
* Icon to display as bullet.
|
|
649
665
|
*/
|
|
650
|
-
icon: string | SVG
|
|
666
|
+
icon: string | SVG;
|
|
651
667
|
/**
|
|
652
668
|
* Text to be shown in the list.
|
|
653
669
|
*/
|
|
654
|
-
children:
|
|
670
|
+
children: ReactNode;
|
|
655
671
|
};
|
|
656
672
|
type OtherProps = {
|
|
657
673
|
/**
|
|
@@ -665,7 +681,7 @@ type OtherProps = {
|
|
|
665
681
|
/**
|
|
666
682
|
* Text to be shown in the list.
|
|
667
683
|
*/
|
|
668
|
-
children:
|
|
684
|
+
children: ReactNode;
|
|
669
685
|
};
|
|
670
686
|
type Props$A = IconProps | OtherProps;
|
|
671
687
|
|
|
@@ -673,7 +689,7 @@ type BulletedListItemPropsType = {
|
|
|
673
689
|
/**
|
|
674
690
|
* Text to be shown in the list.
|
|
675
691
|
*/
|
|
676
|
-
children?:
|
|
692
|
+
children?: ReactNode;
|
|
677
693
|
};
|
|
678
694
|
|
|
679
695
|
declare const DxcBulletedList: {
|
|
@@ -681,17 +697,11 @@ declare const DxcBulletedList: {
|
|
|
681
697
|
Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
|
|
682
698
|
};
|
|
683
699
|
|
|
684
|
-
type
|
|
685
|
-
type
|
|
686
|
-
top?: Space$n;
|
|
687
|
-
bottom?: Space$n;
|
|
688
|
-
left?: Space$n;
|
|
689
|
-
right?: Space$n;
|
|
690
|
-
};
|
|
691
|
-
type SVG$b = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
700
|
+
type Semantic = "default" | "error" | "warning" | "success" | "info";
|
|
701
|
+
type Mode$1 = "primary" | "secondary" | "tertiary";
|
|
692
702
|
type Size$3 = {
|
|
693
703
|
/**
|
|
694
|
-
* Height of the
|
|
704
|
+
* Height of the button.
|
|
695
705
|
*/
|
|
696
706
|
height?: "small" | "medium" | "large";
|
|
697
707
|
width?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
@@ -704,11 +714,11 @@ type Props$z = {
|
|
|
704
714
|
/**
|
|
705
715
|
* The available button modes.
|
|
706
716
|
*/
|
|
707
|
-
mode?:
|
|
717
|
+
mode?: Mode$1;
|
|
708
718
|
/**
|
|
709
719
|
* Specifies the semantic meaning of the buttons, which determines its color.
|
|
710
720
|
*/
|
|
711
|
-
semantic?:
|
|
721
|
+
semantic?: Semantic;
|
|
712
722
|
/**
|
|
713
723
|
* If true, the component will be disabled.
|
|
714
724
|
*/
|
|
@@ -728,7 +738,7 @@ type Props$z = {
|
|
|
728
738
|
/**
|
|
729
739
|
* Material Symbol name or SVG element as the icon that will be placed next to the label.
|
|
730
740
|
*/
|
|
731
|
-
icon?: string | SVG
|
|
741
|
+
icon?: string | SVG;
|
|
732
742
|
/**
|
|
733
743
|
* This function will be called when the user clicks the button.
|
|
734
744
|
*/
|
|
@@ -737,7 +747,7 @@ type Props$z = {
|
|
|
737
747
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
738
748
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
739
749
|
*/
|
|
740
|
-
margin?: Space$
|
|
750
|
+
margin?: Space$1 | Margin;
|
|
741
751
|
/**
|
|
742
752
|
* Size of the component.
|
|
743
753
|
*/
|
|
@@ -748,14 +758,13 @@ type Props$z = {
|
|
|
748
758
|
tabIndex?: number;
|
|
749
759
|
};
|
|
750
760
|
|
|
751
|
-
declare const DxcButton: ({
|
|
761
|
+
declare const DxcButton: ({ disabled, icon, iconPosition, label, margin, mode, onClick, semantic, size, tabIndex, title, type, }: Props$z) => JSX.Element;
|
|
752
762
|
|
|
753
|
-
type Space$m = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
754
763
|
type Size$2 = {
|
|
755
|
-
top?: Space$
|
|
756
|
-
bottom?: Space$
|
|
757
|
-
left?: Space$
|
|
758
|
-
right?: Space$
|
|
764
|
+
top?: Space$1;
|
|
765
|
+
bottom?: Space$1;
|
|
766
|
+
left?: Space$1;
|
|
767
|
+
right?: Space$1;
|
|
759
768
|
};
|
|
760
769
|
type Props$y = {
|
|
761
770
|
/**
|
|
@@ -773,7 +782,7 @@ type Props$y = {
|
|
|
773
782
|
* component. You can pass an object with 'top', 'bottom', 'left'
|
|
774
783
|
* and 'right' properties in order to specify different padding sizes.
|
|
775
784
|
*/
|
|
776
|
-
imagePadding?: Space$
|
|
785
|
+
imagePadding?: Space$1 | Size$2;
|
|
777
786
|
/**
|
|
778
787
|
* Whether the image should appear in relation to the content.
|
|
779
788
|
*/
|
|
@@ -796,7 +805,7 @@ type Props$y = {
|
|
|
796
805
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
797
806
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
798
807
|
*/
|
|
799
|
-
margin?: Space$
|
|
808
|
+
margin?: Space$1 | Size$2;
|
|
800
809
|
/**
|
|
801
810
|
* Value of the tabindex attribute applied when the component is clickable.
|
|
802
811
|
*/
|
|
@@ -808,33 +817,29 @@ type Props$y = {
|
|
|
808
817
|
/**
|
|
809
818
|
* Custom content that will be placed inside the component.
|
|
810
819
|
*/
|
|
811
|
-
children?:
|
|
820
|
+
children?: ReactNode;
|
|
812
821
|
};
|
|
813
822
|
|
|
814
|
-
declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$y) => JSX.Element;
|
|
823
|
+
declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: Props$y) => react_jsx_runtime.JSX.Element;
|
|
815
824
|
|
|
816
|
-
type Space$l = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
817
|
-
type Margin$j = {
|
|
818
|
-
top?: Space$l;
|
|
819
|
-
bottom?: Space$l;
|
|
820
|
-
left?: Space$l;
|
|
821
|
-
right?: Space$l;
|
|
822
|
-
};
|
|
823
825
|
type Props$x = {
|
|
824
826
|
/**
|
|
825
|
-
*
|
|
827
|
+
* Specifies a string to be used as the name for the checkbox element when no `label` is provided.
|
|
826
828
|
*/
|
|
827
|
-
|
|
829
|
+
ariaLabel?: string;
|
|
828
830
|
/**
|
|
829
831
|
* If true, the component is checked. If undefined the component will be
|
|
830
832
|
* uncontrolled and the value will be managed internally by the component.
|
|
831
833
|
*/
|
|
832
834
|
checked?: boolean;
|
|
833
835
|
/**
|
|
834
|
-
*
|
|
835
|
-
* When inside a form, this value will be only submitted if the checkbox is checked.
|
|
836
|
+
* Initial state of the checkbox, only when it is uncontrolled.
|
|
836
837
|
*/
|
|
837
|
-
|
|
838
|
+
defaultChecked?: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* If true, the component will be disabled.
|
|
841
|
+
*/
|
|
842
|
+
disabled?: boolean;
|
|
838
843
|
/**
|
|
839
844
|
* Text to be placed next to the checkbox.
|
|
840
845
|
*/
|
|
@@ -843,14 +848,22 @@ type Props$x = {
|
|
|
843
848
|
* Whether the label should appear after or before the checkbox.
|
|
844
849
|
*/
|
|
845
850
|
labelPosition?: "before" | "after";
|
|
851
|
+
/**
|
|
852
|
+
* Size of the margin to be applied to the component
|
|
853
|
+
* ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
854
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
855
|
+
* in order to specify different margin sizes.
|
|
856
|
+
*/
|
|
857
|
+
margin?: Space$1 | Margin;
|
|
846
858
|
/**
|
|
847
859
|
* Name attribute of the input element.
|
|
848
860
|
*/
|
|
849
861
|
name?: string;
|
|
850
862
|
/**
|
|
851
|
-
*
|
|
863
|
+
* This function will be called when the user clicks the checkbox.
|
|
864
|
+
* The new value will be passed as a parameter.
|
|
852
865
|
*/
|
|
853
|
-
|
|
866
|
+
onChange?: (value: boolean) => void;
|
|
854
867
|
/**
|
|
855
868
|
* If true, the component will display '(Optional)' next to the label.
|
|
856
869
|
*/
|
|
@@ -859,18 +872,6 @@ type Props$x = {
|
|
|
859
872
|
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
860
873
|
*/
|
|
861
874
|
readOnly?: boolean;
|
|
862
|
-
/**
|
|
863
|
-
* This function will be called when the user clicks the checkbox.
|
|
864
|
-
* The new value will be passed as a parameter.
|
|
865
|
-
*/
|
|
866
|
-
onChange?: (value: boolean) => void;
|
|
867
|
-
/**
|
|
868
|
-
* Size of the margin to be applied to the component
|
|
869
|
-
* ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
870
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
871
|
-
* in order to specify different margin sizes.
|
|
872
|
-
*/
|
|
873
|
-
margin?: Space$l | Margin$j;
|
|
874
875
|
/**
|
|
875
876
|
* Size of the component.
|
|
876
877
|
*/
|
|
@@ -879,18 +880,15 @@ type Props$x = {
|
|
|
879
880
|
* Value of the tabindex.
|
|
880
881
|
*/
|
|
881
882
|
tabIndex?: number;
|
|
883
|
+
/**
|
|
884
|
+
* Will be passed to the value attribute of the html input element.
|
|
885
|
+
* When inside a form, this value will be only submitted if the checkbox is checked.
|
|
886
|
+
*/
|
|
887
|
+
value?: string;
|
|
882
888
|
};
|
|
883
889
|
|
|
884
890
|
declare const DxcCheckbox: react.ForwardRefExoticComponent<Props$x & react.RefAttributes<HTMLDivElement>>;
|
|
885
891
|
|
|
886
|
-
type Space$k = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
887
|
-
type Margin$i = {
|
|
888
|
-
top?: Space$k;
|
|
889
|
-
bottom?: Space$k;
|
|
890
|
-
left?: Space$k;
|
|
891
|
-
right?: Space$k;
|
|
892
|
-
};
|
|
893
|
-
type SVG$a = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
894
892
|
type Props$w = {
|
|
895
893
|
/**
|
|
896
894
|
* Text to be placed on the chip.
|
|
@@ -899,11 +897,11 @@ type Props$w = {
|
|
|
899
897
|
/**
|
|
900
898
|
* Element or path used as icon to be placed after the chip label.
|
|
901
899
|
*/
|
|
902
|
-
suffixIcon?: string | SVG
|
|
900
|
+
suffixIcon?: string | SVG;
|
|
903
901
|
/**
|
|
904
902
|
* Element or path used as icon to be placed before the chip label.
|
|
905
903
|
*/
|
|
906
|
-
prefixIcon?: string | SVG
|
|
904
|
+
prefixIcon?: string | SVG;
|
|
907
905
|
/**
|
|
908
906
|
* This function will be called when the suffix is clicked.
|
|
909
907
|
*/
|
|
@@ -920,114 +918,22 @@ type Props$w = {
|
|
|
920
918
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
921
919
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
922
920
|
*/
|
|
923
|
-
margin?: Space$
|
|
921
|
+
margin?: Space$1 | Margin;
|
|
924
922
|
/**
|
|
925
923
|
* Value of the tabindex attribute.
|
|
926
924
|
*/
|
|
927
925
|
tabIndex?: number;
|
|
928
926
|
};
|
|
929
927
|
|
|
930
|
-
declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: Props$w) => JSX.Element;
|
|
928
|
+
declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: Props$w) => react_jsx_runtime.JSX.Element;
|
|
931
929
|
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
color_transparent: string;
|
|
940
|
-
color_grey_50: string;
|
|
941
|
-
color_grey_100: string;
|
|
942
|
-
color_grey_200: string;
|
|
943
|
-
color_grey_300: string;
|
|
944
|
-
color_grey_400: string;
|
|
945
|
-
color_grey_500: string;
|
|
946
|
-
color_grey_600: string;
|
|
947
|
-
color_grey_700: string;
|
|
948
|
-
color_grey_800: string;
|
|
949
|
-
color_grey_900: string;
|
|
950
|
-
color_grey_50_a: string;
|
|
951
|
-
color_grey_100_a: string;
|
|
952
|
-
color_grey_200_a: string;
|
|
953
|
-
color_grey_300_a: string;
|
|
954
|
-
color_grey_400_a: string;
|
|
955
|
-
color_grey_500_a: string;
|
|
956
|
-
color_grey_600_a: string;
|
|
957
|
-
color_grey_700_a: string;
|
|
958
|
-
color_grey_800_a: string;
|
|
959
|
-
color_grey_900_a: string;
|
|
960
|
-
color_purple_50: string;
|
|
961
|
-
color_purple_100: string;
|
|
962
|
-
color_purple_200: string;
|
|
963
|
-
color_purple_300: string;
|
|
964
|
-
color_purple_400: string;
|
|
965
|
-
color_purple_500: string;
|
|
966
|
-
color_purple_600: string;
|
|
967
|
-
color_purple_700: string;
|
|
968
|
-
color_purple_800: string;
|
|
969
|
-
color_purple_900: string;
|
|
970
|
-
color_blue_50: string;
|
|
971
|
-
color_blue_100: string;
|
|
972
|
-
color_blue_200: string;
|
|
973
|
-
color_blue_300: string;
|
|
974
|
-
color_blue_400: string;
|
|
975
|
-
color_blue_500: string;
|
|
976
|
-
color_blue_600: string;
|
|
977
|
-
color_blue_700: string;
|
|
978
|
-
color_blue_800: string;
|
|
979
|
-
color_blue_900: string;
|
|
980
|
-
color_red_50: string;
|
|
981
|
-
color_red_100: string;
|
|
982
|
-
color_red_200: string;
|
|
983
|
-
color_red_300: string;
|
|
984
|
-
color_red_400: string;
|
|
985
|
-
color_red_500: string;
|
|
986
|
-
color_red_600: string;
|
|
987
|
-
color_red_700: string;
|
|
988
|
-
color_red_800: string;
|
|
989
|
-
color_red_900: string;
|
|
990
|
-
color_green_50: string;
|
|
991
|
-
color_green_100: string;
|
|
992
|
-
color_green_200: string;
|
|
993
|
-
color_green_300: string;
|
|
994
|
-
color_green_400: string;
|
|
995
|
-
color_green_500: string;
|
|
996
|
-
color_green_600: string;
|
|
997
|
-
color_green_700: string;
|
|
998
|
-
color_green_800: string;
|
|
999
|
-
color_green_900: string;
|
|
1000
|
-
color_yellow_50: string;
|
|
1001
|
-
color_yellow_100: string;
|
|
1002
|
-
color_yellow_200: string;
|
|
1003
|
-
color_yellow_300: string;
|
|
1004
|
-
color_yellow_400: string;
|
|
1005
|
-
color_yellow_500: string;
|
|
1006
|
-
color_yellow_600: string;
|
|
1007
|
-
color_yellow_700: string;
|
|
1008
|
-
color_yellow_800: string;
|
|
1009
|
-
color_yellow_900: string;
|
|
1010
|
-
color_orange_50: string;
|
|
1011
|
-
color_orange_100: string;
|
|
1012
|
-
color_orange_200: string;
|
|
1013
|
-
color_orange_300: string;
|
|
1014
|
-
color_orange_400: string;
|
|
1015
|
-
color_orange_500: string;
|
|
1016
|
-
color_orange_600: string;
|
|
1017
|
-
color_orange_700: string;
|
|
1018
|
-
color_orange_800: string;
|
|
1019
|
-
color_orange_900: string;
|
|
1020
|
-
};
|
|
1021
|
-
type CoreColorTokensType = keyof typeof CoreColorTokens;
|
|
1022
|
-
|
|
1023
|
-
type SpacingValues = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
1024
|
-
type Space$j = SpacingValues | {
|
|
1025
|
-
top?: SpacingValues;
|
|
1026
|
-
right?: SpacingValues;
|
|
1027
|
-
bottom?: SpacingValues;
|
|
1028
|
-
left?: SpacingValues;
|
|
1029
|
-
};
|
|
1030
|
-
type Inset$1 = {
|
|
930
|
+
type Space = {
|
|
931
|
+
top?: string;
|
|
932
|
+
right?: string;
|
|
933
|
+
bottom?: string;
|
|
934
|
+
left?: string;
|
|
935
|
+
};
|
|
936
|
+
type Inset = {
|
|
1031
937
|
top?: string;
|
|
1032
938
|
right?: string;
|
|
1033
939
|
bottom?: string;
|
|
@@ -1036,7 +942,7 @@ type Inset$1 = {
|
|
|
1036
942
|
type Background = {
|
|
1037
943
|
attachment?: string;
|
|
1038
944
|
clip?: string;
|
|
1039
|
-
color?:
|
|
945
|
+
color?: string;
|
|
1040
946
|
image?: string;
|
|
1041
947
|
origin?: string;
|
|
1042
948
|
position?: string;
|
|
@@ -1045,8 +951,8 @@ type Background = {
|
|
|
1045
951
|
};
|
|
1046
952
|
type BorderProperties = {
|
|
1047
953
|
width?: string;
|
|
1048
|
-
style?:
|
|
1049
|
-
color?:
|
|
954
|
+
style?: string;
|
|
955
|
+
color?: string;
|
|
1050
956
|
};
|
|
1051
957
|
type Border = BorderProperties | {
|
|
1052
958
|
top?: BorderProperties;
|
|
@@ -1094,7 +1000,7 @@ type Props$v = {
|
|
|
1094
1000
|
/**
|
|
1095
1001
|
* Custom content inside the container.
|
|
1096
1002
|
*/
|
|
1097
|
-
children
|
|
1003
|
+
children?: ReactNode;
|
|
1098
1004
|
/**
|
|
1099
1005
|
* Sets the display CSS property.
|
|
1100
1006
|
* The set of values is limited to the ones related to the outer display type.
|
|
@@ -1120,13 +1026,17 @@ type Props$v = {
|
|
|
1120
1026
|
* Based on the CSS property inset this prop is a shorthand that corresponds
|
|
1121
1027
|
* to the top, right, bottom, and/or left properties.
|
|
1122
1028
|
*/
|
|
1123
|
-
inset?: Inset
|
|
1029
|
+
inset?: Inset;
|
|
1124
1030
|
/**
|
|
1125
|
-
* Size of the margin to be applied to the
|
|
1126
|
-
|
|
1127
|
-
|
|
1031
|
+
* Size of the margin to be applied to the container.
|
|
1032
|
+
*/
|
|
1033
|
+
margin?: string | Space;
|
|
1034
|
+
/**
|
|
1035
|
+
* Sets the max-width CSS property.
|
|
1036
|
+
*
|
|
1037
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/max-width
|
|
1128
1038
|
*/
|
|
1129
|
-
|
|
1039
|
+
maxHeight?: string;
|
|
1130
1040
|
/**
|
|
1131
1041
|
* Sets the max-height CSS property.
|
|
1132
1042
|
*
|
|
@@ -1134,11 +1044,11 @@ type Props$v = {
|
|
|
1134
1044
|
*/
|
|
1135
1045
|
maxWidth?: string;
|
|
1136
1046
|
/**
|
|
1137
|
-
* Sets the
|
|
1047
|
+
* Sets the min-width CSS property.
|
|
1138
1048
|
*
|
|
1139
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/
|
|
1049
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/min-width
|
|
1140
1050
|
*/
|
|
1141
|
-
|
|
1051
|
+
minHeight?: string;
|
|
1142
1052
|
/**
|
|
1143
1053
|
* Sets the min-height CSS property.
|
|
1144
1054
|
*
|
|
@@ -1146,85 +1056,308 @@ type Props$v = {
|
|
|
1146
1056
|
*/
|
|
1147
1057
|
minWidth?: string;
|
|
1148
1058
|
/**
|
|
1149
|
-
*
|
|
1059
|
+
* Based on the CSS property outline allows configuring all properties related
|
|
1060
|
+
* to the outline of a container.
|
|
1061
|
+
*/
|
|
1062
|
+
outline?: Outline;
|
|
1063
|
+
/**
|
|
1064
|
+
* Sets the overflow CSS property.
|
|
1150
1065
|
*
|
|
1151
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/
|
|
1066
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
|
|
1152
1067
|
*/
|
|
1153
|
-
|
|
1068
|
+
overflow?: Overflow;
|
|
1069
|
+
/**
|
|
1070
|
+
* Size of the padding to be applied to the container.
|
|
1071
|
+
*/
|
|
1072
|
+
padding?: string | Space;
|
|
1073
|
+
/**
|
|
1074
|
+
* Sets the position CSS property.
|
|
1075
|
+
*
|
|
1076
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/position
|
|
1077
|
+
*/
|
|
1078
|
+
position?: "static" | "relative" | "absolute" | "fixed" | "sticky";
|
|
1079
|
+
/**
|
|
1080
|
+
* Sets the width CSS property.
|
|
1081
|
+
*
|
|
1082
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/width
|
|
1083
|
+
*/
|
|
1084
|
+
width?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* Sets the z-index CSS property.
|
|
1087
|
+
*
|
|
1088
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/z-index
|
|
1089
|
+
*/
|
|
1090
|
+
zIndex?: "auto" | number;
|
|
1091
|
+
};
|
|
1092
|
+
|
|
1093
|
+
declare function DxcContainer({ display, width, height, overflow, ...props }: Props$v): react_jsx_runtime.JSX.Element;
|
|
1094
|
+
|
|
1095
|
+
type CommonItemProps = {
|
|
1096
|
+
badge?: ReactElement;
|
|
1097
|
+
icon?: string | SVG;
|
|
1098
|
+
label: string;
|
|
1099
|
+
};
|
|
1100
|
+
type Item = CommonItemProps & {
|
|
1101
|
+
onSelect?: () => void;
|
|
1102
|
+
selectedByDefault?: boolean;
|
|
1103
|
+
};
|
|
1104
|
+
type GroupItem = CommonItemProps & {
|
|
1105
|
+
items: (Item | GroupItem)[];
|
|
1106
|
+
};
|
|
1107
|
+
type Section = {
|
|
1108
|
+
items: (Item | GroupItem)[];
|
|
1109
|
+
title?: string;
|
|
1110
|
+
};
|
|
1111
|
+
type Props$u = {
|
|
1112
|
+
/**
|
|
1113
|
+
* Array of items to be displayed in the Contextual menu.
|
|
1114
|
+
* Each item can be a single/simple item, a group item or a section.
|
|
1115
|
+
*/
|
|
1116
|
+
items: (Item | GroupItem)[] | Section[];
|
|
1117
|
+
};
|
|
1118
|
+
|
|
1119
|
+
declare function DxcContextualMenu({ items }: Props$u): react_jsx_runtime.JSX.Element;
|
|
1120
|
+
|
|
1121
|
+
type BaseActionCell = {
|
|
1122
|
+
disabled?: boolean;
|
|
1123
|
+
tabIndex?: number;
|
|
1124
|
+
title: string;
|
|
1125
|
+
};
|
|
1126
|
+
type ActionCell = BaseActionCell & ({
|
|
1127
|
+
icon: string | SVG;
|
|
1128
|
+
onClick: () => void;
|
|
1129
|
+
options?: never;
|
|
1130
|
+
} | {
|
|
1131
|
+
icon?: never;
|
|
1132
|
+
onClick: (value?: string) => void;
|
|
1133
|
+
options: Option$2[];
|
|
1134
|
+
});
|
|
1135
|
+
type ActionsCellPropsType = {
|
|
1136
|
+
/**
|
|
1137
|
+
* It represents a list of interactive elements that will work as buttons or as a dropdown. Those with an icon from Material Symbols
|
|
1138
|
+
* or a SVG are treated as buttons. If any element lacks an icon and includes options, it is interpreted as a dropdown.
|
|
1139
|
+
* Only the first action with options will be displayed and only up to 3 actions.
|
|
1140
|
+
* In the case of the dropdown the click function will pass the value assigned to the option.
|
|
1141
|
+
*/
|
|
1142
|
+
actions: ActionCell[];
|
|
1143
|
+
};
|
|
1144
|
+
type Props$t = {
|
|
1145
|
+
/**
|
|
1146
|
+
* The center section of the table. Can be used to render custom
|
|
1147
|
+
* content in this area.
|
|
1148
|
+
*/
|
|
1149
|
+
children: ReactNode;
|
|
1150
|
+
/**
|
|
1151
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1152
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1153
|
+
*/
|
|
1154
|
+
margin?: Space$1 | Margin;
|
|
1155
|
+
/**
|
|
1156
|
+
* Determines the visual style and layout
|
|
1157
|
+
* - "default": Default table size.
|
|
1158
|
+
* - "reduced": More compact table with less spacing for high density information.
|
|
1159
|
+
*/
|
|
1160
|
+
mode?: "default" | "reduced";
|
|
1161
|
+
};
|
|
1162
|
+
|
|
1163
|
+
type GridColumn = {
|
|
1164
|
+
/**
|
|
1165
|
+
* Key that will be rendered from each row in rows.
|
|
1166
|
+
*/
|
|
1167
|
+
key: string;
|
|
1168
|
+
/**
|
|
1169
|
+
* Label that will be used for the column header.
|
|
1170
|
+
*/
|
|
1171
|
+
label: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Whether the column is resizable or not.
|
|
1174
|
+
*/
|
|
1175
|
+
resizable?: boolean;
|
|
1176
|
+
/**
|
|
1177
|
+
* Whether the column is sortable or not.
|
|
1178
|
+
*/
|
|
1179
|
+
sortable?: boolean;
|
|
1180
|
+
/**
|
|
1181
|
+
* Custom criteria for sorting the column.
|
|
1182
|
+
*/
|
|
1183
|
+
sortFn?: (_a: ReactNode, _b: ReactNode) => 0 | 1 | -1;
|
|
1184
|
+
/**
|
|
1185
|
+
* Whether the column is draggable or not.
|
|
1186
|
+
*/
|
|
1187
|
+
draggable?: boolean;
|
|
1188
|
+
/**
|
|
1189
|
+
* Whether the column cells are editable or not.
|
|
1190
|
+
*/
|
|
1191
|
+
textEditable?: boolean;
|
|
1192
|
+
/**
|
|
1193
|
+
* Value that will be rendered from the summaryRow.
|
|
1194
|
+
*/
|
|
1195
|
+
summaryKey?: string;
|
|
1196
|
+
/**
|
|
1197
|
+
* Sets the alignment inside the cells.
|
|
1198
|
+
*/
|
|
1199
|
+
alignment?: "left" | "right" | "center";
|
|
1200
|
+
};
|
|
1201
|
+
type GridRow = {
|
|
1202
|
+
/**
|
|
1203
|
+
* List of rows that will be rendered in each cell based on the key in each column.
|
|
1204
|
+
*/
|
|
1205
|
+
[key: string]: ReactNode | undefined;
|
|
1206
|
+
};
|
|
1207
|
+
type HierarchyGridRow = GridRow & {
|
|
1208
|
+
childRows?: HierarchyGridRow[] | GridRow[];
|
|
1209
|
+
};
|
|
1210
|
+
type ExpandableGridRow = GridRow & {
|
|
1211
|
+
expandedContent?: ReactNode;
|
|
1212
|
+
expandedContentHeight?: number;
|
|
1213
|
+
contentIsExpanded?: boolean;
|
|
1214
|
+
};
|
|
1215
|
+
type ExpandableRows = {
|
|
1216
|
+
rows: ExpandableGridRow[];
|
|
1217
|
+
/**
|
|
1218
|
+
* Whether the rows can expand or not.
|
|
1219
|
+
*/
|
|
1220
|
+
expandable: true;
|
|
1221
|
+
/**
|
|
1222
|
+
* This prop indicates the unique key that can be used to identify each row. This prop is mandatory if selectable is set to true, expandable is set to true or rows is of type HierarchyGridRow[].
|
|
1223
|
+
*/
|
|
1224
|
+
uniqueRowId: string;
|
|
1225
|
+
};
|
|
1226
|
+
type HierarchyRows = {
|
|
1227
|
+
rows: HierarchyGridRow[];
|
|
1228
|
+
/**
|
|
1229
|
+
* This prop indicates the unique key that can be used to identify each row. This prop is mandatory if selectable is set to true, expandable is set to true or rows is of type HierarchyGridRow[].
|
|
1230
|
+
*/
|
|
1231
|
+
uniqueRowId: string;
|
|
1232
|
+
/**
|
|
1233
|
+
* Whether the rows can expand or not.
|
|
1234
|
+
*/
|
|
1235
|
+
expandable?: false;
|
|
1236
|
+
};
|
|
1237
|
+
type SelectableGridProps = {
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether the rows are selectable or not.
|
|
1240
|
+
*/
|
|
1241
|
+
selectable: true;
|
|
1242
|
+
/**
|
|
1243
|
+
* Set of selected rows. This prop is mandatory if selectable is set to true. The uniqueRowId key will be used to identify the each row.
|
|
1244
|
+
*/
|
|
1245
|
+
selectedRows: Set<string | number>;
|
|
1246
|
+
/**
|
|
1247
|
+
* Function called whenever the selected values changes. This prop is mandatory if selectable is set to true.The uniqueRowId key will be used to identify the rows.
|
|
1248
|
+
*/
|
|
1249
|
+
onSelectRows: (selectedRows: Set<number | string>) => void;
|
|
1250
|
+
/**
|
|
1251
|
+
* This prop indicates the unique key that can be used to identify each row. This prop is mandatory if selectable is set to true, expandable is set to true or rows is of type HierarchyGridRow[].
|
|
1252
|
+
*/
|
|
1253
|
+
uniqueRowId: string;
|
|
1254
|
+
} | {
|
|
1255
|
+
selectable?: false;
|
|
1256
|
+
selectedRows?: never;
|
|
1257
|
+
onSelectRows?: never;
|
|
1258
|
+
uniqueRowId?: string;
|
|
1259
|
+
};
|
|
1260
|
+
type PaginatedProps$1 = {
|
|
1261
|
+
/**
|
|
1262
|
+
* If true, paginator will be displayed.
|
|
1263
|
+
*/
|
|
1264
|
+
showPaginator?: true;
|
|
1265
|
+
/**
|
|
1266
|
+
* Number of total items.
|
|
1267
|
+
*/
|
|
1268
|
+
totalItems?: number;
|
|
1269
|
+
/**
|
|
1270
|
+
* If true, a select component for navigation between pages will be displayed.
|
|
1271
|
+
*/
|
|
1272
|
+
showGoToPage?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* Number of items per page.
|
|
1275
|
+
*/
|
|
1276
|
+
itemsPerPage?: number;
|
|
1277
|
+
/**
|
|
1278
|
+
* An array of numbers representing the items per page options.
|
|
1279
|
+
*/
|
|
1280
|
+
itemsPerPageOptions?: number[];
|
|
1281
|
+
/**
|
|
1282
|
+
* This function will be called when the user selects an item per page
|
|
1283
|
+
* option. The value selected will be passed as a parameter.
|
|
1284
|
+
*/
|
|
1285
|
+
itemsPerPageFunction?: (value: number) => void;
|
|
1286
|
+
/**
|
|
1287
|
+
* Function called whenever the current page is changed.
|
|
1288
|
+
*/
|
|
1289
|
+
onPageChange?: (_page: number) => void;
|
|
1290
|
+
/**
|
|
1291
|
+
* Default page in which the datagrid is rendered
|
|
1292
|
+
*/
|
|
1293
|
+
defaultPage?: number;
|
|
1294
|
+
};
|
|
1295
|
+
type NonPaginatedProps$1 = {
|
|
1296
|
+
/**
|
|
1297
|
+
* If true, paginator will be displayed.
|
|
1298
|
+
*/
|
|
1299
|
+
showPaginator: false;
|
|
1300
|
+
/**
|
|
1301
|
+
* Number of total items.
|
|
1302
|
+
*/
|
|
1303
|
+
totalItems?: never;
|
|
1304
|
+
/**
|
|
1305
|
+
* If true, a select component for navigation between pages will be displayed.
|
|
1306
|
+
*/
|
|
1307
|
+
showGoToPage?: never;
|
|
1308
|
+
/**
|
|
1309
|
+
* Number of items per page.
|
|
1310
|
+
*/
|
|
1311
|
+
itemsPerPage?: never;
|
|
1312
|
+
/**
|
|
1313
|
+
* An array of numbers representing the items per page options.
|
|
1314
|
+
*/
|
|
1315
|
+
itemsPerPageOptions?: never;
|
|
1154
1316
|
/**
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1317
|
+
* This function will be called when the user selects an item per page
|
|
1318
|
+
* option. The value selected will be passed as a parameter.
|
|
1157
1319
|
*/
|
|
1158
|
-
|
|
1320
|
+
itemsPerPageFunction?: never;
|
|
1159
1321
|
/**
|
|
1160
|
-
*
|
|
1161
|
-
*
|
|
1162
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
|
|
1322
|
+
* Function called whenever the current page is changed.
|
|
1163
1323
|
*/
|
|
1164
|
-
|
|
1324
|
+
onPageChange?: never;
|
|
1165
1325
|
/**
|
|
1166
|
-
*
|
|
1167
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties
|
|
1168
|
-
* in order to specify different margin sizes.
|
|
1326
|
+
* Default page in which the datagrid is rendered
|
|
1169
1327
|
*/
|
|
1170
|
-
|
|
1328
|
+
defaultPage?: never;
|
|
1329
|
+
};
|
|
1330
|
+
type CommonProps$6 = {
|
|
1331
|
+
columns: GridColumn[];
|
|
1171
1332
|
/**
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/position
|
|
1333
|
+
* Extra row that will be always visible.
|
|
1175
1334
|
*/
|
|
1176
|
-
|
|
1335
|
+
summaryRow?: GridRow;
|
|
1177
1336
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/width
|
|
1337
|
+
* Function called whenever a cell is edited.
|
|
1181
1338
|
*/
|
|
1182
|
-
|
|
1339
|
+
onGridRowsChange?: (_rows: GridRow[] | HierarchyGridRow[] | ExpandableGridRow[]) => void;
|
|
1183
1340
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
*
|
|
1186
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/z-index
|
|
1341
|
+
* Function called whenever a column is sorted. Receives the sorted
|
|
1342
|
+
* column and direction, or `undefined` if no sorting is applied.
|
|
1187
1343
|
*/
|
|
1188
|
-
|
|
1189
|
-
};
|
|
1190
|
-
|
|
1191
|
-
declare const DxcContainer: ({ display, width, height, overflow, ...props }: Props$v) => react_jsx_runtime.JSX.Element;
|
|
1192
|
-
|
|
1193
|
-
type SVG$9 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
1194
|
-
type CommonItemProps = {
|
|
1195
|
-
badge?: React.ReactElement;
|
|
1196
|
-
icon?: string | SVG$9;
|
|
1197
|
-
label: string;
|
|
1198
|
-
};
|
|
1199
|
-
type Item = CommonItemProps & {
|
|
1200
|
-
onSelect?: () => void;
|
|
1201
|
-
selectedByDefault?: boolean;
|
|
1202
|
-
};
|
|
1203
|
-
type GroupItem = CommonItemProps & {
|
|
1204
|
-
items: (Item | GroupItem)[];
|
|
1205
|
-
};
|
|
1206
|
-
type Section = {
|
|
1207
|
-
items: (Item | GroupItem)[];
|
|
1208
|
-
title?: string;
|
|
1344
|
+
onSort?: (_sortColumn?: SortColumn) => void;
|
|
1209
1345
|
};
|
|
1210
|
-
type
|
|
1346
|
+
type BasicGridProps = {
|
|
1347
|
+
rows: GridRow[];
|
|
1211
1348
|
/**
|
|
1212
|
-
*
|
|
1213
|
-
* Each item can be a single/simple item, a group item or a section.
|
|
1349
|
+
* Whether the rows can expand or not.
|
|
1214
1350
|
*/
|
|
1215
|
-
|
|
1351
|
+
expandable?: false;
|
|
1216
1352
|
};
|
|
1353
|
+
type Props$s = CommonProps$6 & (PaginatedProps$1 | NonPaginatedProps$1) & ((BasicGridProps & SelectableGridProps) | (ExpandableRows & SelectableGridProps) | (HierarchyRows & SelectableGridProps));
|
|
1217
1354
|
|
|
1218
|
-
declare const
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
type Margin$h = {
|
|
1222
|
-
top?: Space$i;
|
|
1223
|
-
bottom?: Space$i;
|
|
1224
|
-
left?: Space$i;
|
|
1225
|
-
right?: Space$i;
|
|
1355
|
+
declare const DxcDataGrid: {
|
|
1356
|
+
({ columns, rows, selectable, expandable, onSelectRows, selectedRows, uniqueRowId, summaryRow, onGridRowsChange, showPaginator, showGoToPage, itemsPerPage, itemsPerPageOptions, itemsPerPageFunction, onSort, onPageChange, totalItems, defaultPage, }: Props$s): JSX.Element;
|
|
1357
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
1226
1358
|
};
|
|
1227
|
-
|
|
1359
|
+
|
|
1360
|
+
type Props$r = {
|
|
1228
1361
|
/**
|
|
1229
1362
|
* Initial value of the input element, only when it is uncontrolled.
|
|
1230
1363
|
*/
|
|
@@ -1315,24 +1448,28 @@ type Props$t = {
|
|
|
1315
1448
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1316
1449
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1317
1450
|
*/
|
|
1318
|
-
margin?: Space$
|
|
1451
|
+
margin?: Space$1 | Margin;
|
|
1319
1452
|
/**
|
|
1320
1453
|
* Size of the component.
|
|
1321
1454
|
*/
|
|
1322
|
-
size?: "medium" | "large" | "fillParent";
|
|
1455
|
+
size?: "small" | "medium" | "large" | "fillParent";
|
|
1323
1456
|
/**
|
|
1324
1457
|
* Value of the tabindex attribute.
|
|
1325
1458
|
*/
|
|
1326
1459
|
tabIndex?: number;
|
|
1460
|
+
/**
|
|
1461
|
+
* Specifies a string to be used as the name for the date input element when no `label` is provided.
|
|
1462
|
+
*/
|
|
1463
|
+
ariaLabel?: string;
|
|
1327
1464
|
};
|
|
1328
1465
|
|
|
1329
|
-
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$
|
|
1466
|
+
declare const DxcDateInput: react.ForwardRefExoticComponent<Props$r & react.RefAttributes<HTMLDivElement>>;
|
|
1330
1467
|
|
|
1331
|
-
type Props$
|
|
1468
|
+
type Props$q = {
|
|
1332
1469
|
/**
|
|
1333
1470
|
* If true, the close button will be visible.
|
|
1334
1471
|
*/
|
|
1335
|
-
|
|
1472
|
+
closable?: boolean;
|
|
1336
1473
|
/**
|
|
1337
1474
|
* This function will be called when the user clicks the close button.
|
|
1338
1475
|
* The responsibility of hiding the dialog lies with the user.
|
|
@@ -1354,7 +1491,7 @@ type Props$s = {
|
|
|
1354
1491
|
* can lead to unpredictable behaviour for keyboard users, affecting
|
|
1355
1492
|
* the order of focus and focus locking within the dialog.
|
|
1356
1493
|
*/
|
|
1357
|
-
children:
|
|
1494
|
+
children: ReactNode;
|
|
1358
1495
|
/**
|
|
1359
1496
|
* Value of the tabindex applied to the close button.
|
|
1360
1497
|
* Note that values greater than 0 are strongly discouraged. It can
|
|
@@ -1363,9 +1500,9 @@ type Props$s = {
|
|
|
1363
1500
|
tabIndex?: number;
|
|
1364
1501
|
};
|
|
1365
1502
|
|
|
1366
|
-
declare const DxcDialog: ({
|
|
1503
|
+
declare const DxcDialog: ({ children, closable, onBackgroundClick, onCloseClick, overlay, tabIndex, }: Props$q) => JSX.Element;
|
|
1367
1504
|
|
|
1368
|
-
type Props$
|
|
1505
|
+
type Props$p = {
|
|
1369
1506
|
/**
|
|
1370
1507
|
* The divider can be shown in horizontal or vertical.
|
|
1371
1508
|
*/
|
|
@@ -1386,17 +1523,10 @@ type Props$r = {
|
|
|
1386
1523
|
decorative?: boolean;
|
|
1387
1524
|
};
|
|
1388
1525
|
|
|
1389
|
-
declare
|
|
1526
|
+
declare function DxcDivider({ color, decorative, orientation, weight, }: Props$p): react_jsx_runtime.JSX.Element;
|
|
1390
1527
|
|
|
1391
|
-
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, }: Props$
|
|
1528
|
+
declare const DxcDropdown: ({ options, optionsIconPosition, icon, iconPosition, label, caretHidden, disabled, expandOnHover, onSelectOption, margin, size, tabIndex, title, }: Props$F) => react_jsx_runtime.JSX.Element;
|
|
1392
1529
|
|
|
1393
|
-
type Space$h = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
1394
|
-
type Margin$g = {
|
|
1395
|
-
top?: Space$h;
|
|
1396
|
-
bottom?: Space$h;
|
|
1397
|
-
left?: Space$h;
|
|
1398
|
-
right?: Space$h;
|
|
1399
|
-
};
|
|
1400
1530
|
type FileData = {
|
|
1401
1531
|
/**
|
|
1402
1532
|
* Selected file.
|
|
@@ -1411,7 +1541,7 @@ type FileData = {
|
|
|
1411
1541
|
*/
|
|
1412
1542
|
preview?: string;
|
|
1413
1543
|
};
|
|
1414
|
-
type CommonProps$
|
|
1544
|
+
type CommonProps$5 = {
|
|
1415
1545
|
/**
|
|
1416
1546
|
* Text to be placed above the component.
|
|
1417
1547
|
*/
|
|
@@ -1462,13 +1592,13 @@ type CommonProps$4 = {
|
|
|
1462
1592
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1463
1593
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1464
1594
|
*/
|
|
1465
|
-
margin?: Space$
|
|
1595
|
+
margin?: Space$1 | Margin;
|
|
1466
1596
|
/**
|
|
1467
1597
|
* Value of the tabindex attribute.
|
|
1468
1598
|
*/
|
|
1469
1599
|
tabIndex?: number;
|
|
1470
1600
|
};
|
|
1471
|
-
type DropModeProps = CommonProps$
|
|
1601
|
+
type DropModeProps = CommonProps$5 & {
|
|
1472
1602
|
/**
|
|
1473
1603
|
* Uses one of the available file input modes:
|
|
1474
1604
|
* 'file': Files are selected by clicking the button and selecting it through the file explorer.
|
|
@@ -1482,7 +1612,7 @@ type DropModeProps = CommonProps$4 & {
|
|
|
1482
1612
|
*/
|
|
1483
1613
|
dropAreaLabel?: string;
|
|
1484
1614
|
};
|
|
1485
|
-
type FileModeProps = CommonProps$
|
|
1615
|
+
type FileModeProps = CommonProps$5 & {
|
|
1486
1616
|
/**
|
|
1487
1617
|
* Uses one of the available file input modes:
|
|
1488
1618
|
* 'file': Files are selected by clicking the button and selecting it through the file explorer.
|
|
@@ -1496,31 +1626,30 @@ type FileModeProps = CommonProps$4 & {
|
|
|
1496
1626
|
*/
|
|
1497
1627
|
dropAreaLabel?: never;
|
|
1498
1628
|
};
|
|
1499
|
-
type Props$
|
|
1629
|
+
type Props$o = DropModeProps | FileModeProps;
|
|
1500
1630
|
|
|
1501
|
-
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$
|
|
1631
|
+
declare const DxcFileInput: react.ForwardRefExoticComponent<Props$o & react.RefAttributes<HTMLDivElement>>;
|
|
1502
1632
|
|
|
1503
|
-
type Spaces$1 = "0rem" | "0.125rem" | "0.25rem" | "0.5rem" | "1rem" | "1.5rem" | "2rem" | "3rem" | "4rem" | "5rem";
|
|
1504
1633
|
type Gap$1 = {
|
|
1505
|
-
rowGap:
|
|
1506
|
-
columnGap?:
|
|
1634
|
+
rowGap: string;
|
|
1635
|
+
columnGap?: string;
|
|
1507
1636
|
} | {
|
|
1508
|
-
rowGap?:
|
|
1509
|
-
columnGap:
|
|
1510
|
-
} |
|
|
1511
|
-
type CommonProps$
|
|
1637
|
+
rowGap?: string;
|
|
1638
|
+
columnGap: string;
|
|
1639
|
+
} | string;
|
|
1640
|
+
type CommonProps$4 = {
|
|
1512
1641
|
/**
|
|
1513
1642
|
* Sets the justify-content CSS property.
|
|
1514
1643
|
*
|
|
1515
1644
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
1516
1645
|
*/
|
|
1517
|
-
justifyContent?: "flex-start" | "flex-end" | "start" | "end" | "left" | "right" | "center" | "space-between" | "space-around" | "space-evenly";
|
|
1646
|
+
justifyContent?: "flex-start" | "flex-end" | "start" | "end" | "left" | "normal" | "right" | "center" | "space-between" | "space-around" | "space-evenly";
|
|
1518
1647
|
/**
|
|
1519
1648
|
* Sets the align-items CSS property.
|
|
1520
1649
|
*
|
|
1521
1650
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
1522
1651
|
*/
|
|
1523
|
-
alignItems?: "stretch" | "flex-start" | "flex-end" | "start" | "end" | "self-start" | "self-end" | "center" | "baseline";
|
|
1652
|
+
alignItems?: "stretch" | "flex-start" | "flex-end" | "start" | "end" | "self-start" | "self-end" | "center" | "baseline" | "normal";
|
|
1524
1653
|
/**
|
|
1525
1654
|
* Sets the align-content CSS property.
|
|
1526
1655
|
*
|
|
@@ -1534,7 +1663,7 @@ type CommonProps$3 = {
|
|
|
1534
1663
|
*/
|
|
1535
1664
|
alignSelf?: "auto" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
|
|
1536
1665
|
};
|
|
1537
|
-
type Props$
|
|
1666
|
+
type Props$n = CommonProps$4 & {
|
|
1538
1667
|
/**
|
|
1539
1668
|
* Sets the flex-direction CSS property.
|
|
1540
1669
|
*
|
|
@@ -1584,53 +1713,54 @@ type Props$p = CommonProps$3 & {
|
|
|
1584
1713
|
/**
|
|
1585
1714
|
* Custom content inside the flex container.
|
|
1586
1715
|
*/
|
|
1587
|
-
children:
|
|
1716
|
+
children: ReactNode;
|
|
1588
1717
|
};
|
|
1589
1718
|
|
|
1590
|
-
declare const DxcFlex: ({
|
|
1719
|
+
declare const DxcFlex: ({ basis, direction, gap, grow, order, shrink, wrap, ...props }: Props$n) => react_jsx_runtime.JSX.Element;
|
|
1591
1720
|
|
|
1592
|
-
type
|
|
1593
|
-
|
|
1594
|
-
rowGap:
|
|
1595
|
-
columnGap?: Spaces;
|
|
1721
|
+
type Gap = string | {
|
|
1722
|
+
columnGap?: string;
|
|
1723
|
+
rowGap: string;
|
|
1596
1724
|
} | {
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
}
|
|
1725
|
+
columnGap: string;
|
|
1726
|
+
rowGap?: string;
|
|
1727
|
+
};
|
|
1600
1728
|
type GridCell = {
|
|
1601
|
-
start: number | string;
|
|
1602
1729
|
end: number | string;
|
|
1730
|
+
start: number | string;
|
|
1603
1731
|
};
|
|
1604
|
-
type PlaceSelfValues = "auto" | "
|
|
1605
|
-
type PlaceContentValues = "
|
|
1606
|
-
type PlaceItemsValues = "
|
|
1732
|
+
type PlaceSelfValues = "auto" | "baseline" | "center" | "end" | "start" | "stretch";
|
|
1733
|
+
type PlaceContentValues = "baseline" | "center" | "end" | "normal" | "space-around" | "space-between" | "space-evenly" | "start" | "stretch";
|
|
1734
|
+
type PlaceItemsValues = "baseline" | "center" | "end" | "normal" | "start" | "stretch";
|
|
1607
1735
|
type PlaceObject<Type, Suffix extends string> = {
|
|
1608
1736
|
[Property in keyof Type as `${string & Property}${Capitalize<string & Suffix>}`]: Type[Property];
|
|
1609
1737
|
};
|
|
1610
1738
|
type PlaceGeneric<PlaceValues, Element extends string> = PlaceObject<{
|
|
1611
|
-
justify?: PlaceValues;
|
|
1612
1739
|
align: PlaceValues;
|
|
1740
|
+
justify?: PlaceValues;
|
|
1613
1741
|
}, Element> | PlaceObject<{
|
|
1614
|
-
justify: PlaceValues;
|
|
1615
1742
|
align?: PlaceValues;
|
|
1743
|
+
justify: PlaceValues;
|
|
1616
1744
|
}, Element> | PlaceValues;
|
|
1617
1745
|
type GridItemProps = {
|
|
1618
1746
|
/**
|
|
1619
1747
|
* Sets the name of an item so that it can be referenced by a template created with the grid-template-areas property.
|
|
1620
1748
|
*/
|
|
1621
1749
|
areaName?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Sets a custom HTML tag.
|
|
1752
|
+
*/
|
|
1753
|
+
as?: keyof HTMLElementTagNameMap;
|
|
1754
|
+
/**
|
|
1755
|
+
* Custom content inside the grid container.
|
|
1756
|
+
*/
|
|
1757
|
+
children: ReactNode;
|
|
1622
1758
|
/**
|
|
1623
1759
|
* Sets the grid-column CSS property.
|
|
1624
1760
|
*
|
|
1625
1761
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
|
|
1626
1762
|
*/
|
|
1627
1763
|
column?: number | string | GridCell;
|
|
1628
|
-
/**
|
|
1629
|
-
* Sets the grid-row CSS property.
|
|
1630
|
-
*
|
|
1631
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
1632
|
-
*/
|
|
1633
|
-
row?: number | string | GridCell;
|
|
1634
1764
|
/**
|
|
1635
1765
|
* Sets the place-self CSS property.
|
|
1636
1766
|
*
|
|
@@ -1638,15 +1768,13 @@ type GridItemProps = {
|
|
|
1638
1768
|
*/
|
|
1639
1769
|
placeSelf?: PlaceGeneric<PlaceSelfValues, "self">;
|
|
1640
1770
|
/**
|
|
1641
|
-
* Sets
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
/**
|
|
1645
|
-
* Custom content inside the grid container.
|
|
1771
|
+
* Sets the grid-row CSS property.
|
|
1772
|
+
*
|
|
1773
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
1646
1774
|
*/
|
|
1647
|
-
|
|
1775
|
+
row?: number | string | GridCell;
|
|
1648
1776
|
};
|
|
1649
|
-
type Props$
|
|
1777
|
+
type Props$m = GridItemProps & {
|
|
1650
1778
|
/**
|
|
1651
1779
|
* Sets the grid-auto-columns CSS property.
|
|
1652
1780
|
*
|
|
@@ -1670,7 +1798,7 @@ type Props$o = GridItemProps & {
|
|
|
1670
1798
|
*
|
|
1671
1799
|
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/gap
|
|
1672
1800
|
*/
|
|
1673
|
-
gap?:
|
|
1801
|
+
gap?: Gap;
|
|
1674
1802
|
/**
|
|
1675
1803
|
* Sets the place-content CSS property.
|
|
1676
1804
|
*
|
|
@@ -1704,24 +1832,17 @@ type Props$o = GridItemProps & {
|
|
|
1704
1832
|
};
|
|
1705
1833
|
|
|
1706
1834
|
declare const DxcGrid: {
|
|
1707
|
-
(props: Props$
|
|
1835
|
+
(props: Props$m): react_jsx_runtime.JSX.Element;
|
|
1708
1836
|
Item: styled_components.StyledComponent<"div", any, GridItemProps, never>;
|
|
1709
1837
|
};
|
|
1710
1838
|
|
|
1711
|
-
type
|
|
1712
|
-
type Margin$f = {
|
|
1713
|
-
top?: Space$g;
|
|
1714
|
-
bottom?: Space$g;
|
|
1715
|
-
left?: Space$g;
|
|
1716
|
-
right?: Space$g;
|
|
1717
|
-
};
|
|
1718
|
-
type Props$n = {
|
|
1839
|
+
type Props$l = {
|
|
1719
1840
|
/**
|
|
1720
1841
|
* Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
|
|
1721
1842
|
* The html tag of the heading will be the one specified in the 'as' prop.
|
|
1722
1843
|
* If 'as' is not specified, the html tag of the heading is the one specified in the 'level' prop.
|
|
1723
1844
|
*/
|
|
1724
|
-
level?: 1 | 2 | 3 | 4 | 5;
|
|
1845
|
+
level?: 1 | 2 | 3 | 4 | 5 | 6;
|
|
1725
1846
|
/**
|
|
1726
1847
|
* Heading text.
|
|
1727
1848
|
*/
|
|
@@ -1729,21 +1850,21 @@ type Props$n = {
|
|
|
1729
1850
|
/**
|
|
1730
1851
|
* Modifies the default weight of the heading.
|
|
1731
1852
|
*/
|
|
1732
|
-
weight?: "light" | "
|
|
1853
|
+
weight?: "light" | "default" | "regular";
|
|
1733
1854
|
/**
|
|
1734
1855
|
* Specifies the HTML tag of the heading.
|
|
1735
1856
|
*/
|
|
1736
|
-
as?: "h1" | "h2" | "h3" | "h4" | "h5";
|
|
1857
|
+
as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
1737
1858
|
/**
|
|
1738
1859
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1739
1860
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1740
1861
|
*/
|
|
1741
|
-
margin?: Space$
|
|
1862
|
+
margin?: Space$1 | Margin;
|
|
1742
1863
|
};
|
|
1743
1864
|
|
|
1744
|
-
declare
|
|
1865
|
+
declare function DxcHeading({ as, level, margin, text, weight }: Props$l): react_jsx_runtime.JSX.Element;
|
|
1745
1866
|
|
|
1746
|
-
type Props$
|
|
1867
|
+
type Props$k = {
|
|
1747
1868
|
/**
|
|
1748
1869
|
* Alternative text description displayed when the specified image is not loaded.
|
|
1749
1870
|
*
|
|
@@ -1756,21 +1877,35 @@ type Props$m = {
|
|
|
1756
1877
|
* which is required regardless of the presence of the caption or not.
|
|
1757
1878
|
*/
|
|
1758
1879
|
caption?: string;
|
|
1880
|
+
/**
|
|
1881
|
+
* Sets the rendered height of the image.
|
|
1882
|
+
*/
|
|
1883
|
+
height?: string;
|
|
1759
1884
|
/**
|
|
1760
1885
|
* If true, the image will be loaded only when it is visible on the screen (lazy loading).
|
|
1761
1886
|
* Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
|
|
1762
1887
|
*/
|
|
1763
1888
|
lazyLoading?: boolean;
|
|
1764
1889
|
/**
|
|
1765
|
-
*
|
|
1890
|
+
* Sets the object-fit CSS property.
|
|
1891
|
+
*
|
|
1892
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1766
1893
|
*/
|
|
1767
|
-
|
|
1894
|
+
objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
|
|
1768
1895
|
/**
|
|
1769
|
-
*
|
|
1896
|
+
* Sets the object-position CSS property.
|
|
1770
1897
|
*
|
|
1771
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/
|
|
1898
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
|
|
1772
1899
|
*/
|
|
1773
|
-
|
|
1900
|
+
objectPosition?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* This function will be called when the image fails to load.
|
|
1903
|
+
*/
|
|
1904
|
+
onError?: ReactEventHandler<HTMLImageElement>;
|
|
1905
|
+
/**
|
|
1906
|
+
* This function will be called when the image is loaded.
|
|
1907
|
+
*/
|
|
1908
|
+
onLoad?: ReactEventHandler<HTMLImageElement>;
|
|
1774
1909
|
/**
|
|
1775
1910
|
* One or more strings separated by commas, indicating a set of source sizes.
|
|
1776
1911
|
* If the srcSet attribute is absent or contains no values with a width descriptor,
|
|
@@ -1780,83 +1915,60 @@ type Props$m = {
|
|
|
1780
1915
|
*/
|
|
1781
1916
|
sizes?: string;
|
|
1782
1917
|
/**
|
|
1783
|
-
*
|
|
1784
|
-
*/
|
|
1785
|
-
width?: string;
|
|
1786
|
-
/**
|
|
1787
|
-
* Sets the rendered height of the image.
|
|
1788
|
-
*/
|
|
1789
|
-
height?: string;
|
|
1790
|
-
/**
|
|
1791
|
-
* Sets the object-fit CSS property.
|
|
1792
|
-
*
|
|
1793
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
1918
|
+
* URL of the image. This prop is required and must be valid.
|
|
1794
1919
|
*/
|
|
1795
|
-
|
|
1920
|
+
src: string;
|
|
1796
1921
|
/**
|
|
1797
|
-
*
|
|
1922
|
+
* List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
|
|
1798
1923
|
*
|
|
1799
|
-
* See MDN: https://developer.mozilla.org/en-US/docs/Web/
|
|
1800
|
-
*/
|
|
1801
|
-
objectPosition?: string;
|
|
1802
|
-
/**
|
|
1803
|
-
* This function will be called when the image is loaded.
|
|
1924
|
+
* See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
|
|
1804
1925
|
*/
|
|
1805
|
-
|
|
1926
|
+
srcSet?: string;
|
|
1806
1927
|
/**
|
|
1807
|
-
*
|
|
1928
|
+
* Sets the rendered width of the image.
|
|
1808
1929
|
*/
|
|
1809
|
-
|
|
1930
|
+
width?: string;
|
|
1810
1931
|
};
|
|
1811
1932
|
|
|
1812
|
-
declare
|
|
1933
|
+
declare function DxcImage({ alt, caption, height, lazyLoading, objectFit, objectPosition, onError, onLoad, sizes, src, srcSet, width, }: Props$k): react_jsx_runtime.JSX.Element;
|
|
1813
1934
|
|
|
1814
|
-
type
|
|
1815
|
-
type Props$l = {
|
|
1935
|
+
type Props$j = {
|
|
1816
1936
|
/**
|
|
1817
|
-
* Applies the spacing scale to
|
|
1937
|
+
* Applies the spacing scale to the bottom side.
|
|
1818
1938
|
*/
|
|
1819
|
-
|
|
1939
|
+
bottom?: string;
|
|
1820
1940
|
/**
|
|
1821
|
-
*
|
|
1941
|
+
* Custom content inside the inset.
|
|
1822
1942
|
*/
|
|
1823
|
-
|
|
1943
|
+
children: ReactNode;
|
|
1824
1944
|
/**
|
|
1825
|
-
* Applies the spacing scale to the
|
|
1945
|
+
* Applies the spacing scale to the left and right sides.
|
|
1826
1946
|
*/
|
|
1827
|
-
|
|
1947
|
+
horizontal?: string;
|
|
1828
1948
|
/**
|
|
1829
|
-
* Applies the spacing scale to the
|
|
1949
|
+
* Applies the spacing scale to the left side.
|
|
1830
1950
|
*/
|
|
1831
|
-
|
|
1951
|
+
left?: string;
|
|
1832
1952
|
/**
|
|
1833
1953
|
* Applies the spacing scale to the right side.
|
|
1834
1954
|
*/
|
|
1835
|
-
right?:
|
|
1955
|
+
right?: string;
|
|
1836
1956
|
/**
|
|
1837
|
-
* Applies the spacing scale to
|
|
1957
|
+
* Applies the spacing scale to all sides.
|
|
1838
1958
|
*/
|
|
1839
|
-
|
|
1959
|
+
space?: string;
|
|
1840
1960
|
/**
|
|
1841
|
-
* Applies the spacing scale to the
|
|
1961
|
+
* Applies the spacing scale to the top side.
|
|
1842
1962
|
*/
|
|
1843
|
-
|
|
1963
|
+
top?: string;
|
|
1844
1964
|
/**
|
|
1845
|
-
*
|
|
1965
|
+
* Applies the spacing scale to the top and bottom sides.
|
|
1846
1966
|
*/
|
|
1847
|
-
|
|
1967
|
+
vertical?: string;
|
|
1848
1968
|
};
|
|
1849
1969
|
|
|
1850
|
-
declare function
|
|
1970
|
+
declare function DxcInset({ bottom, children, horizontal, left, right, space, top, vertical }: Props$j): react_jsx_runtime.JSX.Element;
|
|
1851
1971
|
|
|
1852
|
-
type Space$f = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
1853
|
-
type Margin$e = {
|
|
1854
|
-
top?: Space$f;
|
|
1855
|
-
bottom?: Space$f;
|
|
1856
|
-
left?: Space$f;
|
|
1857
|
-
right?: Space$f;
|
|
1858
|
-
};
|
|
1859
|
-
type SVG$8 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
1860
1972
|
type LinkProps = {
|
|
1861
1973
|
/**
|
|
1862
1974
|
* If true, the link is disabled.
|
|
@@ -1869,7 +1981,7 @@ type LinkProps = {
|
|
|
1869
1981
|
/**
|
|
1870
1982
|
* Material Symbol name or SVG element as the icon that will be placed next to the link text.
|
|
1871
1983
|
*/
|
|
1872
|
-
icon?: string | SVG
|
|
1984
|
+
icon?: string | SVG;
|
|
1873
1985
|
/**
|
|
1874
1986
|
* Indicates the position of the icon in the component.
|
|
1875
1987
|
*/
|
|
@@ -1895,7 +2007,7 @@ type LinkProps = {
|
|
|
1895
2007
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
1896
2008
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
1897
2009
|
*/
|
|
1898
|
-
margin?: Space$
|
|
2010
|
+
margin?: Space$1 | Margin;
|
|
1899
2011
|
/**
|
|
1900
2012
|
* Value of the tabindex.
|
|
1901
2013
|
*/
|
|
@@ -1904,8 +2016,7 @@ type LinkProps = {
|
|
|
1904
2016
|
|
|
1905
2017
|
declare const DxcLink: react.ForwardRefExoticComponent<LinkProps & react.RefAttributes<HTMLAnchorElement>>;
|
|
1906
2018
|
|
|
1907
|
-
type
|
|
1908
|
-
type TabProps = {
|
|
2019
|
+
type TabProps$1 = {
|
|
1909
2020
|
/**
|
|
1910
2021
|
* Whether the tab is active or not.
|
|
1911
2022
|
*/
|
|
@@ -1921,7 +2032,7 @@ type TabProps = {
|
|
|
1921
2032
|
/**
|
|
1922
2033
|
* Material Symbol name or SVG element used as the icon that will be displayed in the tab.
|
|
1923
2034
|
*/
|
|
1924
|
-
icon?: string | SVG
|
|
2035
|
+
icon?: string | SVG;
|
|
1925
2036
|
/**
|
|
1926
2037
|
* If the value is 'true', an empty badge will appear.
|
|
1927
2038
|
* If it is 'false', no badge will appear.
|
|
@@ -1935,7 +2046,7 @@ type TabProps = {
|
|
|
1935
2046
|
*/
|
|
1936
2047
|
children: string;
|
|
1937
2048
|
};
|
|
1938
|
-
type Props$
|
|
2049
|
+
type Props$i = {
|
|
1939
2050
|
/**
|
|
1940
2051
|
* Whether the icon should appear above or to the left of the label.
|
|
1941
2052
|
*/
|
|
@@ -1943,7 +2054,7 @@ type Props$k = {
|
|
|
1943
2054
|
/**
|
|
1944
2055
|
* Contains one or more DxcNavTabs.Tab.
|
|
1945
2056
|
*/
|
|
1946
|
-
children:
|
|
2057
|
+
children: ReactNode;
|
|
1947
2058
|
/**
|
|
1948
2059
|
* Value of the tabindex attribute applied to each tab.
|
|
1949
2060
|
*/
|
|
@@ -1951,18 +2062,11 @@ type Props$k = {
|
|
|
1951
2062
|
};
|
|
1952
2063
|
|
|
1953
2064
|
declare const DxcNavTabs: {
|
|
1954
|
-
({ iconPosition, tabIndex, children }: Props$
|
|
1955
|
-
Tab: react.ForwardRefExoticComponent<TabProps & react.RefAttributes<HTMLAnchorElement>>;
|
|
2065
|
+
({ iconPosition, tabIndex, children }: Props$i): JSX.Element;
|
|
2066
|
+
Tab: react.ForwardRefExoticComponent<TabProps$1 & react.RefAttributes<HTMLAnchorElement>>;
|
|
1956
2067
|
};
|
|
1957
2068
|
|
|
1958
|
-
type
|
|
1959
|
-
type Margin$d = {
|
|
1960
|
-
top?: Space$e;
|
|
1961
|
-
bottom?: Space$e;
|
|
1962
|
-
left?: Space$e;
|
|
1963
|
-
right?: Space$e;
|
|
1964
|
-
};
|
|
1965
|
-
type Props$j = {
|
|
2069
|
+
type Props$h = {
|
|
1966
2070
|
/**
|
|
1967
2071
|
* Text to be placed above the number.
|
|
1968
2072
|
*/
|
|
@@ -2070,7 +2174,7 @@ type Props$j = {
|
|
|
2070
2174
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2071
2175
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2072
2176
|
*/
|
|
2073
|
-
margin?: Space$
|
|
2177
|
+
margin?: Space$1 | Margin;
|
|
2074
2178
|
/**
|
|
2075
2179
|
* Size of the component.
|
|
2076
2180
|
*/
|
|
@@ -2079,11 +2183,19 @@ type Props$j = {
|
|
|
2079
2183
|
* Value of the tabindex attribute.
|
|
2080
2184
|
*/
|
|
2081
2185
|
tabIndex?: number;
|
|
2186
|
+
/**
|
|
2187
|
+
* Specifies a string to be used as the name for the number input element when no `label` is provided.
|
|
2188
|
+
*/
|
|
2189
|
+
ariaLabel?: string;
|
|
2190
|
+
/**
|
|
2191
|
+
* Decides whether the number input has actions to increase or decrease the value, following the defined step.
|
|
2192
|
+
*/
|
|
2193
|
+
showControls?: boolean;
|
|
2082
2194
|
};
|
|
2083
2195
|
|
|
2084
|
-
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$
|
|
2196
|
+
declare const DxcNumberInput: react.ForwardRefExoticComponent<Props$h & react.RefAttributes<HTMLDivElement>>;
|
|
2085
2197
|
|
|
2086
|
-
type Props$
|
|
2198
|
+
type Props$g = {
|
|
2087
2199
|
/**
|
|
2088
2200
|
* Number of the current selected page.
|
|
2089
2201
|
*/
|
|
@@ -2121,20 +2233,13 @@ type Props$i = {
|
|
|
2121
2233
|
tabIndex?: number;
|
|
2122
2234
|
};
|
|
2123
2235
|
|
|
2124
|
-
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$
|
|
2236
|
+
declare const DxcPaginator: ({ currentPage, itemsPerPage, itemsPerPageOptions, totalItems, showGoToPage, onPageChange, itemsPerPageFunction, tabIndex, }: Props$g) => JSX.Element;
|
|
2125
2237
|
|
|
2126
|
-
declare
|
|
2127
|
-
children:
|
|
2128
|
-
})
|
|
2238
|
+
declare function DxcParagraph({ children }: {
|
|
2239
|
+
children: ReactNode;
|
|
2240
|
+
}): react_jsx_runtime.JSX.Element;
|
|
2129
2241
|
|
|
2130
|
-
type
|
|
2131
|
-
type Margin$c = {
|
|
2132
|
-
top?: Space$d;
|
|
2133
|
-
bottom?: Space$d;
|
|
2134
|
-
left?: Space$d;
|
|
2135
|
-
right?: Space$d;
|
|
2136
|
-
};
|
|
2137
|
-
type Props$h = {
|
|
2242
|
+
type Props$f = {
|
|
2138
2243
|
/**
|
|
2139
2244
|
* Text to be placed above the password input.
|
|
2140
2245
|
*/
|
|
@@ -2223,7 +2328,7 @@ type Props$h = {
|
|
|
2223
2328
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2224
2329
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2225
2330
|
*/
|
|
2226
|
-
margin?: Space$
|
|
2331
|
+
margin?: Space$1 | Margin;
|
|
2227
2332
|
/**
|
|
2228
2333
|
* Size of the component.
|
|
2229
2334
|
*/
|
|
@@ -2232,18 +2337,21 @@ type Props$h = {
|
|
|
2232
2337
|
* Value of the tabindex attribute.
|
|
2233
2338
|
*/
|
|
2234
2339
|
tabIndex?: number;
|
|
2340
|
+
/**
|
|
2341
|
+
* Specifies a string to be used as the name for the password input element when no `label` is provided.
|
|
2342
|
+
*/
|
|
2343
|
+
ariaLabel?: string;
|
|
2235
2344
|
};
|
|
2236
2345
|
|
|
2237
|
-
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$
|
|
2346
|
+
declare const DxcPasswordInput: react.ForwardRefExoticComponent<Props$f & react.RefAttributes<HTMLDivElement>>;
|
|
2238
2347
|
|
|
2239
|
-
type Space$c = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
2240
2348
|
type Size$1 = {
|
|
2241
|
-
top?: Space$
|
|
2242
|
-
bottom?: Space$
|
|
2243
|
-
left?: Space$
|
|
2244
|
-
right?: Space$
|
|
2349
|
+
top?: Space$1;
|
|
2350
|
+
bottom?: Space$1;
|
|
2351
|
+
left?: Space$1;
|
|
2352
|
+
right?: Space$1;
|
|
2245
2353
|
};
|
|
2246
|
-
type Props$
|
|
2354
|
+
type Props$e = {
|
|
2247
2355
|
/**
|
|
2248
2356
|
* Text to be placed above the progress bar.
|
|
2249
2357
|
*/
|
|
@@ -2270,10 +2378,14 @@ type Props$g = {
|
|
|
2270
2378
|
* an object with 'top', 'bottom', 'left' and 'right' properties
|
|
2271
2379
|
* in order to specify different margin sizes.
|
|
2272
2380
|
*/
|
|
2273
|
-
margin?: Space$
|
|
2381
|
+
margin?: Space$1 | Size$1;
|
|
2382
|
+
/**
|
|
2383
|
+
* Specifies a string to be used as the name for the progress bar element when no `label` is provided.
|
|
2384
|
+
*/
|
|
2385
|
+
ariaLabel?: string;
|
|
2274
2386
|
};
|
|
2275
2387
|
|
|
2276
|
-
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, }: Props$
|
|
2388
|
+
declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, ariaLabel, }: Props$e) => JSX.Element;
|
|
2277
2389
|
|
|
2278
2390
|
type Link = {
|
|
2279
2391
|
/**
|
|
@@ -2285,7 +2397,7 @@ type Link = {
|
|
|
2285
2397
|
*/
|
|
2286
2398
|
links?: Link[];
|
|
2287
2399
|
};
|
|
2288
|
-
type Props$
|
|
2400
|
+
type Props$d = {
|
|
2289
2401
|
/**
|
|
2290
2402
|
* Title of the quick nav component.
|
|
2291
2403
|
*/
|
|
@@ -2296,9 +2408,9 @@ type Props$f = {
|
|
|
2296
2408
|
links: Link[];
|
|
2297
2409
|
};
|
|
2298
2410
|
|
|
2299
|
-
declare
|
|
2411
|
+
declare function DxcQuickNav({ links, title }: Props$d): react_jsx_runtime.JSX.Element;
|
|
2300
2412
|
|
|
2301
|
-
type
|
|
2413
|
+
type Option$1 = {
|
|
2302
2414
|
/**
|
|
2303
2415
|
* Label of the option placed next to the radio input.
|
|
2304
2416
|
*/
|
|
@@ -2316,26 +2428,39 @@ type RadioOption = {
|
|
|
2316
2428
|
};
|
|
2317
2429
|
type RadioGroupProps = {
|
|
2318
2430
|
/**
|
|
2319
|
-
*
|
|
2431
|
+
* Specifies a string to be used as the name for the radio group when no `label` is provided.
|
|
2320
2432
|
*/
|
|
2321
|
-
|
|
2433
|
+
ariaLabel?: string;
|
|
2322
2434
|
/**
|
|
2323
|
-
*
|
|
2324
|
-
* to find the component's value during the submit event.
|
|
2435
|
+
* Initial value of the radio group, only when it is uncontrolled.
|
|
2325
2436
|
*/
|
|
2326
|
-
|
|
2437
|
+
defaultValue?: string;
|
|
2438
|
+
/**
|
|
2439
|
+
* If true, the component will be disabled.
|
|
2440
|
+
*/
|
|
2441
|
+
disabled?: boolean;
|
|
2442
|
+
/**
|
|
2443
|
+
* If it is a defined value and also a truthy string, the component will
|
|
2444
|
+
* change its appearance, showing the error below the radio group. If the
|
|
2445
|
+
* defined value is an empty string, it will reserve a space below the
|
|
2446
|
+
* component for a future error, but it would not change its look. In
|
|
2447
|
+
* case of being undefined or null, both the appearance and the space for
|
|
2448
|
+
* the error message would not be modified.
|
|
2449
|
+
*/
|
|
2450
|
+
error?: string;
|
|
2327
2451
|
/**
|
|
2328
2452
|
* Helper text to be placed above the radio group.
|
|
2329
2453
|
*/
|
|
2330
2454
|
helperText?: string;
|
|
2331
2455
|
/**
|
|
2332
|
-
*
|
|
2456
|
+
* Text to be placed above the radio group.
|
|
2333
2457
|
*/
|
|
2334
|
-
|
|
2458
|
+
label?: string;
|
|
2335
2459
|
/**
|
|
2336
|
-
*
|
|
2460
|
+
* Name attribute of the input element. This attribute will allow users
|
|
2461
|
+
* to find the component's value during the submit event.
|
|
2337
2462
|
*/
|
|
2338
|
-
|
|
2463
|
+
name?: string;
|
|
2339
2464
|
/**
|
|
2340
2465
|
* If true, the radio group will be optional, showing
|
|
2341
2466
|
* (Optional) next to the label and adding a default last
|
|
@@ -2349,28 +2474,9 @@ type RadioGroupProps = {
|
|
|
2349
2474
|
*/
|
|
2350
2475
|
optionalItemLabel?: string;
|
|
2351
2476
|
/**
|
|
2352
|
-
*
|
|
2353
|
-
*/
|
|
2354
|
-
readOnly?: boolean;
|
|
2355
|
-
/**
|
|
2356
|
-
* Sets the orientation of the options within the radio group.
|
|
2357
|
-
*/
|
|
2358
|
-
stacking?: "row" | "column";
|
|
2359
|
-
/**
|
|
2360
|
-
* Initial value of the radio group, only when it is uncontrolled.
|
|
2361
|
-
*/
|
|
2362
|
-
defaultValue?: string;
|
|
2363
|
-
/**
|
|
2364
|
-
* Value of the radio group. If undefined, the component will be
|
|
2365
|
-
* uncontrolled and the value will be managed internally by the
|
|
2366
|
-
* component.
|
|
2367
|
-
*/
|
|
2368
|
-
value?: string;
|
|
2369
|
-
/**
|
|
2370
|
-
* This function will be called when the user chooses an option. The new
|
|
2371
|
-
* value will be passed to this function.
|
|
2477
|
+
* An array of objects representing the selectable options.
|
|
2372
2478
|
*/
|
|
2373
|
-
|
|
2479
|
+
options: Option$1[];
|
|
2374
2480
|
/**
|
|
2375
2481
|
* This function will be called when the radio group loses the focus. An
|
|
2376
2482
|
* object including the value and the error will be passed to this
|
|
@@ -2381,78 +2487,37 @@ type RadioGroupProps = {
|
|
|
2381
2487
|
error?: string;
|
|
2382
2488
|
}) => void;
|
|
2383
2489
|
/**
|
|
2384
|
-
*
|
|
2385
|
-
*
|
|
2386
|
-
* defined value is an empty string, it will reserve a space below the
|
|
2387
|
-
* component for a future error, but it would not change its look. In
|
|
2388
|
-
* case of being undefined or null, both the appearance and the space for
|
|
2389
|
-
* the error message would not be modified.
|
|
2490
|
+
* This function will be called when the user chooses an option. The new
|
|
2491
|
+
* value will be passed to this function.
|
|
2390
2492
|
*/
|
|
2391
|
-
|
|
2493
|
+
onChange?: (value: string) => void;
|
|
2392
2494
|
/**
|
|
2393
|
-
*
|
|
2495
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
2394
2496
|
*/
|
|
2395
|
-
|
|
2396
|
-
};
|
|
2397
|
-
|
|
2398
|
-
declare const DxcRadioGroup: react.ForwardRefExoticComponent<RadioGroupProps & react.RefAttributes<HTMLDivElement>>;
|
|
2399
|
-
|
|
2400
|
-
type Space$b = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
2401
|
-
type Margin$b = {
|
|
2402
|
-
top?: Space$b;
|
|
2403
|
-
bottom?: Space$b;
|
|
2404
|
-
left?: Space$b;
|
|
2405
|
-
right?: Space$b;
|
|
2406
|
-
};
|
|
2407
|
-
type SVG$6 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
2408
|
-
type ActionCellsPropsType = {
|
|
2409
|
-
actions: Array<{
|
|
2410
|
-
icon: string | SVG$6;
|
|
2411
|
-
title: string;
|
|
2412
|
-
onClick: () => void;
|
|
2413
|
-
disabled?: boolean;
|
|
2414
|
-
tabIndex?: number;
|
|
2415
|
-
options?: never;
|
|
2416
|
-
} | {
|
|
2417
|
-
icon?: never;
|
|
2418
|
-
title: string;
|
|
2419
|
-
onClick: (value?: string) => void;
|
|
2420
|
-
disabled?: boolean;
|
|
2421
|
-
tabIndex?: number;
|
|
2422
|
-
options: Option$1[];
|
|
2423
|
-
}>;
|
|
2424
|
-
};
|
|
2425
|
-
type Props$e = {
|
|
2497
|
+
readOnly?: boolean;
|
|
2426
2498
|
/**
|
|
2427
|
-
*
|
|
2428
|
-
* content in this area.
|
|
2499
|
+
* Sets the orientation of the options within the radio group.
|
|
2429
2500
|
*/
|
|
2430
|
-
|
|
2501
|
+
stacking?: "row" | "column";
|
|
2431
2502
|
/**
|
|
2432
|
-
*
|
|
2433
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2503
|
+
* Value of the tabindex attribute.
|
|
2434
2504
|
*/
|
|
2435
|
-
|
|
2505
|
+
tabIndex?: number;
|
|
2436
2506
|
/**
|
|
2437
|
-
*
|
|
2438
|
-
*
|
|
2439
|
-
*
|
|
2507
|
+
* Value of the radio group. If undefined, the component will be
|
|
2508
|
+
* uncontrolled and the value will be managed internally by the
|
|
2509
|
+
* component.
|
|
2440
2510
|
*/
|
|
2441
|
-
|
|
2511
|
+
value?: string;
|
|
2442
2512
|
};
|
|
2443
2513
|
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
top?: Space$a;
|
|
2447
|
-
bottom?: Space$a;
|
|
2448
|
-
left?: Space$a;
|
|
2449
|
-
right?: Space$a;
|
|
2450
|
-
};
|
|
2514
|
+
declare const DxcRadioGroup: react.ForwardRefExoticComponent<RadioGroupProps & react.RefAttributes<HTMLDivElement>>;
|
|
2515
|
+
|
|
2451
2516
|
type Column = {
|
|
2452
2517
|
/**
|
|
2453
2518
|
* Column display value.
|
|
2454
2519
|
*/
|
|
2455
|
-
displayValue:
|
|
2520
|
+
displayValue: ReactNode;
|
|
2456
2521
|
/**
|
|
2457
2522
|
* Boolean value to indicate whether the column is sortable or not.
|
|
2458
2523
|
*/
|
|
@@ -2462,7 +2527,7 @@ type Cell = {
|
|
|
2462
2527
|
/**
|
|
2463
2528
|
* Value to be displayed in the cell.
|
|
2464
2529
|
*/
|
|
2465
|
-
displayValue:
|
|
2530
|
+
displayValue: ReactNode;
|
|
2466
2531
|
/**
|
|
2467
2532
|
* Value to be used when sorting the table by that
|
|
2468
2533
|
* column. If not indicated displayValue will be used for sorting.
|
|
@@ -2470,7 +2535,7 @@ type Cell = {
|
|
|
2470
2535
|
sortValue?: string | number | Date;
|
|
2471
2536
|
};
|
|
2472
2537
|
type Row = Cell[];
|
|
2473
|
-
type CommonProps$
|
|
2538
|
+
type CommonProps$3 = {
|
|
2474
2539
|
/**
|
|
2475
2540
|
* An array of objects representing the columns of the table.
|
|
2476
2541
|
*/
|
|
@@ -2484,7 +2549,7 @@ type CommonProps$2 = {
|
|
|
2484
2549
|
* Size of the margin to be applied to the component. You can pass an object with 'top',
|
|
2485
2550
|
* 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2486
2551
|
*/
|
|
2487
|
-
margin?: Space$
|
|
2552
|
+
margin?: Space$1 | Margin;
|
|
2488
2553
|
/**
|
|
2489
2554
|
* Value of the tabindex attribute applied to the sortable icon.
|
|
2490
2555
|
*/
|
|
@@ -2496,7 +2561,7 @@ type CommonProps$2 = {
|
|
|
2496
2561
|
*/
|
|
2497
2562
|
mode?: "default" | "reduced";
|
|
2498
2563
|
};
|
|
2499
|
-
type PaginatedProps = CommonProps$
|
|
2564
|
+
type PaginatedProps = CommonProps$3 & {
|
|
2500
2565
|
hidePaginator?: false;
|
|
2501
2566
|
/**
|
|
2502
2567
|
* If true, a select component for navigation between pages will be displayed.
|
|
@@ -2516,7 +2581,7 @@ type PaginatedProps = CommonProps$2 & {
|
|
|
2516
2581
|
*/
|
|
2517
2582
|
itemsPerPageFunction?: (value: number) => void;
|
|
2518
2583
|
};
|
|
2519
|
-
type NonPaginatedProps = CommonProps$
|
|
2584
|
+
type NonPaginatedProps = CommonProps$3 & {
|
|
2520
2585
|
/**
|
|
2521
2586
|
* If true, paginator will not be displayed.
|
|
2522
2587
|
*/
|
|
@@ -2539,31 +2604,13 @@ type NonPaginatedProps = CommonProps$2 & {
|
|
|
2539
2604
|
*/
|
|
2540
2605
|
itemsPerPageFunction?: never;
|
|
2541
2606
|
};
|
|
2542
|
-
type Props$
|
|
2607
|
+
type Props$c = PaginatedProps | NonPaginatedProps;
|
|
2543
2608
|
|
|
2544
2609
|
declare const DxcResultsetTable: {
|
|
2545
|
-
({ columns,
|
|
2546
|
-
ActionsCell: ({ actions }:
|
|
2610
|
+
({ columns, hidePaginator, itemsPerPage, itemsPerPageFunction, itemsPerPageOptions, margin, mode, rows, showGoToPage, tabIndex, }: Props$c): react_jsx_runtime.JSX.Element;
|
|
2611
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
2547
2612
|
};
|
|
2548
2613
|
|
|
2549
|
-
type Space$9 = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
2550
|
-
type Margin$9 = {
|
|
2551
|
-
top?: Space$9;
|
|
2552
|
-
bottom?: Space$9;
|
|
2553
|
-
left?: Space$9;
|
|
2554
|
-
right?: Space$9;
|
|
2555
|
-
};
|
|
2556
|
-
type SVG$5 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
2557
|
-
type ListOptionGroupType = {
|
|
2558
|
-
/**
|
|
2559
|
-
* Label of the group to be shown in the select's listbox.
|
|
2560
|
-
*/
|
|
2561
|
-
label: string;
|
|
2562
|
-
/**
|
|
2563
|
-
* List of the grouped options.
|
|
2564
|
-
*/
|
|
2565
|
-
options: ListOptionType[];
|
|
2566
|
-
};
|
|
2567
2614
|
type ListOptionType = {
|
|
2568
2615
|
/**
|
|
2569
2616
|
* Element used as the icon that will be placed before the option label.
|
|
@@ -2571,7 +2618,7 @@ type ListOptionType = {
|
|
|
2571
2618
|
* is the chosen one, take into account that the component's
|
|
2572
2619
|
* color styling tokens will not be applied to the image.
|
|
2573
2620
|
*/
|
|
2574
|
-
icon?: string | SVG
|
|
2621
|
+
icon?: string | SVG;
|
|
2575
2622
|
/**
|
|
2576
2623
|
* Label of the option to be shown in the select's listbox.
|
|
2577
2624
|
*/
|
|
@@ -2583,7 +2630,17 @@ type ListOptionType = {
|
|
|
2583
2630
|
*/
|
|
2584
2631
|
value: string;
|
|
2585
2632
|
};
|
|
2586
|
-
type
|
|
2633
|
+
type ListOptionGroupType = {
|
|
2634
|
+
/**
|
|
2635
|
+
* Label of the group to be shown in the select's listbox.
|
|
2636
|
+
*/
|
|
2637
|
+
label: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* List of the grouped options.
|
|
2640
|
+
*/
|
|
2641
|
+
options: ListOptionType[];
|
|
2642
|
+
};
|
|
2643
|
+
type CommonProps$2 = {
|
|
2587
2644
|
/**
|
|
2588
2645
|
* Text to be placed above the select.
|
|
2589
2646
|
*/
|
|
@@ -2637,7 +2694,7 @@ type CommonProps$1 = {
|
|
|
2637
2694
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2638
2695
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2639
2696
|
*/
|
|
2640
|
-
margin?: Space$
|
|
2697
|
+
margin?: Space$1 | Margin;
|
|
2641
2698
|
/**
|
|
2642
2699
|
* Size of the component.
|
|
2643
2700
|
*/
|
|
@@ -2646,8 +2703,16 @@ type CommonProps$1 = {
|
|
|
2646
2703
|
* Value of the tabindex attribute.
|
|
2647
2704
|
*/
|
|
2648
2705
|
tabIndex?: number;
|
|
2706
|
+
/**
|
|
2707
|
+
* Specifies a string to be used as the name for the select element when no `label` is provided.
|
|
2708
|
+
*/
|
|
2709
|
+
ariaLabel?: string;
|
|
2649
2710
|
};
|
|
2650
|
-
type SingleSelect = CommonProps$
|
|
2711
|
+
type SingleSelect = CommonProps$2 & {
|
|
2712
|
+
/**
|
|
2713
|
+
* Enables users to select multiple items from the list.
|
|
2714
|
+
*/
|
|
2715
|
+
enableSelectAll?: never;
|
|
2651
2716
|
/**
|
|
2652
2717
|
* If true, the select component will support multiple selected options.
|
|
2653
2718
|
* In that case, value will be an array of strings with each selected
|
|
@@ -2683,7 +2748,11 @@ type SingleSelect = CommonProps$1 & {
|
|
|
2683
2748
|
error?: string;
|
|
2684
2749
|
}) => void;
|
|
2685
2750
|
};
|
|
2686
|
-
type MultipleSelect = CommonProps$
|
|
2751
|
+
type MultipleSelect = CommonProps$2 & {
|
|
2752
|
+
/**
|
|
2753
|
+
* Enables users to select multiple items from the list.
|
|
2754
|
+
*/
|
|
2755
|
+
enableSelectAll?: boolean;
|
|
2687
2756
|
/**
|
|
2688
2757
|
* If true, the select component will support multiple selected options.
|
|
2689
2758
|
* In that case, value will be an array of strings with each selected
|
|
@@ -2719,66 +2788,57 @@ type MultipleSelect = CommonProps$1 & {
|
|
|
2719
2788
|
error?: string;
|
|
2720
2789
|
}) => void;
|
|
2721
2790
|
};
|
|
2722
|
-
type Props$
|
|
2791
|
+
type Props$b = SingleSelect | MultipleSelect;
|
|
2723
2792
|
|
|
2724
|
-
declare const DxcSelect: react.ForwardRefExoticComponent<Props$
|
|
2793
|
+
declare const DxcSelect: react.ForwardRefExoticComponent<Props$b & react.RefAttributes<HTMLDivElement>>;
|
|
2725
2794
|
|
|
2726
|
-
type
|
|
2727
|
-
type Margin$8 = {
|
|
2728
|
-
top?: Space$8;
|
|
2729
|
-
bottom?: Space$8;
|
|
2730
|
-
left?: Space$8;
|
|
2731
|
-
right?: Space$8;
|
|
2732
|
-
};
|
|
2733
|
-
type Props$b = {
|
|
2734
|
-
/**
|
|
2735
|
-
* Text to be placed above the slider.
|
|
2736
|
-
*/
|
|
2737
|
-
label?: string;
|
|
2795
|
+
type Props$a = {
|
|
2738
2796
|
/**
|
|
2739
|
-
*
|
|
2797
|
+
* Specifies a string to be used as the name for the slider element when no `label` is provided.
|
|
2740
2798
|
*/
|
|
2741
|
-
|
|
2799
|
+
ariaLabel?: string;
|
|
2742
2800
|
/**
|
|
2743
2801
|
* Initial value of the slider, only when it is uncontrolled.
|
|
2744
2802
|
*/
|
|
2745
2803
|
defaultValue?: number;
|
|
2746
2804
|
/**
|
|
2747
|
-
*
|
|
2805
|
+
* If true, the component will be disabled.
|
|
2748
2806
|
*/
|
|
2749
|
-
|
|
2807
|
+
disabled?: boolean;
|
|
2750
2808
|
/**
|
|
2751
2809
|
* Helper text to be placed above the slider.
|
|
2752
2810
|
*/
|
|
2753
2811
|
helperText?: string;
|
|
2754
2812
|
/**
|
|
2755
|
-
*
|
|
2813
|
+
* Text to be placed above the slider.
|
|
2756
2814
|
*/
|
|
2757
|
-
|
|
2815
|
+
label?: string;
|
|
2758
2816
|
/**
|
|
2759
|
-
*
|
|
2817
|
+
* This function will be used to format the labels displayed next to the slider.
|
|
2818
|
+
* The value will be passed as parameter and the function must return the formatted value.
|
|
2760
2819
|
*/
|
|
2761
|
-
|
|
2820
|
+
labelFormatCallback?: (value: number) => string;
|
|
2762
2821
|
/**
|
|
2763
|
-
*
|
|
2822
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2823
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2764
2824
|
*/
|
|
2765
|
-
|
|
2825
|
+
margin?: Space$1 | Margin;
|
|
2766
2826
|
/**
|
|
2767
|
-
* Whether the
|
|
2827
|
+
* Whether the marks between each step should be shown or not.
|
|
2768
2828
|
*/
|
|
2769
|
-
|
|
2829
|
+
marks?: boolean;
|
|
2770
2830
|
/**
|
|
2771
|
-
*
|
|
2831
|
+
* The maximum value available for selection.
|
|
2772
2832
|
*/
|
|
2773
|
-
|
|
2833
|
+
maxValue?: number;
|
|
2774
2834
|
/**
|
|
2775
|
-
*
|
|
2835
|
+
* The minimum value available for selection.
|
|
2776
2836
|
*/
|
|
2777
|
-
|
|
2837
|
+
minValue?: number;
|
|
2778
2838
|
/**
|
|
2779
|
-
*
|
|
2839
|
+
* Name attribute of the input element.
|
|
2780
2840
|
*/
|
|
2781
|
-
|
|
2841
|
+
name?: string;
|
|
2782
2842
|
/**
|
|
2783
2843
|
* This function will be called when the slider changes its value, as it's being dragged.
|
|
2784
2844
|
* The new value will be passed as a parameter when this function is executed.
|
|
@@ -2790,60 +2850,68 @@ type Props$b = {
|
|
|
2790
2850
|
*/
|
|
2791
2851
|
onDragEnd?: (value: number) => void;
|
|
2792
2852
|
/**
|
|
2793
|
-
*
|
|
2794
|
-
* The value will be passed as parameter and the function must return the formatted value.
|
|
2853
|
+
* Whether the input element for displaying/controlling the slider value should be displayed next to the slider.
|
|
2795
2854
|
*/
|
|
2796
|
-
|
|
2855
|
+
showInput?: boolean;
|
|
2797
2856
|
/**
|
|
2798
|
-
*
|
|
2799
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2857
|
+
* Whether the min/max value labels should be displayed next to the slider
|
|
2800
2858
|
*/
|
|
2801
|
-
|
|
2859
|
+
showLimitsValues?: boolean;
|
|
2802
2860
|
/**
|
|
2803
2861
|
* Size of the component.
|
|
2804
2862
|
*/
|
|
2805
2863
|
size?: "medium" | "large" | "fillParent";
|
|
2864
|
+
/**
|
|
2865
|
+
* The step interval between values available for selection.
|
|
2866
|
+
*/
|
|
2867
|
+
step?: number;
|
|
2868
|
+
/**
|
|
2869
|
+
* The selected value. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
2870
|
+
*/
|
|
2871
|
+
value?: number;
|
|
2806
2872
|
};
|
|
2807
2873
|
|
|
2808
|
-
declare const DxcSlider: react.ForwardRefExoticComponent<Props$
|
|
2874
|
+
declare const DxcSlider: react.ForwardRefExoticComponent<Props$a & react.RefAttributes<HTMLDivElement>>;
|
|
2809
2875
|
|
|
2810
|
-
type
|
|
2811
|
-
type Margin$7 = {
|
|
2812
|
-
top?: Space$7;
|
|
2813
|
-
bottom?: Space$7;
|
|
2814
|
-
left?: Space$7;
|
|
2815
|
-
right?: Space$7;
|
|
2816
|
-
};
|
|
2817
|
-
type Props$a = {
|
|
2876
|
+
type Props$9 = {
|
|
2818
2877
|
/**
|
|
2819
|
-
*
|
|
2878
|
+
* 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.
|
|
2820
2879
|
*/
|
|
2821
|
-
|
|
2880
|
+
ariaLabel?: string;
|
|
2822
2881
|
/**
|
|
2823
|
-
*
|
|
2824
|
-
*
|
|
2882
|
+
* If true, the color is inherited from the closest parent with a defined color. This allows users to adapt the spinner
|
|
2883
|
+
* to the semantic color of the use case in which it is used.
|
|
2825
2884
|
*/
|
|
2826
|
-
|
|
2885
|
+
inheritColor?: boolean;
|
|
2827
2886
|
/**
|
|
2828
|
-
*
|
|
2887
|
+
* Text to be placed inside the spinner.
|
|
2829
2888
|
*/
|
|
2830
|
-
|
|
2889
|
+
label?: string;
|
|
2890
|
+
/**
|
|
2891
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2892
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2893
|
+
*/
|
|
2894
|
+
margin?: Space$1 | Margin;
|
|
2831
2895
|
/**
|
|
2832
2896
|
* Available modes of the spinner.
|
|
2833
2897
|
*/
|
|
2834
2898
|
mode?: "large" | "small" | "overlay";
|
|
2835
2899
|
/**
|
|
2836
|
-
*
|
|
2837
|
-
|
|
2900
|
+
* If true, the value is displayed inside the spinner..
|
|
2901
|
+
*/
|
|
2902
|
+
showValue?: boolean;
|
|
2903
|
+
/**
|
|
2904
|
+
* The value of the progress indicator. If it's received the
|
|
2905
|
+
* component is determinate, otherwise is indeterminate.
|
|
2838
2906
|
*/
|
|
2839
|
-
|
|
2907
|
+
value?: number;
|
|
2840
2908
|
};
|
|
2841
2909
|
|
|
2842
|
-
declare const DxcSpinner: ({ label,
|
|
2910
|
+
declare const DxcSpinner: ({ ariaLabel, inheritColor, label, margin, mode, showValue, value, }: Props$9) => react_jsx_runtime.JSX.Element;
|
|
2843
2911
|
|
|
2844
2912
|
type Mode = "default" | "info" | "success" | "warning" | "error";
|
|
2845
2913
|
type Size = "small" | "medium" | "large";
|
|
2846
|
-
type Props$
|
|
2914
|
+
type Props$8 = {
|
|
2847
2915
|
/**
|
|
2848
2916
|
* It will define the color of the light based on its semantic meaning.
|
|
2849
2917
|
*/
|
|
@@ -2858,30 +2926,26 @@ type Props$9 = {
|
|
|
2858
2926
|
size?: Size;
|
|
2859
2927
|
};
|
|
2860
2928
|
|
|
2861
|
-
declare
|
|
2929
|
+
declare function DxcStatusLight({ label, mode, size }: Props$8): react_jsx_runtime.JSX.Element;
|
|
2862
2930
|
|
|
2863
|
-
type
|
|
2864
|
-
type Margin$6 = {
|
|
2865
|
-
top?: Space$6;
|
|
2866
|
-
bottom?: Space$6;
|
|
2867
|
-
left?: Space$6;
|
|
2868
|
-
right?: Space$6;
|
|
2869
|
-
};
|
|
2870
|
-
type Props$8 = {
|
|
2931
|
+
type Props$7 = {
|
|
2871
2932
|
/**
|
|
2872
|
-
*
|
|
2933
|
+
* Specifies a string to be used as the name for the switch element when no `label` is provided.
|
|
2873
2934
|
*/
|
|
2874
|
-
|
|
2935
|
+
ariaLabel?: string;
|
|
2875
2936
|
/**
|
|
2876
2937
|
* If true, the component is checked. If undefined, the component will be uncontrolled
|
|
2877
2938
|
* and the checked attribute will be managed internally by the component.
|
|
2878
2939
|
*/
|
|
2879
2940
|
checked?: boolean;
|
|
2880
2941
|
/**
|
|
2881
|
-
*
|
|
2882
|
-
* this value will be only submitted if the switch is checked.
|
|
2942
|
+
* Initial state of the switch, only when it is uncontrolled.
|
|
2883
2943
|
*/
|
|
2884
|
-
|
|
2944
|
+
defaultChecked?: boolean;
|
|
2945
|
+
/**
|
|
2946
|
+
* If true, the component will be disabled.
|
|
2947
|
+
*/
|
|
2948
|
+
disabled?: boolean;
|
|
2885
2949
|
/**
|
|
2886
2950
|
* Text to be placed next to the switch.
|
|
2887
2951
|
*/
|
|
@@ -2891,13 +2955,14 @@ type Props$8 = {
|
|
|
2891
2955
|
*/
|
|
2892
2956
|
labelPosition?: "before" | "after";
|
|
2893
2957
|
/**
|
|
2894
|
-
*
|
|
2958
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2959
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2895
2960
|
*/
|
|
2896
|
-
|
|
2961
|
+
margin?: Space$1 | Margin;
|
|
2897
2962
|
/**
|
|
2898
|
-
*
|
|
2963
|
+
* Name attribute of the input element.
|
|
2899
2964
|
*/
|
|
2900
|
-
|
|
2965
|
+
name?: string;
|
|
2901
2966
|
/**
|
|
2902
2967
|
* This function will be called when the user changes the state of the switch.
|
|
2903
2968
|
* The new value of the checked attribute will be passed as a parameter.
|
|
@@ -2907,11 +2972,6 @@ type Props$8 = {
|
|
|
2907
2972
|
* If true, the component will display '(Optional)' next to the label.
|
|
2908
2973
|
*/
|
|
2909
2974
|
optional?: boolean;
|
|
2910
|
-
/**
|
|
2911
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
2912
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
2913
|
-
*/
|
|
2914
|
-
margin?: Space$6 | Margin$6;
|
|
2915
2975
|
/**
|
|
2916
2976
|
* Size of the component.
|
|
2917
2977
|
*/
|
|
@@ -2920,23 +2980,20 @@ type Props$8 = {
|
|
|
2920
2980
|
* Value of the tabindex.
|
|
2921
2981
|
*/
|
|
2922
2982
|
tabIndex?: number;
|
|
2983
|
+
/**
|
|
2984
|
+
* Will be passed to the value attribute of the html input element. When inside a form,
|
|
2985
|
+
* this value will be only submitted if the switch is checked.
|
|
2986
|
+
*/
|
|
2987
|
+
value?: string;
|
|
2923
2988
|
};
|
|
2924
2989
|
|
|
2925
|
-
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$
|
|
2990
|
+
declare const DxcSwitch: react.ForwardRefExoticComponent<Props$7 & react.RefAttributes<HTMLDivElement>>;
|
|
2926
2991
|
|
|
2927
2992
|
declare const DxcTable: {
|
|
2928
|
-
({ children, margin, mode }: Props$
|
|
2929
|
-
ActionsCell: ({ actions }:
|
|
2993
|
+
({ children, margin, mode }: Props$t): react_jsx_runtime.JSX.Element;
|
|
2994
|
+
ActionsCell: ({ actions }: ActionsCellPropsType) => react_jsx_runtime.JSX.Element;
|
|
2930
2995
|
};
|
|
2931
2996
|
|
|
2932
|
-
type Space$5 = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
2933
|
-
type Margin$5 = {
|
|
2934
|
-
top?: Space$5;
|
|
2935
|
-
bottom?: Space$5;
|
|
2936
|
-
left?: Space$5;
|
|
2937
|
-
right?: Space$5;
|
|
2938
|
-
};
|
|
2939
|
-
type SVG$4 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
2940
2997
|
type TabCommonProps = {
|
|
2941
2998
|
/**
|
|
2942
2999
|
* Whether the tab is disabled or not.
|
|
@@ -2951,7 +3008,7 @@ type TabCommonProps = {
|
|
|
2951
3008
|
*/
|
|
2952
3009
|
notificationNumber?: boolean | number;
|
|
2953
3010
|
};
|
|
2954
|
-
type TabLabelProps =
|
|
3011
|
+
type TabLabelProps = {
|
|
2955
3012
|
/**
|
|
2956
3013
|
* Tab label.
|
|
2957
3014
|
*/
|
|
@@ -2959,9 +3016,9 @@ type TabLabelProps = TabCommonProps & {
|
|
|
2959
3016
|
/**
|
|
2960
3017
|
* Material Symbol name or SVG element used as the icon that will be displayed in the tab.
|
|
2961
3018
|
*/
|
|
2962
|
-
icon?: string | SVG
|
|
3019
|
+
icon?: string | SVG;
|
|
2963
3020
|
};
|
|
2964
|
-
type TabIconProps =
|
|
3021
|
+
type TabIconProps = {
|
|
2965
3022
|
/**
|
|
2966
3023
|
* Tab label.
|
|
2967
3024
|
*/
|
|
@@ -2969,177 +3026,162 @@ type TabIconProps = TabCommonProps & {
|
|
|
2969
3026
|
/**
|
|
2970
3027
|
* Material Symbol name or SVG element used as the icon that will be displayed in the tab.
|
|
2971
3028
|
*/
|
|
2972
|
-
icon: string | SVG
|
|
3029
|
+
icon: string | SVG;
|
|
2973
3030
|
};
|
|
2974
|
-
type
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
3031
|
+
type TabProps = {
|
|
3032
|
+
defaultActive?: boolean;
|
|
3033
|
+
active?: boolean;
|
|
3034
|
+
title?: string;
|
|
3035
|
+
tabId?: string;
|
|
3036
|
+
disabled?: boolean;
|
|
3037
|
+
notificationNumber?: boolean | number;
|
|
3038
|
+
children: ReactNode;
|
|
3039
|
+
onClick?: () => void;
|
|
3040
|
+
onHover?: () => void;
|
|
3041
|
+
} & (TabLabelProps | TabIconProps);
|
|
3042
|
+
type LegacyProps = {
|
|
2979
3043
|
/**
|
|
3044
|
+
* @deprecated This prop is deprecated and will be removed in future versions. Use the children prop instead.
|
|
2980
3045
|
* The index of the active tab. If undefined, the component will be
|
|
2981
3046
|
* uncontrolled and the active tab will be managed internally by the component.
|
|
2982
3047
|
*/
|
|
2983
3048
|
activeTabIndex?: number;
|
|
2984
3049
|
/**
|
|
2985
|
-
*
|
|
3050
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3051
|
+
* Initially active tab, only when it is uncontrolled.
|
|
2986
3052
|
*/
|
|
2987
|
-
|
|
3053
|
+
defaultActiveTabIndex?: number;
|
|
2988
3054
|
/**
|
|
2989
3055
|
* Whether the icon should appear above or to the left of the label.
|
|
2990
3056
|
*/
|
|
2991
3057
|
iconPosition?: "top" | "left";
|
|
2992
3058
|
/**
|
|
3059
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3060
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3061
|
+
*/
|
|
3062
|
+
margin?: Space$1 | Margin;
|
|
3063
|
+
/**
|
|
3064
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
2993
3065
|
* This function will be called when the user clicks on a tab. The index of the
|
|
2994
3066
|
* clicked tab will be passed as a parameter.
|
|
2995
3067
|
*/
|
|
2996
3068
|
onTabClick?: (index: number) => void;
|
|
2997
3069
|
/**
|
|
3070
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
2998
3071
|
* This function will be called when the user hovers a tab.The index of the
|
|
2999
3072
|
* hovered tab will be passed as a parameter.
|
|
3000
3073
|
*/
|
|
3001
|
-
onTabHover?: (index: number) => void;
|
|
3002
|
-
/**
|
|
3003
|
-
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3004
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3005
|
-
*/
|
|
3006
|
-
margin?: Space$5 | Margin$5;
|
|
3074
|
+
onTabHover?: (index: number | null) => void;
|
|
3007
3075
|
/**
|
|
3008
3076
|
* Value of the tabindex attribute applied to each tab.
|
|
3009
3077
|
*/
|
|
3010
3078
|
tabIndex?: number;
|
|
3011
|
-
};
|
|
3012
|
-
|
|
3013
|
-
declare const DxcTabs: ({ defaultActiveTabIndex, activeTabIndex, tabs, onTabClick, onTabHover, margin, iconPosition, tabIndex, }: Props$7) => JSX.Element;
|
|
3014
|
-
|
|
3015
|
-
type Space$4 = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
3016
|
-
type Margin$4 = {
|
|
3017
|
-
top?: Space$4;
|
|
3018
|
-
bottom?: Space$4;
|
|
3019
|
-
left?: Space$4;
|
|
3020
|
-
right?: Space$4;
|
|
3021
|
-
};
|
|
3022
|
-
type SVG$3 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
3023
|
-
type TagCommonProps = {
|
|
3024
|
-
/**
|
|
3025
|
-
* If defined, the tag will be displayed as an anchor, using this prop as "href".
|
|
3026
|
-
* Component will show some visual feedback on hover.
|
|
3027
|
-
*/
|
|
3028
|
-
linkHref?: string;
|
|
3029
|
-
/**
|
|
3030
|
-
* If defined, the tag will be displayed as a button. This function will
|
|
3031
|
-
* be called when the user clicks the tag. Component will show some
|
|
3032
|
-
* visual feedback on hover.
|
|
3033
|
-
*/
|
|
3034
|
-
onClick?: () => void;
|
|
3035
|
-
/**
|
|
3036
|
-
* Background color of the icon section of the tag.
|
|
3037
|
-
*/
|
|
3038
|
-
iconBgColor?: string;
|
|
3039
3079
|
/**
|
|
3040
|
-
*
|
|
3080
|
+
* @deprecated This prop is deprecated and will be removed in future versions.
|
|
3081
|
+
* An array of objects representing the tabs.
|
|
3041
3082
|
*/
|
|
3042
|
-
|
|
3083
|
+
tabs?: (TabCommonProps & (TabLabelProps | TabIconProps))[];
|
|
3084
|
+
};
|
|
3085
|
+
type NewProps = {
|
|
3043
3086
|
/**
|
|
3044
|
-
*
|
|
3087
|
+
* Whether the icon should appear above or to the left of the label.
|
|
3045
3088
|
*/
|
|
3046
|
-
|
|
3089
|
+
iconPosition?: "top" | "left";
|
|
3047
3090
|
/**
|
|
3048
3091
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3049
3092
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3050
3093
|
*/
|
|
3051
|
-
margin?: Space$
|
|
3052
|
-
/**
|
|
3053
|
-
* Size of the component.
|
|
3054
|
-
*/
|
|
3055
|
-
size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
|
|
3094
|
+
margin?: Space$1 | Margin;
|
|
3056
3095
|
/**
|
|
3057
|
-
* Value of the tabindex attribute.
|
|
3096
|
+
* Value of the tabindex attribute applied to each tab.
|
|
3058
3097
|
*/
|
|
3059
3098
|
tabIndex?: number;
|
|
3060
|
-
};
|
|
3061
|
-
type TagLabelProps = TagCommonProps & {
|
|
3062
|
-
/**
|
|
3063
|
-
* Material Symbol name or SVG element used as the icon that will be placed next to the label.
|
|
3064
|
-
*/
|
|
3065
|
-
icon?: string | SVG$3;
|
|
3066
|
-
/**
|
|
3067
|
-
* Text to be placed next inside the tag.
|
|
3068
|
-
*/
|
|
3069
|
-
label: string;
|
|
3070
|
-
};
|
|
3071
|
-
type TagIconProps = TagCommonProps & {
|
|
3072
|
-
/**
|
|
3073
|
-
* Material Symbol name or SVG element used as the icon that will be placed next to the label.
|
|
3074
|
-
*/
|
|
3075
|
-
icon: string | SVG$3;
|
|
3076
3099
|
/**
|
|
3077
|
-
*
|
|
3100
|
+
* Contains one or more DxcTabs.Tab.
|
|
3078
3101
|
*/
|
|
3079
|
-
|
|
3102
|
+
children?: ReactNode;
|
|
3080
3103
|
};
|
|
3081
|
-
type Props$6 =
|
|
3104
|
+
type Props$6 = LegacyProps & NewProps;
|
|
3082
3105
|
|
|
3083
|
-
declare const
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
type Margin$3 = {
|
|
3087
|
-
top?: Space$3;
|
|
3088
|
-
bottom?: Space$3;
|
|
3089
|
-
left?: Space$3;
|
|
3090
|
-
right?: Space$3;
|
|
3106
|
+
declare const DxcTabs: {
|
|
3107
|
+
({ activeTabIndex, children, defaultActiveTabIndex, iconPosition, margin, onTabClick, onTabHover, tabIndex, tabs, }: Props$6): false | react_jsx_runtime.JSX.Element;
|
|
3108
|
+
Tab: react.ForwardRefExoticComponent<TabProps & react.RefAttributes<HTMLButtonElement>>;
|
|
3091
3109
|
};
|
|
3110
|
+
|
|
3092
3111
|
type Props$5 = {
|
|
3093
3112
|
/**
|
|
3094
|
-
*
|
|
3113
|
+
* Specifies a string to be used as the name for the textarea element when no `label` is provided.
|
|
3095
3114
|
*/
|
|
3096
|
-
|
|
3115
|
+
ariaLabel?: string;
|
|
3097
3116
|
/**
|
|
3098
|
-
*
|
|
3117
|
+
* HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the textarea value.
|
|
3118
|
+
* Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
|
|
3099
3119
|
*/
|
|
3100
|
-
|
|
3120
|
+
autocomplete?: string;
|
|
3121
|
+
/**
|
|
3122
|
+
* If true, the component will be disabled.
|
|
3123
|
+
*/
|
|
3124
|
+
disabled?: boolean;
|
|
3101
3125
|
/**
|
|
3102
3126
|
* Initial value of the textarea, only when it is uncontrolled.
|
|
3103
3127
|
*/
|
|
3104
3128
|
defaultValue?: string;
|
|
3105
3129
|
/**
|
|
3106
|
-
*
|
|
3130
|
+
* If it is a defined value and also a truthy string, the component will
|
|
3131
|
+
* change its appearance, showing the error below the textarea. If the
|
|
3132
|
+
* defined value is an empty string, it will reserve a space below the
|
|
3133
|
+
* component for a future error, but it would not change its look. In
|
|
3134
|
+
* case of being undefined or null, both the appearance and the space for
|
|
3135
|
+
* the error message would not be modified.
|
|
3107
3136
|
*/
|
|
3108
|
-
|
|
3137
|
+
error?: string;
|
|
3109
3138
|
/**
|
|
3110
3139
|
* Helper text to be placed above the textarea.
|
|
3111
3140
|
*/
|
|
3112
3141
|
helperText?: string;
|
|
3113
3142
|
/**
|
|
3114
|
-
* Text to be
|
|
3143
|
+
* Text to be placed above the textarea.
|
|
3115
3144
|
*/
|
|
3116
|
-
|
|
3145
|
+
label?: string;
|
|
3117
3146
|
/**
|
|
3118
|
-
*
|
|
3147
|
+
* Specifies the maximum length allowed by the textarea.
|
|
3148
|
+
* This will be checked both when the textarea loses the
|
|
3149
|
+
* focus and while typing within it. If the string entered does not
|
|
3150
|
+
* comply the maximum length, the onBlur and onChange functions will be called
|
|
3151
|
+
* with the current value and an internal error informing that the value
|
|
3152
|
+
* length does not comply the specified range. If a valid length is
|
|
3153
|
+
* reached, the error parameter of both events will not be defined.
|
|
3119
3154
|
*/
|
|
3120
|
-
|
|
3155
|
+
maxLength?: number;
|
|
3121
3156
|
/**
|
|
3122
|
-
*
|
|
3157
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3158
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3123
3159
|
*/
|
|
3124
|
-
|
|
3160
|
+
margin?: Space$1 | Margin;
|
|
3125
3161
|
/**
|
|
3126
|
-
*
|
|
3127
|
-
*
|
|
3128
|
-
* and
|
|
3129
|
-
*
|
|
3162
|
+
* Specifies the minimum length allowed by the textarea.
|
|
3163
|
+
* This will be checked both when the textarea loses the
|
|
3164
|
+
* focus and while typing within it. If the string entered does not
|
|
3165
|
+
* comply the minimum length, the onBlur and onChange functions will be called
|
|
3166
|
+
* with the current value and an internal error informing that the value
|
|
3167
|
+
* length does not comply the specified range. If a valid length is
|
|
3168
|
+
* reached, the error parameter of both events will not be defined.
|
|
3130
3169
|
*/
|
|
3131
|
-
|
|
3170
|
+
minLength?: number;
|
|
3132
3171
|
/**
|
|
3133
|
-
*
|
|
3134
|
-
* - 'auto': The textarea grows or shrinks automatically in order to fit the content.
|
|
3135
|
-
* - 'manual': The height of the textarea is enabled to be manually modified.
|
|
3136
|
-
* - 'none': The textarea has a fixed height and can't be modified.
|
|
3172
|
+
* Name attribute of the textarea element.
|
|
3137
3173
|
*/
|
|
3138
|
-
|
|
3174
|
+
name?: string;
|
|
3139
3175
|
/**
|
|
3140
|
-
*
|
|
3176
|
+
* This function will be called when the textarea loses the focus. An
|
|
3177
|
+
* object including the textarea value and the error (if the value entered
|
|
3178
|
+
* is not valid) will be passed to this function. If there is no error,
|
|
3179
|
+
* error will not be defined.
|
|
3141
3180
|
*/
|
|
3142
|
-
|
|
3181
|
+
onBlur?: (val: {
|
|
3182
|
+
value: string;
|
|
3183
|
+
error?: string;
|
|
3184
|
+
}) => void;
|
|
3143
3185
|
/**
|
|
3144
3186
|
* This function will be called when the user types within the textarea.
|
|
3145
3187
|
* An object including the current value and the error (if the value
|
|
@@ -3151,24 +3193,12 @@ type Props$5 = {
|
|
|
3151
3193
|
error?: string;
|
|
3152
3194
|
}) => void;
|
|
3153
3195
|
/**
|
|
3154
|
-
*
|
|
3155
|
-
*
|
|
3156
|
-
*
|
|
3157
|
-
*
|
|
3158
|
-
*/
|
|
3159
|
-
onBlur?: (val: {
|
|
3160
|
-
value: string;
|
|
3161
|
-
error?: string;
|
|
3162
|
-
}) => void;
|
|
3163
|
-
/**
|
|
3164
|
-
* If it is a defined value and also a truthy string, the component will
|
|
3165
|
-
* change its appearance, showing the error below the textarea. If the
|
|
3166
|
-
* defined value is an empty string, it will reserve a space below the
|
|
3167
|
-
* component for a future error, but it would not change its look. In
|
|
3168
|
-
* case of being undefined or null, both the appearance and the space for
|
|
3169
|
-
* the error message would not be modified.
|
|
3196
|
+
* If true, the textarea will be optional, showing '(Optional)'
|
|
3197
|
+
* next to the label. Otherwise, the field will be considered required
|
|
3198
|
+
* and an error will be passed as a parameter to the OnBlur and onChange functions
|
|
3199
|
+
* when it has not been filled.
|
|
3170
3200
|
*/
|
|
3171
|
-
|
|
3201
|
+
optional?: boolean;
|
|
3172
3202
|
/**
|
|
3173
3203
|
* Regular expression that defines the valid format allowed by the
|
|
3174
3204
|
* textarea. This will be checked both when the textarea loses the focus
|
|
@@ -3180,35 +3210,17 @@ type Props$5 = {
|
|
|
3180
3210
|
*/
|
|
3181
3211
|
pattern?: string;
|
|
3182
3212
|
/**
|
|
3183
|
-
*
|
|
3184
|
-
* This will be checked both when the textarea loses the
|
|
3185
|
-
* focus and while typing within it. If the string entered does not
|
|
3186
|
-
* comply the minimum length, the onBlur and onChange functions will be called
|
|
3187
|
-
* with the current value and an internal error informing that the value
|
|
3188
|
-
* length does not comply the specified range. If a valid length is
|
|
3189
|
-
* reached, the error parameter of both events will not be defined.
|
|
3190
|
-
*/
|
|
3191
|
-
minLength?: number;
|
|
3192
|
-
/**
|
|
3193
|
-
* Specifies the maximum length allowed by the textarea.
|
|
3194
|
-
* This will be checked both when the textarea loses the
|
|
3195
|
-
* focus and while typing within it. If the string entered does not
|
|
3196
|
-
* comply the maximum length, the onBlur and onChange functions will be called
|
|
3197
|
-
* with the current value and an internal error informing that the value
|
|
3198
|
-
* length does not comply the specified range. If a valid length is
|
|
3199
|
-
* reached, the error parameter of both events will not be defined.
|
|
3213
|
+
* Text to be put as placeholder of the textarea.
|
|
3200
3214
|
*/
|
|
3201
|
-
|
|
3215
|
+
placeholder?: string;
|
|
3202
3216
|
/**
|
|
3203
|
-
*
|
|
3204
|
-
* Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
|
|
3217
|
+
* If true, the component will not be mutable, meaning the user can not edit the control.
|
|
3205
3218
|
*/
|
|
3206
|
-
|
|
3219
|
+
readOnly?: boolean;
|
|
3207
3220
|
/**
|
|
3208
|
-
*
|
|
3209
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3221
|
+
* Number of rows of the textarea.
|
|
3210
3222
|
*/
|
|
3211
|
-
|
|
3223
|
+
rows?: number;
|
|
3212
3224
|
/**
|
|
3213
3225
|
* Size of the component.
|
|
3214
3226
|
*/
|
|
@@ -3217,19 +3229,22 @@ type Props$5 = {
|
|
|
3217
3229
|
* Value of the tabindex attribute.
|
|
3218
3230
|
*/
|
|
3219
3231
|
tabIndex?: number;
|
|
3232
|
+
/**
|
|
3233
|
+
* Value of the textarea. If undefined, the component will be uncontrolled and the value will be managed internally.
|
|
3234
|
+
*/
|
|
3235
|
+
value?: string;
|
|
3236
|
+
/**
|
|
3237
|
+
* Defines the textarea's ability to resize vertically. It can be:
|
|
3238
|
+
* - 'auto': The textarea grows or shrinks automatically in order to fit the content.
|
|
3239
|
+
* - 'manual': The height of the textarea is enabled to be manually modified.
|
|
3240
|
+
* - 'none': The textarea has a fixed height and can't be modified.
|
|
3241
|
+
*/
|
|
3242
|
+
verticalGrow?: "auto" | "manual" | "none";
|
|
3220
3243
|
};
|
|
3221
3244
|
|
|
3222
3245
|
declare const DxcTextarea: react.ForwardRefExoticComponent<Props$5 & react.RefAttributes<HTMLDivElement>>;
|
|
3223
3246
|
|
|
3224
|
-
type
|
|
3225
|
-
type Margin$2 = {
|
|
3226
|
-
top?: Space$2;
|
|
3227
|
-
bottom?: Space$2;
|
|
3228
|
-
left?: Space$2;
|
|
3229
|
-
right?: Space$2;
|
|
3230
|
-
};
|
|
3231
|
-
type SVG$2 = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
3232
|
-
type Action = {
|
|
3247
|
+
type Action$1 = {
|
|
3233
3248
|
/**
|
|
3234
3249
|
* This function will be called when the user clicks the action.
|
|
3235
3250
|
*/
|
|
@@ -3237,7 +3252,7 @@ type Action = {
|
|
|
3237
3252
|
/**
|
|
3238
3253
|
* Icon to be placed in the action..
|
|
3239
3254
|
*/
|
|
3240
|
-
icon: string | SVG
|
|
3255
|
+
icon: string | SVG;
|
|
3241
3256
|
/**
|
|
3242
3257
|
* Text representing advisory information related
|
|
3243
3258
|
* to the button's action. Under the hood, this prop also serves
|
|
@@ -3273,7 +3288,7 @@ type Props$4 = {
|
|
|
3273
3288
|
/**
|
|
3274
3289
|
* Action to be shown in the input.
|
|
3275
3290
|
*/
|
|
3276
|
-
action?: Action;
|
|
3291
|
+
action?: Action$1;
|
|
3277
3292
|
/**
|
|
3278
3293
|
* If true, the input will have an action to clear the entered value.
|
|
3279
3294
|
*/
|
|
@@ -3379,7 +3394,7 @@ type Props$4 = {
|
|
|
3379
3394
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3380
3395
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3381
3396
|
*/
|
|
3382
|
-
margin?: Space$
|
|
3397
|
+
margin?: Space$1 | Margin;
|
|
3383
3398
|
/**
|
|
3384
3399
|
* Size of the component.
|
|
3385
3400
|
*/
|
|
@@ -3388,27 +3403,78 @@ type Props$4 = {
|
|
|
3388
3403
|
* Value of the tabindex attribute.
|
|
3389
3404
|
*/
|
|
3390
3405
|
tabIndex?: number;
|
|
3406
|
+
/**
|
|
3407
|
+
* Specifies a string to be used as the name for the textInput element when no `label` is provided.
|
|
3408
|
+
*/
|
|
3409
|
+
ariaLabel?: string;
|
|
3391
3410
|
};
|
|
3392
3411
|
|
|
3393
3412
|
declare const DxcTextInput: react.ForwardRefExoticComponent<Props$4 & react.RefAttributes<HTMLDivElement>>;
|
|
3394
3413
|
|
|
3395
|
-
type
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3414
|
+
type Action = {
|
|
3415
|
+
/**
|
|
3416
|
+
* The icon of the action. It can be a string with the name of the icon or an SVG component.
|
|
3417
|
+
*/
|
|
3418
|
+
icon?: string | SVG;
|
|
3419
|
+
/**
|
|
3420
|
+
* The label of the action.
|
|
3421
|
+
*/
|
|
3422
|
+
label: string;
|
|
3423
|
+
/**
|
|
3424
|
+
* The function that will be executed when the user clicks on the action button.
|
|
3425
|
+
*/
|
|
3426
|
+
onClick: () => void;
|
|
3401
3427
|
};
|
|
3402
|
-
type
|
|
3403
|
-
type OptionIcon = {
|
|
3428
|
+
type CommonProps$1 = {
|
|
3404
3429
|
/**
|
|
3405
|
-
*
|
|
3430
|
+
* Tertiary button which performs a custom action, specified by the user.
|
|
3406
3431
|
*/
|
|
3407
|
-
|
|
3432
|
+
action?: Action;
|
|
3433
|
+
/**
|
|
3434
|
+
* Message to be displayed as a toast.
|
|
3435
|
+
*/
|
|
3436
|
+
message: string;
|
|
3437
|
+
};
|
|
3438
|
+
type DefaultToast = CommonProps$1 & {
|
|
3439
|
+
/**
|
|
3440
|
+
* Material Symbol name or SVG element as the icon that will be placed next to the panel label.
|
|
3441
|
+
* When using Material Symbols, replace spaces with underscores.
|
|
3442
|
+
* By default they are outlined if you want it to be filled prefix the symbol name with "filled_".
|
|
3443
|
+
*/
|
|
3444
|
+
icon?: string | SVG;
|
|
3445
|
+
};
|
|
3446
|
+
type LoadingToast = CommonProps$1 & {
|
|
3447
|
+
loading: boolean;
|
|
3448
|
+
};
|
|
3449
|
+
type SemanticToast = CommonProps$1 & {
|
|
3450
|
+
/**
|
|
3451
|
+
* Flag that allows to hide the semantic icon of the toast.
|
|
3452
|
+
*/
|
|
3453
|
+
hideSemanticIcon?: boolean;
|
|
3454
|
+
};
|
|
3455
|
+
type ToastsQueuePropsType = {
|
|
3456
|
+
/**
|
|
3457
|
+
* Tree of components from which the useToast hook can be triggered.
|
|
3458
|
+
*/
|
|
3459
|
+
children: ReactNode;
|
|
3460
|
+
/**
|
|
3461
|
+
* Duration in milliseconds before a toast automatically hides itself.
|
|
3462
|
+
* The range goes from 3000ms to 5000ms, any other value will not be taken into consideration.
|
|
3463
|
+
*/
|
|
3464
|
+
duration?: number;
|
|
3465
|
+
};
|
|
3466
|
+
|
|
3467
|
+
declare function DxcToastsQueue({ children, duration }: ToastsQueuePropsType): react_jsx_runtime.JSX.Element;
|
|
3468
|
+
|
|
3469
|
+
type OptionIcon = {
|
|
3408
3470
|
/**
|
|
3409
3471
|
* Material Symbols icon or SVG element. Icon and label can't be used at same time.
|
|
3410
3472
|
*/
|
|
3411
|
-
icon: string | SVG
|
|
3473
|
+
icon: string | SVG;
|
|
3474
|
+
/**
|
|
3475
|
+
* String with the option display value.
|
|
3476
|
+
*/
|
|
3477
|
+
label?: never;
|
|
3412
3478
|
/**
|
|
3413
3479
|
* Value for the HTML properties title and aria-label.
|
|
3414
3480
|
* When a label is defined, this prop can not be use.
|
|
@@ -3417,13 +3483,13 @@ type OptionIcon = {
|
|
|
3417
3483
|
};
|
|
3418
3484
|
type OptionLabel = {
|
|
3419
3485
|
/**
|
|
3420
|
-
*
|
|
3486
|
+
* Material Symbols icon or SVG element. Icon and label can't be used at same time.
|
|
3421
3487
|
*/
|
|
3422
|
-
|
|
3488
|
+
icon?: string | SVG;
|
|
3423
3489
|
/**
|
|
3424
|
-
*
|
|
3490
|
+
* String with the option display value.
|
|
3425
3491
|
*/
|
|
3426
|
-
|
|
3492
|
+
label: string;
|
|
3427
3493
|
/**
|
|
3428
3494
|
* Value for the HTML properties title and aria-label.
|
|
3429
3495
|
* When a label is defined, this prop can not be use.
|
|
@@ -3431,6 +3497,10 @@ type OptionLabel = {
|
|
|
3431
3497
|
title?: never;
|
|
3432
3498
|
};
|
|
3433
3499
|
type Option = {
|
|
3500
|
+
/**
|
|
3501
|
+
* If true, the option will be disabled.
|
|
3502
|
+
*/
|
|
3503
|
+
disabled?: boolean;
|
|
3434
3504
|
/**
|
|
3435
3505
|
* Number with the option inner value.
|
|
3436
3506
|
*/
|
|
@@ -3438,119 +3508,103 @@ type Option = {
|
|
|
3438
3508
|
} & (OptionIcon | OptionLabel);
|
|
3439
3509
|
type CommonProps = {
|
|
3440
3510
|
/**
|
|
3441
|
-
*
|
|
3442
|
-
|
|
3443
|
-
label?: string;
|
|
3444
|
-
/**
|
|
3445
|
-
* Helper text to be placed above the component.
|
|
3446
|
-
*/
|
|
3447
|
-
helperText?: string;
|
|
3448
|
-
/**
|
|
3449
|
-
* If true, the component will be disabled.
|
|
3511
|
+
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3512
|
+
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3450
3513
|
*/
|
|
3451
|
-
|
|
3514
|
+
margin?: Space$1 | Margin;
|
|
3452
3515
|
/**
|
|
3453
3516
|
* An array of objects representing the selectable options.
|
|
3454
3517
|
*/
|
|
3455
3518
|
options: Option[];
|
|
3456
3519
|
/**
|
|
3457
|
-
*
|
|
3458
|
-
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3520
|
+
* The orientation of the toggle group.
|
|
3459
3521
|
*/
|
|
3460
|
-
|
|
3522
|
+
orientation?: "horizontal" | "vertical";
|
|
3461
3523
|
/**
|
|
3462
3524
|
* Value of the tabindex.
|
|
3463
3525
|
*/
|
|
3464
3526
|
tabIndex?: number;
|
|
3465
3527
|
};
|
|
3466
|
-
type
|
|
3528
|
+
type MultipleSelectionToggleGroup = {
|
|
3529
|
+
/**
|
|
3530
|
+
* The array of keys with the initially selected values.
|
|
3531
|
+
*/
|
|
3532
|
+
defaultValue?: number[];
|
|
3467
3533
|
/**
|
|
3468
3534
|
* If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
|
|
3469
3535
|
*/
|
|
3470
|
-
multiple
|
|
3536
|
+
multiple: true;
|
|
3471
3537
|
/**
|
|
3472
|
-
*
|
|
3538
|
+
* This function will be called every time the selection changes. An array with the key of
|
|
3539
|
+
* the selected values will be passed as a parameter to this function.
|
|
3473
3540
|
*/
|
|
3474
|
-
|
|
3541
|
+
onChange?: (optionIndex: number[]) => void;
|
|
3475
3542
|
/**
|
|
3476
|
-
*
|
|
3543
|
+
* An array with the keys of the selected values.
|
|
3477
3544
|
* If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3478
3545
|
*/
|
|
3479
|
-
value?: number;
|
|
3546
|
+
value?: number[];
|
|
3547
|
+
};
|
|
3548
|
+
type SingleSelectionToggleGroup = {
|
|
3480
3549
|
/**
|
|
3481
|
-
*
|
|
3482
|
-
* value will be passed as a parameter to this function.
|
|
3550
|
+
* The key of the initially selected value.
|
|
3483
3551
|
*/
|
|
3484
|
-
|
|
3485
|
-
};
|
|
3486
|
-
type MultipleSelectionToggleGroup = CommonProps & {
|
|
3552
|
+
defaultValue?: number;
|
|
3487
3553
|
/**
|
|
3488
3554
|
* If true, the toggle group will support multiple selection. In that case, value must be an array of numbers with the keys of the selected values.
|
|
3489
3555
|
*/
|
|
3490
|
-
multiple
|
|
3556
|
+
multiple?: false;
|
|
3491
3557
|
/**
|
|
3492
|
-
*
|
|
3558
|
+
* This function will be called every time the selection changes. The number with the key of the selected
|
|
3559
|
+
* value will be passed as a parameter to this function.
|
|
3493
3560
|
*/
|
|
3494
|
-
|
|
3561
|
+
onChange?: (optionIndex: number) => void;
|
|
3495
3562
|
/**
|
|
3496
|
-
*
|
|
3563
|
+
* The key of the selected value. If the component allows multiple selection, value must be an array.
|
|
3497
3564
|
* If undefined, the component will be uncontrolled and the value will be managed internally by the component.
|
|
3498
3565
|
*/
|
|
3499
|
-
value?: number
|
|
3500
|
-
/**
|
|
3501
|
-
* This function will be called every time the selection changes. An array with the key of
|
|
3502
|
-
* the selected values will be passed as a parameter to this function.
|
|
3503
|
-
*/
|
|
3504
|
-
onChange?: (optionIndex: number[]) => void;
|
|
3566
|
+
value?: number;
|
|
3505
3567
|
};
|
|
3506
|
-
type Props$3 =
|
|
3568
|
+
type Props$3 = CommonProps & (MultipleSelectionToggleGroup | SingleSelectionToggleGroup);
|
|
3507
3569
|
|
|
3508
|
-
declare
|
|
3570
|
+
declare function DxcToggleGroup({ defaultValue, margin, multiple, onChange, options, orientation, tabIndex, value, }: Props$3): react_jsx_runtime.JSX.Element;
|
|
3509
3571
|
|
|
3510
3572
|
type Props$2 = {
|
|
3511
3573
|
/**
|
|
3512
|
-
*
|
|
3574
|
+
* Content in which the Tooltip will be displayed.
|
|
3513
3575
|
*/
|
|
3514
|
-
|
|
3576
|
+
children: ReactNode;
|
|
3515
3577
|
/**
|
|
3516
3578
|
* Text to be displayed inside the tooltip.
|
|
3517
3579
|
*/
|
|
3518
|
-
label
|
|
3580
|
+
label?: string;
|
|
3519
3581
|
/**
|
|
3520
|
-
*
|
|
3582
|
+
* Preferred position for displaying the tooltip. It may adjust automatically based on available space.
|
|
3521
3583
|
*/
|
|
3522
|
-
|
|
3584
|
+
position?: "bottom" | "top" | "left" | "right";
|
|
3523
3585
|
};
|
|
3524
3586
|
|
|
3525
|
-
declare
|
|
3587
|
+
declare function DxcTooltip(props: Props$2): react_jsx_runtime.JSX.Element;
|
|
3526
3588
|
|
|
3527
3589
|
type Props$1 = {
|
|
3528
|
-
as?:
|
|
3590
|
+
as?: "a" | "blockquote" | "cite" | "code" | "div" | "em" | "figcaption" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "pre" | "small" | "span" | "strong";
|
|
3591
|
+
children: ReactNode;
|
|
3592
|
+
color?: string;
|
|
3529
3593
|
display?: "inline" | "block";
|
|
3530
|
-
fontFamily?:
|
|
3531
|
-
fontSize?:
|
|
3594
|
+
fontFamily?: string;
|
|
3595
|
+
fontSize?: string;
|
|
3532
3596
|
fontStyle?: "italic" | "normal";
|
|
3533
|
-
fontWeight?:
|
|
3534
|
-
letterSpacing?:
|
|
3535
|
-
lineHeight?:
|
|
3597
|
+
fontWeight?: string;
|
|
3598
|
+
letterSpacing?: string;
|
|
3599
|
+
lineHeight?: string;
|
|
3536
3600
|
textAlign?: "left" | "center" | "right";
|
|
3537
|
-
color?: string;
|
|
3538
3601
|
textDecoration?: "none" | "underline" | "line-through";
|
|
3539
3602
|
textOverflow?: "clip" | "ellipsis" | "unset";
|
|
3540
3603
|
whiteSpace?: "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap";
|
|
3541
|
-
children: React.ReactNode;
|
|
3542
3604
|
};
|
|
3543
3605
|
|
|
3544
|
-
declare
|
|
3606
|
+
declare function DxcTypography({ children, ...props }: Props$1): react_jsx_runtime.JSX.Element;
|
|
3545
3607
|
|
|
3546
|
-
type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
|
|
3547
|
-
type Margin = {
|
|
3548
|
-
top?: Space;
|
|
3549
|
-
bottom?: Space;
|
|
3550
|
-
left?: Space;
|
|
3551
|
-
right?: Space;
|
|
3552
|
-
};
|
|
3553
|
-
type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
|
|
3554
3608
|
type StepProps = {
|
|
3555
3609
|
/**
|
|
3556
3610
|
* Step label.
|
|
@@ -3599,41 +3653,41 @@ type Props = {
|
|
|
3599
3653
|
* Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
|
|
3600
3654
|
* You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
|
|
3601
3655
|
*/
|
|
3602
|
-
margin?: Space | Margin;
|
|
3656
|
+
margin?: Space$1 | Margin;
|
|
3603
3657
|
/**
|
|
3604
3658
|
* Value of the tabindex attribute that is given to all the steps.
|
|
3605
3659
|
*/
|
|
3606
3660
|
tabIndex?: number;
|
|
3607
3661
|
};
|
|
3608
3662
|
|
|
3609
|
-
declare
|
|
3663
|
+
declare function DxcWizard({ currentStep, defaultCurrentStep, margin, mode, onStepClick, steps, tabIndex, }: Props): react_jsx_runtime.JSX.Element;
|
|
3610
3664
|
|
|
3611
3665
|
declare const componentTokens: {
|
|
3612
3666
|
accordion: {
|
|
3613
3667
|
backgroundColor: string;
|
|
3614
3668
|
hoverBackgroundColor: string;
|
|
3669
|
+
focusBackgroundColor: string;
|
|
3670
|
+
activeBackgroundColor: string;
|
|
3615
3671
|
arrowColor: string;
|
|
3616
3672
|
disabledArrowColor: string;
|
|
3673
|
+
subLabelFontFamily: string;
|
|
3674
|
+
subLabelFontSize: string;
|
|
3675
|
+
subLabelFontWeight: string;
|
|
3676
|
+
subLabelFontStyle: string;
|
|
3677
|
+
subLabelFontColor: string;
|
|
3678
|
+
disabledSubLabelFontColor: string;
|
|
3617
3679
|
assistiveTextFontFamily: string;
|
|
3618
3680
|
assistiveTextFontSize: string;
|
|
3619
3681
|
assistiveTextFontWeight: string;
|
|
3620
3682
|
assistiveTextFontStyle: string;
|
|
3621
|
-
assistiveTextLetterSpacing: string;
|
|
3622
3683
|
assistiveTextFontColor: string;
|
|
3623
3684
|
disabledAssistiveTextFontColor: string;
|
|
3624
|
-
assistiveTextMinWidth: string;
|
|
3625
|
-
assistiveTextPaddingRight: string;
|
|
3626
|
-
assistiveTextPaddingLeft: string;
|
|
3627
3685
|
titleLabelFontFamily: string;
|
|
3628
3686
|
titleLabelFontSize: string;
|
|
3629
3687
|
titleLabelFontWeight: string;
|
|
3630
3688
|
titleLabelFontStyle: string;
|
|
3631
3689
|
titleLabelFontColor: string;
|
|
3632
3690
|
disabledTitleLabelFontColor: string;
|
|
3633
|
-
titleLabelPaddingTop: string;
|
|
3634
|
-
titleLabelPaddingBottom: string;
|
|
3635
|
-
titleLabelPaddingLeft: string;
|
|
3636
|
-
titleLabelPaddingRight: string;
|
|
3637
3691
|
focusBorderColor: string;
|
|
3638
3692
|
focusBorderStyle: string;
|
|
3639
3693
|
focusBorderThickness: string;
|
|
@@ -3641,81 +3695,34 @@ declare const componentTokens: {
|
|
|
3641
3695
|
boxShadowOffsetX: string;
|
|
3642
3696
|
boxShadowOffsetY: string;
|
|
3643
3697
|
boxShadowBlur: string;
|
|
3698
|
+
boxShadowSpread: string;
|
|
3644
3699
|
boxShadowColor: string;
|
|
3645
3700
|
iconColor: string;
|
|
3646
3701
|
disabledIconColor: string;
|
|
3647
3702
|
iconSize: string;
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
};
|
|
3655
|
-
alert: {
|
|
3656
|
-
titleFontFamily: string;
|
|
3657
|
-
titleFontColor: string;
|
|
3658
|
-
titleFontSize: string;
|
|
3659
|
-
titleFontStyle: string;
|
|
3660
|
-
titleFontWeight: string;
|
|
3661
|
-
titleTextTransform: string;
|
|
3662
|
-
titlePaddingRight: string;
|
|
3663
|
-
titlePaddingLeft: string;
|
|
3664
|
-
inlineTextFontFamily: string;
|
|
3665
|
-
inlineTextFontColor: string;
|
|
3666
|
-
inlineTextFontSize: string;
|
|
3667
|
-
inlineTextFontStyle: string;
|
|
3668
|
-
inlineTextFontWeight: string;
|
|
3669
|
-
inlineTextPaddingLeft: string;
|
|
3670
|
-
inlineTextPaddingRight: string;
|
|
3671
|
-
contentPaddingLeft: string;
|
|
3672
|
-
contentPaddingRight: string;
|
|
3673
|
-
contentPaddingTop: string;
|
|
3674
|
-
contentPaddingBottom: string;
|
|
3675
|
-
borderRadius: string;
|
|
3676
|
-
borderStyle: string;
|
|
3677
|
-
borderThickness: string;
|
|
3678
|
-
infoBorderColor: string;
|
|
3679
|
-
successBorderColor: string;
|
|
3680
|
-
warningBorderColor: string;
|
|
3681
|
-
errorBorderColor: string;
|
|
3682
|
-
iconSize: string;
|
|
3683
|
-
iconPaddingLeft: string;
|
|
3684
|
-
iconPaddingRight: string;
|
|
3685
|
-
infoIconColor: string;
|
|
3686
|
-
successIconColor: string;
|
|
3687
|
-
warningIconColor: string;
|
|
3703
|
+
accordionSeparatorBorderColor: string;
|
|
3704
|
+
accordionSeparatorBorderThickness: string;
|
|
3705
|
+
accordionSeparatorBorderStyle: string;
|
|
3706
|
+
};
|
|
3707
|
+
alert: {
|
|
3708
|
+
errorBackgroundColor: string;
|
|
3688
3709
|
errorIconColor: string;
|
|
3710
|
+
fontColor: string;
|
|
3711
|
+
fontFamily: string;
|
|
3712
|
+
fontSize: string;
|
|
3713
|
+
fontStyle: string;
|
|
3714
|
+
fontWeight: string;
|
|
3715
|
+
iconSize: string;
|
|
3689
3716
|
infoBackgroundColor: string;
|
|
3717
|
+
infoIconColor: string;
|
|
3718
|
+
modalBackgroundColor: string;
|
|
3719
|
+
modalTitleFontSize: string;
|
|
3720
|
+
modalTitleFontWeight: string;
|
|
3721
|
+
overlayColor: string;
|
|
3690
3722
|
successBackgroundColor: string;
|
|
3723
|
+
successIconColor: string;
|
|
3691
3724
|
warningBackgroundColor: string;
|
|
3692
|
-
|
|
3693
|
-
hoverActionBackgroundColor: string;
|
|
3694
|
-
activeActionBackgroundColor: string;
|
|
3695
|
-
focusActionBorderColor: string;
|
|
3696
|
-
overlayColor: string;
|
|
3697
|
-
};
|
|
3698
|
-
box: {
|
|
3699
|
-
backgroundColor: string;
|
|
3700
|
-
borderRadius: string;
|
|
3701
|
-
borderThickness: string;
|
|
3702
|
-
borderStyle: string;
|
|
3703
|
-
borderColor: string;
|
|
3704
|
-
noneShadowDepthShadowOffsetX: string;
|
|
3705
|
-
noneShadowDepthShadowOffsetY: string;
|
|
3706
|
-
noneShadowDepthShadowBlur: string;
|
|
3707
|
-
noneShadowDepthShadowSpread: string;
|
|
3708
|
-
noneShadowDepthShadowColor: string;
|
|
3709
|
-
oneShadowDepthShadowOffsetX: string;
|
|
3710
|
-
oneShadowDepthShadowOffsetY: string;
|
|
3711
|
-
oneShadowDepthShadowBlur: string;
|
|
3712
|
-
oneShadowDepthShadowSpread: string;
|
|
3713
|
-
oneShadowDepthShadowColor: string;
|
|
3714
|
-
twoShadowDepthShadowOffsetX: string;
|
|
3715
|
-
twoShadowDepthShadowOffsetY: string;
|
|
3716
|
-
twoShadowDepthShadowBlur: string;
|
|
3717
|
-
twoShadowDepthShadowSpread: string;
|
|
3718
|
-
twoShadowDepthShadowColor: string;
|
|
3725
|
+
warningIconColor: string;
|
|
3719
3726
|
};
|
|
3720
3727
|
bulletedList: {
|
|
3721
3728
|
fontColor: string;
|
|
@@ -3960,6 +3967,53 @@ declare const componentTokens: {
|
|
|
3960
3967
|
iconColor: string;
|
|
3961
3968
|
iconSize: string;
|
|
3962
3969
|
};
|
|
3970
|
+
dataGrid: {
|
|
3971
|
+
rowSeparatorThickness: string;
|
|
3972
|
+
rowSeparatorStyle: string;
|
|
3973
|
+
rowSeparatorColor: string;
|
|
3974
|
+
dataBackgroundColor: string;
|
|
3975
|
+
dataFontFamily: string;
|
|
3976
|
+
dataFontSize: string;
|
|
3977
|
+
dataFontStyle: string;
|
|
3978
|
+
dataFontWeight: string;
|
|
3979
|
+
dataFontColor: string;
|
|
3980
|
+
dataFontTextTransform: string;
|
|
3981
|
+
dataPaddingRight: string;
|
|
3982
|
+
dataPaddingLeft: string;
|
|
3983
|
+
dataRowHeight: number;
|
|
3984
|
+
dataTextLineHeight: string;
|
|
3985
|
+
headerBackgroundColor: string;
|
|
3986
|
+
headerBorderRadius: string;
|
|
3987
|
+
headerFontFamily: string;
|
|
3988
|
+
headerFontSize: string;
|
|
3989
|
+
headerFontStyle: string;
|
|
3990
|
+
headerFontWeight: string;
|
|
3991
|
+
headerFontColor: string;
|
|
3992
|
+
headerFontTextTransform: string;
|
|
3993
|
+
headerPaddingRight: string;
|
|
3994
|
+
headerPaddingLeft: string;
|
|
3995
|
+
headerRowHeight: number;
|
|
3996
|
+
headerTextLineHeight: string;
|
|
3997
|
+
headerCheckboxBackgroundColorChecked: string;
|
|
3998
|
+
headerCheckboxHoverBackgroundColorChecked: string;
|
|
3999
|
+
headerCheckboxBorderColor: string;
|
|
4000
|
+
headerCheckboxHoverBorderColor: string;
|
|
4001
|
+
headerCheckboxCheckColor: string;
|
|
4002
|
+
summaryRowHeight: number;
|
|
4003
|
+
focusColor: string;
|
|
4004
|
+
scrollBarThumbColor: string;
|
|
4005
|
+
scrollBarTrackColor: string;
|
|
4006
|
+
actionIconColor: string;
|
|
4007
|
+
disabledActionIconColor: string;
|
|
4008
|
+
hoverActionIconColor: string;
|
|
4009
|
+
focusActionIconColor: string;
|
|
4010
|
+
activeActionIconColor: string;
|
|
4011
|
+
actionBackgroundColor: string;
|
|
4012
|
+
disabledActionBackgroundColor: string;
|
|
4013
|
+
hoverActionBackgroundColor: string;
|
|
4014
|
+
focusActionBorderColor: string;
|
|
4015
|
+
activeActionBackgroundColor: string;
|
|
4016
|
+
};
|
|
3963
4017
|
dateInput: {
|
|
3964
4018
|
pickerBackgroundColor: string;
|
|
3965
4019
|
pickerFontColor: string;
|
|
@@ -3994,15 +4048,8 @@ declare const componentTokens: {
|
|
|
3994
4048
|
dialog: {
|
|
3995
4049
|
overlayColor: string;
|
|
3996
4050
|
backgroundColor: string;
|
|
3997
|
-
closeIconSize: string;
|
|
3998
|
-
closeIconTopPosition: string;
|
|
3999
|
-
closeIconRightPosition: string;
|
|
4000
4051
|
closeIconBackgroundColor: string;
|
|
4001
|
-
closeIconBorderColor: string;
|
|
4002
4052
|
closeIconColor: string;
|
|
4003
|
-
closeIconBorderThickness: string;
|
|
4004
|
-
closeIconBorderStyle: string;
|
|
4005
|
-
closeIconBorderRadius: string;
|
|
4006
4053
|
boxShadowOffsetX: string;
|
|
4007
4054
|
boxShadowOffsetY: string;
|
|
4008
4055
|
boxShadowBlur: string;
|
|
@@ -4066,7 +4113,7 @@ declare const componentTokens: {
|
|
|
4066
4113
|
helperTextFontColor: string;
|
|
4067
4114
|
dropLabelFontColor: string;
|
|
4068
4115
|
disabledLabelFontColor: string;
|
|
4069
|
-
|
|
4116
|
+
disabledHelperTextFontColor: string;
|
|
4070
4117
|
disabledDropLabelFontColor: string;
|
|
4071
4118
|
focusDropBorderColor: string;
|
|
4072
4119
|
disabledDropBorderColor: string;
|
|
@@ -4137,15 +4184,15 @@ declare const componentTokens: {
|
|
|
4137
4184
|
};
|
|
4138
4185
|
header: {
|
|
4139
4186
|
backgroundColor: string;
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4187
|
+
hamburgerFocusColor: string;
|
|
4188
|
+
hamburgerFontFamily: string;
|
|
4189
|
+
hamburgerFontStyle: string;
|
|
4190
|
+
hamburgerFontColor: string;
|
|
4191
|
+
hamburgerFontSize: string;
|
|
4192
|
+
hamburgerFontWeight: string;
|
|
4193
|
+
hamburgerTextTransform: string;
|
|
4194
|
+
hamburgerIconColor: string;
|
|
4195
|
+
hamburgerHoverColor: string;
|
|
4149
4196
|
logo: string;
|
|
4150
4197
|
logoResponsive: string;
|
|
4151
4198
|
logoHeight: string;
|
|
@@ -4659,23 +4706,6 @@ declare const componentTokens: {
|
|
|
4659
4706
|
focusOutline: string;
|
|
4660
4707
|
scrollButtonsWidth: string;
|
|
4661
4708
|
};
|
|
4662
|
-
tag: {
|
|
4663
|
-
fontFamily: string;
|
|
4664
|
-
fontColor: string;
|
|
4665
|
-
fontSize: string;
|
|
4666
|
-
fontStyle: string;
|
|
4667
|
-
fontWeight: string;
|
|
4668
|
-
labelPaddingTop: string;
|
|
4669
|
-
labelPaddingBottom: string;
|
|
4670
|
-
labelPaddingLeft: string;
|
|
4671
|
-
labelPaddingRight: string;
|
|
4672
|
-
height: string;
|
|
4673
|
-
iconColor: string;
|
|
4674
|
-
iconSectionWidth: string;
|
|
4675
|
-
iconHeight: string;
|
|
4676
|
-
iconWidth: string;
|
|
4677
|
-
focusColor: string;
|
|
4678
|
-
};
|
|
4679
4709
|
textarea: {
|
|
4680
4710
|
fontFamily: string;
|
|
4681
4711
|
enabledBorderColor: string;
|
|
@@ -4787,7 +4817,7 @@ declare const componentTokens: {
|
|
|
4787
4817
|
labelFontColor: string;
|
|
4788
4818
|
disabledLabelFontColor: string;
|
|
4789
4819
|
helperTextFontColor: string;
|
|
4790
|
-
|
|
4820
|
+
disabledHelperTextFontColor: string;
|
|
4791
4821
|
unselectedBackgroundColor: string;
|
|
4792
4822
|
unselectedHoverBackgroundColor: string;
|
|
4793
4823
|
unselectedActiveBackgroundColor: string;
|
|
@@ -4896,6 +4926,7 @@ type OpinionatedTheme = {
|
|
|
4896
4926
|
accordion: {
|
|
4897
4927
|
accentColor: string;
|
|
4898
4928
|
titleFontColor: string;
|
|
4929
|
+
subLabelFontColor: string;
|
|
4899
4930
|
assistiveTextFontColor: string;
|
|
4900
4931
|
};
|
|
4901
4932
|
alert: {
|
|
@@ -4903,9 +4934,6 @@ type OpinionatedTheme = {
|
|
|
4903
4934
|
accentColor: string;
|
|
4904
4935
|
overlayColor: string;
|
|
4905
4936
|
};
|
|
4906
|
-
box: {
|
|
4907
|
-
baseColor: string;
|
|
4908
|
-
};
|
|
4909
4937
|
button: {
|
|
4910
4938
|
baseColor: string;
|
|
4911
4939
|
primaryFontColor: string;
|
|
@@ -4927,6 +4955,11 @@ type OpinionatedTheme = {
|
|
|
4927
4955
|
fontColor: string;
|
|
4928
4956
|
iconColor: string;
|
|
4929
4957
|
};
|
|
4958
|
+
dataGrid: {
|
|
4959
|
+
baseColor: string;
|
|
4960
|
+
headerFontColor: string;
|
|
4961
|
+
cellFontColor: string;
|
|
4962
|
+
};
|
|
4930
4963
|
dateInput: {
|
|
4931
4964
|
baseColor: string;
|
|
4932
4965
|
selectedFontColor: string;
|
|
@@ -4955,7 +4988,7 @@ type OpinionatedTheme = {
|
|
|
4955
4988
|
accentColor: string;
|
|
4956
4989
|
fontColor: string;
|
|
4957
4990
|
menuBaseColor: string;
|
|
4958
|
-
|
|
4991
|
+
hamburgerColor: string;
|
|
4959
4992
|
logo: string;
|
|
4960
4993
|
logoResponsive: string;
|
|
4961
4994
|
contentColor: string;
|
|
@@ -5020,10 +5053,6 @@ type OpinionatedTheme = {
|
|
|
5020
5053
|
tabs: {
|
|
5021
5054
|
baseColor: string;
|
|
5022
5055
|
};
|
|
5023
|
-
tag: {
|
|
5024
|
-
fontColor: string;
|
|
5025
|
-
iconColor: string;
|
|
5026
|
-
};
|
|
5027
5056
|
textarea: {
|
|
5028
5057
|
fontColor: string;
|
|
5029
5058
|
hoverBorderColor: string;
|
|
@@ -5045,22 +5074,20 @@ type OpinionatedTheme = {
|
|
|
5045
5074
|
};
|
|
5046
5075
|
};
|
|
5047
5076
|
declare const defaultTranslatedComponentLabels: {
|
|
5048
|
-
formFields: {
|
|
5049
|
-
optionalLabel: string;
|
|
5050
|
-
requiredSelectionErrorMessage: string;
|
|
5051
|
-
requiredValueErrorMessage: string;
|
|
5052
|
-
formatRequestedErrorMessage: string;
|
|
5053
|
-
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
5054
|
-
logoAlternativeText: string;
|
|
5055
|
-
};
|
|
5056
5077
|
applicationLayout: {
|
|
5057
5078
|
visibilityToggleTitle: string;
|
|
5058
5079
|
};
|
|
5059
5080
|
alert: {
|
|
5060
|
-
|
|
5061
|
-
|
|
5062
|
-
|
|
5063
|
-
|
|
5081
|
+
previousMessageActionTitle: string;
|
|
5082
|
+
nextMessageActionTitle: string;
|
|
5083
|
+
closeAlertActionTitle: string;
|
|
5084
|
+
closeMessageActionTitle: string;
|
|
5085
|
+
};
|
|
5086
|
+
calendar: {
|
|
5087
|
+
daysShort: string[];
|
|
5088
|
+
months: string[];
|
|
5089
|
+
previousMonthTitle: string;
|
|
5090
|
+
nextMonthTitle: string;
|
|
5064
5091
|
};
|
|
5065
5092
|
dateInput: {
|
|
5066
5093
|
invalidDateErrorMessage: string;
|
|
@@ -5081,9 +5108,17 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
5081
5108
|
footer: {
|
|
5082
5109
|
copyrightText: (year: number) => string;
|
|
5083
5110
|
};
|
|
5111
|
+
formFields: {
|
|
5112
|
+
optionalLabel: string;
|
|
5113
|
+
requiredSelectionErrorMessage: string;
|
|
5114
|
+
requiredValueErrorMessage: string;
|
|
5115
|
+
formatRequestedErrorMessage: string;
|
|
5116
|
+
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
5117
|
+
logoAlternativeText: string;
|
|
5118
|
+
};
|
|
5084
5119
|
header: {
|
|
5085
5120
|
closeIcon: string;
|
|
5086
|
-
|
|
5121
|
+
hamburgerTitle: string;
|
|
5087
5122
|
};
|
|
5088
5123
|
numberInput: {
|
|
5089
5124
|
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
@@ -5108,9 +5143,10 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
5108
5143
|
optionalItemLabelDefault: string;
|
|
5109
5144
|
};
|
|
5110
5145
|
select: {
|
|
5111
|
-
noMatchesErrorMessage: string;
|
|
5112
5146
|
actionClearSelectionTitle: string;
|
|
5113
5147
|
actionClearSearchTitle: string;
|
|
5148
|
+
noMatchesErrorMessage: string;
|
|
5149
|
+
selectAllLabel: string;
|
|
5114
5150
|
};
|
|
5115
5151
|
tabs: {
|
|
5116
5152
|
scrollLeft: string;
|
|
@@ -5121,41 +5157,45 @@ declare const defaultTranslatedComponentLabels: {
|
|
|
5121
5157
|
searchingMessage: string;
|
|
5122
5158
|
fetchingDataErrorMessage: string;
|
|
5123
5159
|
};
|
|
5124
|
-
|
|
5125
|
-
|
|
5126
|
-
months: string[];
|
|
5127
|
-
previousMonthTitle: string;
|
|
5128
|
-
nextMonthTitle: string;
|
|
5160
|
+
toast: {
|
|
5161
|
+
clearToastActionTitle: string;
|
|
5129
5162
|
};
|
|
5130
5163
|
};
|
|
5131
5164
|
type TranslatedLabels = typeof defaultTranslatedComponentLabels;
|
|
5132
5165
|
|
|
5133
|
-
|
|
5166
|
+
/**
|
|
5167
|
+
* This type is used to allow partial themes and labels objects to be passed to the HalstackProvider.
|
|
5168
|
+
* This is an extension of the already existing Partial type, which only allows one level of partiality.
|
|
5169
|
+
*/
|
|
5170
|
+
type DeepPartial<T> = {
|
|
5171
|
+
[P in keyof T]?: Partial<T[P]>;
|
|
5172
|
+
};
|
|
5173
|
+
declare const HalstackContext: react.Context<{
|
|
5134
5174
|
accordion: {
|
|
5135
5175
|
backgroundColor: string;
|
|
5136
5176
|
hoverBackgroundColor: string;
|
|
5177
|
+
focusBackgroundColor: string;
|
|
5178
|
+
activeBackgroundColor: string;
|
|
5137
5179
|
arrowColor: string;
|
|
5138
5180
|
disabledArrowColor: string;
|
|
5181
|
+
subLabelFontFamily: string;
|
|
5182
|
+
subLabelFontSize: string;
|
|
5183
|
+
subLabelFontWeight: string;
|
|
5184
|
+
subLabelFontStyle: string;
|
|
5185
|
+
subLabelFontColor: string;
|
|
5186
|
+
disabledSubLabelFontColor: string;
|
|
5139
5187
|
assistiveTextFontFamily: string;
|
|
5140
5188
|
assistiveTextFontSize: string;
|
|
5141
5189
|
assistiveTextFontWeight: string;
|
|
5142
5190
|
assistiveTextFontStyle: string;
|
|
5143
|
-
assistiveTextLetterSpacing: string;
|
|
5144
5191
|
assistiveTextFontColor: string;
|
|
5145
5192
|
disabledAssistiveTextFontColor: string;
|
|
5146
|
-
assistiveTextMinWidth: string;
|
|
5147
|
-
assistiveTextPaddingRight: string;
|
|
5148
|
-
assistiveTextPaddingLeft: string;
|
|
5149
5193
|
titleLabelFontFamily: string;
|
|
5150
5194
|
titleLabelFontSize: string;
|
|
5151
5195
|
titleLabelFontWeight: string;
|
|
5152
5196
|
titleLabelFontStyle: string;
|
|
5153
5197
|
titleLabelFontColor: string;
|
|
5154
5198
|
disabledTitleLabelFontColor: string;
|
|
5155
|
-
titleLabelPaddingTop: string;
|
|
5156
|
-
titleLabelPaddingBottom: string;
|
|
5157
|
-
titleLabelPaddingLeft: string;
|
|
5158
|
-
titleLabelPaddingRight: string;
|
|
5159
5199
|
focusBorderColor: string;
|
|
5160
5200
|
focusBorderStyle: string;
|
|
5161
5201
|
focusBorderThickness: string;
|
|
@@ -5163,81 +5203,34 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
5163
5203
|
boxShadowOffsetX: string;
|
|
5164
5204
|
boxShadowOffsetY: string;
|
|
5165
5205
|
boxShadowBlur: string;
|
|
5206
|
+
boxShadowSpread: string;
|
|
5166
5207
|
boxShadowColor: string;
|
|
5167
5208
|
iconColor: string;
|
|
5168
5209
|
disabledIconColor: string;
|
|
5169
5210
|
iconSize: string;
|
|
5170
|
-
|
|
5171
|
-
|
|
5172
|
-
|
|
5173
|
-
accordionGroupSeparatorBorderThickness: string;
|
|
5174
|
-
accordionGroupSeparatorBorderRadius: string;
|
|
5175
|
-
accordionGroupSeparatorBorderStyle: string;
|
|
5211
|
+
accordionSeparatorBorderColor: string;
|
|
5212
|
+
accordionSeparatorBorderThickness: string;
|
|
5213
|
+
accordionSeparatorBorderStyle: string;
|
|
5176
5214
|
};
|
|
5177
5215
|
alert: {
|
|
5178
|
-
|
|
5179
|
-
titleFontColor: string;
|
|
5180
|
-
titleFontSize: string;
|
|
5181
|
-
titleFontStyle: string;
|
|
5182
|
-
titleFontWeight: string;
|
|
5183
|
-
titleTextTransform: string;
|
|
5184
|
-
titlePaddingRight: string;
|
|
5185
|
-
titlePaddingLeft: string;
|
|
5186
|
-
inlineTextFontFamily: string;
|
|
5187
|
-
inlineTextFontColor: string;
|
|
5188
|
-
inlineTextFontSize: string;
|
|
5189
|
-
inlineTextFontStyle: string;
|
|
5190
|
-
inlineTextFontWeight: string;
|
|
5191
|
-
inlineTextPaddingLeft: string;
|
|
5192
|
-
inlineTextPaddingRight: string;
|
|
5193
|
-
contentPaddingLeft: string;
|
|
5194
|
-
contentPaddingRight: string;
|
|
5195
|
-
contentPaddingTop: string;
|
|
5196
|
-
contentPaddingBottom: string;
|
|
5197
|
-
borderRadius: string;
|
|
5198
|
-
borderStyle: string;
|
|
5199
|
-
borderThickness: string;
|
|
5200
|
-
infoBorderColor: string;
|
|
5201
|
-
successBorderColor: string;
|
|
5202
|
-
warningBorderColor: string;
|
|
5203
|
-
errorBorderColor: string;
|
|
5204
|
-
iconSize: string;
|
|
5205
|
-
iconPaddingLeft: string;
|
|
5206
|
-
iconPaddingRight: string;
|
|
5207
|
-
infoIconColor: string;
|
|
5208
|
-
successIconColor: string;
|
|
5209
|
-
warningIconColor: string;
|
|
5216
|
+
errorBackgroundColor: string;
|
|
5210
5217
|
errorIconColor: string;
|
|
5218
|
+
fontColor: string;
|
|
5219
|
+
fontFamily: string;
|
|
5220
|
+
fontSize: string;
|
|
5221
|
+
fontStyle: string;
|
|
5222
|
+
fontWeight: string;
|
|
5223
|
+
iconSize: string;
|
|
5211
5224
|
infoBackgroundColor: string;
|
|
5225
|
+
infoIconColor: string;
|
|
5226
|
+
modalBackgroundColor: string;
|
|
5227
|
+
modalTitleFontSize: string;
|
|
5228
|
+
modalTitleFontWeight: string;
|
|
5229
|
+
overlayColor: string;
|
|
5212
5230
|
successBackgroundColor: string;
|
|
5231
|
+
successIconColor: string;
|
|
5213
5232
|
warningBackgroundColor: string;
|
|
5214
|
-
|
|
5215
|
-
hoverActionBackgroundColor: string;
|
|
5216
|
-
activeActionBackgroundColor: string;
|
|
5217
|
-
focusActionBorderColor: string;
|
|
5218
|
-
overlayColor: string;
|
|
5219
|
-
};
|
|
5220
|
-
box: {
|
|
5221
|
-
backgroundColor: string;
|
|
5222
|
-
borderRadius: string;
|
|
5223
|
-
borderThickness: string;
|
|
5224
|
-
borderStyle: string;
|
|
5225
|
-
borderColor: string;
|
|
5226
|
-
noneShadowDepthShadowOffsetX: string;
|
|
5227
|
-
noneShadowDepthShadowOffsetY: string;
|
|
5228
|
-
noneShadowDepthShadowBlur: string;
|
|
5229
|
-
noneShadowDepthShadowSpread: string;
|
|
5230
|
-
noneShadowDepthShadowColor: string;
|
|
5231
|
-
oneShadowDepthShadowOffsetX: string;
|
|
5232
|
-
oneShadowDepthShadowOffsetY: string;
|
|
5233
|
-
oneShadowDepthShadowBlur: string;
|
|
5234
|
-
oneShadowDepthShadowSpread: string;
|
|
5235
|
-
oneShadowDepthShadowColor: string;
|
|
5236
|
-
twoShadowDepthShadowOffsetX: string;
|
|
5237
|
-
twoShadowDepthShadowOffsetY: string;
|
|
5238
|
-
twoShadowDepthShadowBlur: string;
|
|
5239
|
-
twoShadowDepthShadowSpread: string;
|
|
5240
|
-
twoShadowDepthShadowColor: string;
|
|
5233
|
+
warningIconColor: string;
|
|
5241
5234
|
};
|
|
5242
5235
|
bulletedList: {
|
|
5243
5236
|
fontColor: string;
|
|
@@ -5482,6 +5475,53 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
5482
5475
|
iconColor: string;
|
|
5483
5476
|
iconSize: string;
|
|
5484
5477
|
};
|
|
5478
|
+
dataGrid: {
|
|
5479
|
+
rowSeparatorThickness: string;
|
|
5480
|
+
rowSeparatorStyle: string;
|
|
5481
|
+
rowSeparatorColor: string;
|
|
5482
|
+
dataBackgroundColor: string;
|
|
5483
|
+
dataFontFamily: string;
|
|
5484
|
+
dataFontSize: string;
|
|
5485
|
+
dataFontStyle: string;
|
|
5486
|
+
dataFontWeight: string;
|
|
5487
|
+
dataFontColor: string;
|
|
5488
|
+
dataFontTextTransform: string;
|
|
5489
|
+
dataPaddingRight: string;
|
|
5490
|
+
dataPaddingLeft: string;
|
|
5491
|
+
dataRowHeight: number;
|
|
5492
|
+
dataTextLineHeight: string;
|
|
5493
|
+
headerBackgroundColor: string;
|
|
5494
|
+
headerBorderRadius: string;
|
|
5495
|
+
headerFontFamily: string;
|
|
5496
|
+
headerFontSize: string;
|
|
5497
|
+
headerFontStyle: string;
|
|
5498
|
+
headerFontWeight: string;
|
|
5499
|
+
headerFontColor: string;
|
|
5500
|
+
headerFontTextTransform: string;
|
|
5501
|
+
headerPaddingRight: string;
|
|
5502
|
+
headerPaddingLeft: string;
|
|
5503
|
+
headerRowHeight: number;
|
|
5504
|
+
headerTextLineHeight: string;
|
|
5505
|
+
headerCheckboxBackgroundColorChecked: string;
|
|
5506
|
+
headerCheckboxHoverBackgroundColorChecked: string;
|
|
5507
|
+
headerCheckboxBorderColor: string;
|
|
5508
|
+
headerCheckboxHoverBorderColor: string;
|
|
5509
|
+
headerCheckboxCheckColor: string;
|
|
5510
|
+
summaryRowHeight: number;
|
|
5511
|
+
focusColor: string;
|
|
5512
|
+
scrollBarThumbColor: string;
|
|
5513
|
+
scrollBarTrackColor: string;
|
|
5514
|
+
actionIconColor: string;
|
|
5515
|
+
disabledActionIconColor: string;
|
|
5516
|
+
hoverActionIconColor: string;
|
|
5517
|
+
focusActionIconColor: string;
|
|
5518
|
+
activeActionIconColor: string;
|
|
5519
|
+
actionBackgroundColor: string;
|
|
5520
|
+
disabledActionBackgroundColor: string;
|
|
5521
|
+
hoverActionBackgroundColor: string;
|
|
5522
|
+
focusActionBorderColor: string;
|
|
5523
|
+
activeActionBackgroundColor: string;
|
|
5524
|
+
};
|
|
5485
5525
|
dateInput: {
|
|
5486
5526
|
pickerBackgroundColor: string;
|
|
5487
5527
|
pickerFontColor: string;
|
|
@@ -5516,15 +5556,8 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
5516
5556
|
dialog: {
|
|
5517
5557
|
overlayColor: string;
|
|
5518
5558
|
backgroundColor: string;
|
|
5519
|
-
closeIconSize: string;
|
|
5520
|
-
closeIconTopPosition: string;
|
|
5521
|
-
closeIconRightPosition: string;
|
|
5522
5559
|
closeIconBackgroundColor: string;
|
|
5523
|
-
closeIconBorderColor: string;
|
|
5524
5560
|
closeIconColor: string;
|
|
5525
|
-
closeIconBorderThickness: string;
|
|
5526
|
-
closeIconBorderStyle: string;
|
|
5527
|
-
closeIconBorderRadius: string;
|
|
5528
5561
|
boxShadowOffsetX: string;
|
|
5529
5562
|
boxShadowOffsetY: string;
|
|
5530
5563
|
boxShadowBlur: string;
|
|
@@ -5588,7 +5621,7 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
5588
5621
|
helperTextFontColor: string;
|
|
5589
5622
|
dropLabelFontColor: string;
|
|
5590
5623
|
disabledLabelFontColor: string;
|
|
5591
|
-
|
|
5624
|
+
disabledHelperTextFontColor: string;
|
|
5592
5625
|
disabledDropLabelFontColor: string;
|
|
5593
5626
|
focusDropBorderColor: string;
|
|
5594
5627
|
disabledDropBorderColor: string;
|
|
@@ -5659,15 +5692,15 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
5659
5692
|
};
|
|
5660
5693
|
header: {
|
|
5661
5694
|
backgroundColor: string;
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
5695
|
+
hamburgerFocusColor: string;
|
|
5696
|
+
hamburgerFontFamily: string;
|
|
5697
|
+
hamburgerFontStyle: string;
|
|
5698
|
+
hamburgerFontColor: string;
|
|
5699
|
+
hamburgerFontSize: string;
|
|
5700
|
+
hamburgerFontWeight: string;
|
|
5701
|
+
hamburgerTextTransform: string;
|
|
5702
|
+
hamburgerIconColor: string;
|
|
5703
|
+
hamburgerHoverColor: string;
|
|
5671
5704
|
logo: string;
|
|
5672
5705
|
logoResponsive: string;
|
|
5673
5706
|
logoHeight: string;
|
|
@@ -6181,23 +6214,6 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
6181
6214
|
focusOutline: string;
|
|
6182
6215
|
scrollButtonsWidth: string;
|
|
6183
6216
|
};
|
|
6184
|
-
tag: {
|
|
6185
|
-
fontFamily: string;
|
|
6186
|
-
fontColor: string;
|
|
6187
|
-
fontSize: string;
|
|
6188
|
-
fontStyle: string;
|
|
6189
|
-
fontWeight: string;
|
|
6190
|
-
labelPaddingTop: string;
|
|
6191
|
-
labelPaddingBottom: string;
|
|
6192
|
-
labelPaddingLeft: string;
|
|
6193
|
-
labelPaddingRight: string;
|
|
6194
|
-
height: string;
|
|
6195
|
-
iconColor: string;
|
|
6196
|
-
iconSectionWidth: string;
|
|
6197
|
-
iconHeight: string;
|
|
6198
|
-
iconWidth: string;
|
|
6199
|
-
focusColor: string;
|
|
6200
|
-
};
|
|
6201
6217
|
textarea: {
|
|
6202
6218
|
fontFamily: string;
|
|
6203
6219
|
enabledBorderColor: string;
|
|
@@ -6309,7 +6325,7 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
6309
6325
|
labelFontColor: string;
|
|
6310
6326
|
disabledLabelFontColor: string;
|
|
6311
6327
|
helperTextFontColor: string;
|
|
6312
|
-
|
|
6328
|
+
disabledHelperTextFontColor: string;
|
|
6313
6329
|
unselectedBackgroundColor: string;
|
|
6314
6330
|
unselectedHoverBackgroundColor: string;
|
|
6315
6331
|
unselectedActiveBackgroundColor: string;
|
|
@@ -6412,24 +6428,22 @@ declare const HalstackContext: react.Context<DeepPartial<{
|
|
|
6412
6428
|
separatorColor: string;
|
|
6413
6429
|
focusColor: string;
|
|
6414
6430
|
};
|
|
6415
|
-
}
|
|
6416
|
-
declare const HalstackLanguageContext: react.Context<
|
|
6417
|
-
formFields: {
|
|
6418
|
-
optionalLabel: string;
|
|
6419
|
-
requiredSelectionErrorMessage: string;
|
|
6420
|
-
requiredValueErrorMessage: string;
|
|
6421
|
-
formatRequestedErrorMessage: string;
|
|
6422
|
-
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
6423
|
-
logoAlternativeText: string;
|
|
6424
|
-
};
|
|
6431
|
+
}>;
|
|
6432
|
+
declare const HalstackLanguageContext: react.Context<{
|
|
6425
6433
|
applicationLayout: {
|
|
6426
6434
|
visibilityToggleTitle: string;
|
|
6427
6435
|
};
|
|
6428
6436
|
alert: {
|
|
6429
|
-
|
|
6430
|
-
|
|
6431
|
-
|
|
6432
|
-
|
|
6437
|
+
previousMessageActionTitle: string;
|
|
6438
|
+
nextMessageActionTitle: string;
|
|
6439
|
+
closeAlertActionTitle: string;
|
|
6440
|
+
closeMessageActionTitle: string;
|
|
6441
|
+
};
|
|
6442
|
+
calendar: {
|
|
6443
|
+
daysShort: string[];
|
|
6444
|
+
months: string[];
|
|
6445
|
+
previousMonthTitle: string;
|
|
6446
|
+
nextMonthTitle: string;
|
|
6433
6447
|
};
|
|
6434
6448
|
dateInput: {
|
|
6435
6449
|
invalidDateErrorMessage: string;
|
|
@@ -6450,9 +6464,17 @@ declare const HalstackLanguageContext: react.Context<DeepPartial<{
|
|
|
6450
6464
|
footer: {
|
|
6451
6465
|
copyrightText: (year: number) => string;
|
|
6452
6466
|
};
|
|
6467
|
+
formFields: {
|
|
6468
|
+
optionalLabel: string;
|
|
6469
|
+
requiredSelectionErrorMessage: string;
|
|
6470
|
+
requiredValueErrorMessage: string;
|
|
6471
|
+
formatRequestedErrorMessage: string;
|
|
6472
|
+
lengthErrorMessage: (minLength?: number, maxLength?: number) => string;
|
|
6473
|
+
logoAlternativeText: string;
|
|
6474
|
+
};
|
|
6453
6475
|
header: {
|
|
6454
6476
|
closeIcon: string;
|
|
6455
|
-
|
|
6477
|
+
hamburgerTitle: string;
|
|
6456
6478
|
};
|
|
6457
6479
|
numberInput: {
|
|
6458
6480
|
valueGreaterThanOrEqualToErrorMessage: (value: number) => string;
|
|
@@ -6477,9 +6499,10 @@ declare const HalstackLanguageContext: react.Context<DeepPartial<{
|
|
|
6477
6499
|
optionalItemLabelDefault: string;
|
|
6478
6500
|
};
|
|
6479
6501
|
select: {
|
|
6480
|
-
noMatchesErrorMessage: string;
|
|
6481
6502
|
actionClearSelectionTitle: string;
|
|
6482
6503
|
actionClearSearchTitle: string;
|
|
6504
|
+
noMatchesErrorMessage: string;
|
|
6505
|
+
selectAllLabel: string;
|
|
6483
6506
|
};
|
|
6484
6507
|
tabs: {
|
|
6485
6508
|
scrollLeft: string;
|
|
@@ -6490,26 +6513,24 @@ declare const HalstackLanguageContext: react.Context<DeepPartial<{
|
|
|
6490
6513
|
searchingMessage: string;
|
|
6491
6514
|
fetchingDataErrorMessage: string;
|
|
6492
6515
|
};
|
|
6493
|
-
|
|
6494
|
-
|
|
6495
|
-
months: string[];
|
|
6496
|
-
previousMonthTitle: string;
|
|
6497
|
-
nextMonthTitle: string;
|
|
6516
|
+
toast: {
|
|
6517
|
+
clearToastActionTitle: string;
|
|
6498
6518
|
};
|
|
6499
|
-
}
|
|
6500
|
-
/**
|
|
6501
|
-
* This type is used to allow partial themes and labels objects to be passed to the HalstackProvider.
|
|
6502
|
-
* This is an extension of the already existing Partial type, which only allows one level of partiality.
|
|
6503
|
-
*/
|
|
6504
|
-
type DeepPartial<T> = {
|
|
6505
|
-
[P in keyof T]?: Partial<T[P]>;
|
|
6506
|
-
};
|
|
6519
|
+
}>;
|
|
6507
6520
|
type HalstackProviderPropsType = {
|
|
6508
6521
|
theme?: DeepPartial<OpinionatedTheme>;
|
|
6509
6522
|
advancedTheme?: DeepPartial<AdvancedTheme>;
|
|
6510
6523
|
labels?: DeepPartial<TranslatedLabels>;
|
|
6511
|
-
children:
|
|
6524
|
+
children: ReactNode;
|
|
6512
6525
|
};
|
|
6513
6526
|
declare const HalstackProvider: ({ theme, advancedTheme, labels, children }: HalstackProviderPropsType) => JSX.Element;
|
|
6514
6527
|
|
|
6515
|
-
|
|
6528
|
+
declare function useToast(): {
|
|
6529
|
+
default: (toast: DefaultToast) => (() => void) | undefined;
|
|
6530
|
+
success: (toast: SemanticToast) => (() => void) | undefined;
|
|
6531
|
+
warning: (toast: SemanticToast) => (() => void) | undefined;
|
|
6532
|
+
info: (toast: SemanticToast) => (() => void) | undefined;
|
|
6533
|
+
loading: (toast: Omit<LoadingToast, "loading">) => (() => void) | undefined;
|
|
6534
|
+
};
|
|
6535
|
+
|
|
6536
|
+
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, HalstackContext, HalstackLanguageContext, HalstackProvider, useToast };
|