@govtechsg/sgds-web-component 3.19.0-rc.1 → 3.19.0-rc.3
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/components/Stepper/index.umd.min.js +26 -26
- package/components/Stepper/index.umd.min.js.map +1 -1
- package/components/Stepper/sgds-stepper.d.ts +10 -0
- package/components/Stepper/sgds-stepper.js +46 -24
- package/components/Stepper/sgds-stepper.js.map +1 -1
- package/components/Stepper/step.js +1 -1
- package/components/index.umd.min.js +88 -88
- package/components/index.umd.min.js.map +1 -1
- package/css/fouc.css +2 -2
- package/custom-elements.json +761 -754
- package/index.umd.min.js +18 -18
- package/index.umd.min.js.map +1 -1
- package/package.json +1 -1
- package/react/accordion/index.d.ts +3 -1
- package/react/accordion-item/index.d.ts +3 -1
- package/react/alert/index.d.ts +3 -1
- package/react/alert-link/index.d.ts +3 -1
- package/react/badge/index.d.ts +3 -1
- package/react/breadcrumb/index.d.ts +3 -1
- package/react/breadcrumb-item/index.d.ts +3 -1
- package/react/button/index.d.ts +3 -1
- package/react/card/index.d.ts +3 -1
- package/react/checkbox/index.d.ts +3 -1
- package/react/checkbox-group/index.d.ts +3 -1
- package/react/close-button/index.d.ts +3 -1
- package/react/combo-box/index.d.ts +3 -1
- package/react/combo-box-option/index.d.ts +3 -1
- package/react/components/Stepper/sgds-stepper.cjs.js +45 -23
- package/react/components/Stepper/sgds-stepper.cjs.js.map +1 -1
- package/react/components/Stepper/sgds-stepper.js +46 -24
- package/react/components/Stepper/sgds-stepper.js.map +1 -1
- package/react/components/Stepper/step.cjs.js +1 -1
- package/react/components/Stepper/step.js +1 -1
- package/react/datepicker/index.d.ts +3 -1
- package/react/description-list/index.d.ts +3 -1
- package/react/description-list-group/index.d.ts +3 -1
- package/react/divider/index.d.ts +3 -1
- package/react/drawer/index.d.ts +3 -1
- package/react/dropdown/index.d.ts +3 -1
- package/react/dropdown-item/index.d.ts +3 -1
- package/react/file-upload/index.d.ts +3 -1
- package/react/footer/index.d.ts +3 -1
- package/react/footer-item/index.d.ts +3 -1
- package/react/icon/index.d.ts +3 -1
- package/react/icon-button/index.d.ts +3 -1
- package/react/icon-card/index.d.ts +3 -1
- package/react/icon-list/index.d.ts +3 -1
- package/react/image-card/index.d.ts +3 -1
- package/react/index.cjs.js +4 -4
- package/react/index.d.ts +2 -2
- package/react/index.js +2 -2
- package/react/input/index.d.ts +3 -1
- package/react/link/index.d.ts +3 -1
- package/react/mainnav/index.d.ts +3 -1
- package/react/mainnav-dropdown/index.d.ts +3 -1
- package/react/mainnav-item/index.d.ts +3 -1
- package/react/masthead/index.d.ts +3 -1
- package/react/modal/index.d.ts +3 -1
- package/react/overflow-menu/index.d.ts +3 -1
- package/react/pagination/index.d.ts +3 -1
- package/react/progress-bar/index.d.ts +3 -1
- package/react/quantity-toggle/index.d.ts +3 -1
- package/react/radio/index.d.ts +3 -1
- package/react/radio-group/index.d.ts +3 -1
- package/react/select/index.d.ts +3 -1
- package/react/select-option/index.d.ts +3 -1
- package/react/sidebar/index.d.ts +3 -1
- package/react/sidebar-group/index.d.ts +3 -1
- package/react/sidebar-item/index.d.ts +3 -1
- package/react/sidebar-section/index.d.ts +3 -1
- package/react/sidenav/index.d.ts +3 -1
- package/react/sidenav-item/index.d.ts +3 -1
- package/react/sidenav-link/index.d.ts +3 -1
- package/react/skeleton/index.d.ts +3 -1
- package/react/spinner/index.d.ts +3 -1
- package/react/step/index.d.ts +3 -1
- package/react/stepper/index.d.ts +3 -1
- package/react/subnav/index.d.ts +3 -1
- package/react/subnav-item/index.d.ts +3 -1
- package/react/switch/index.d.ts +3 -1
- package/react/system-banner/index.d.ts +3 -1
- package/react/system-banner-item/index.d.ts +3 -1
- package/react/tab/index.d.ts +3 -1
- package/react/tab-group/index.d.ts +3 -1
- package/react/tab-panel/index.d.ts +3 -1
- package/react/table/index.d.ts +3 -1
- package/react/table-cell/index.d.ts +3 -1
- package/react/table-head/index.d.ts +3 -1
- package/react/table-of-contents/index.d.ts +3 -1
- package/react/table-row/index.d.ts +3 -1
- package/react/textarea/index.d.ts +3 -1
- package/react/thumbnail-card/index.d.ts +3 -1
- package/react/toast/index.d.ts +3 -1
- package/react/toast-container/index.d.ts +3 -1
- package/react/tooltip/index.d.ts +3 -1
- package/types/react.d.ts +136 -136
package/types/react.d.ts
CHANGED
|
@@ -26,10 +26,10 @@ export {};
|
|
|
26
26
|
// Helpers
|
|
27
27
|
// ---------------------------------------------------------------------------
|
|
28
28
|
|
|
29
|
-
type SgdsEventHandler = (event: CustomEvent) => void;
|
|
29
|
+
export type SgdsEventHandler = (event: CustomEvent) => void;
|
|
30
30
|
|
|
31
31
|
/** Common props shared by every SGDS element */
|
|
32
|
-
interface SgdsBaseProps extends React.HTMLAttributes<HTMLElement
|
|
32
|
+
export interface SgdsBaseProps extends React.HTMLAttributes<HTMLElement> {
|
|
33
33
|
/** Override the CSS `class` attribute (use `className` in JSX for React) */
|
|
34
34
|
class?: string;
|
|
35
35
|
}
|
|
@@ -91,7 +91,7 @@ interface ISgdsSwitchChangeEventDetail {
|
|
|
91
91
|
|
|
92
92
|
// ── AccordionItem ─────────────────────────────────────────────────────────────
|
|
93
93
|
|
|
94
|
-
interface SgdsAccordionItemProps extends SgdsBaseProps {
|
|
94
|
+
export interface SgdsAccordionItemProps extends SgdsBaseProps {
|
|
95
95
|
/** Controls whether accordion-item is open or close */
|
|
96
96
|
open?: boolean;
|
|
97
97
|
/** Disables the accordion item */
|
|
@@ -106,7 +106,7 @@ interface SgdsAccordionItemProps extends SgdsBaseProps {
|
|
|
106
106
|
|
|
107
107
|
// ── Accordion ─────────────────────────────────────────────────────────────
|
|
108
108
|
|
|
109
|
-
interface SgdsAccordionProps extends SgdsBaseProps {
|
|
109
|
+
export interface SgdsAccordionProps extends SgdsBaseProps {
|
|
110
110
|
/** Allows multiple accordion items to be opened at the same time */
|
|
111
111
|
allowMultiple?: boolean;
|
|
112
112
|
/** The variant of accordion */
|
|
@@ -117,7 +117,7 @@ interface SgdsAccordionProps extends SgdsBaseProps {
|
|
|
117
117
|
|
|
118
118
|
// ── AlertLink ─────────────────────────────────────────────────────────────
|
|
119
119
|
|
|
120
|
-
interface SgdsAlertLinkProps extends SgdsBaseProps {
|
|
120
|
+
export interface SgdsAlertLinkProps extends SgdsBaseProps {
|
|
121
121
|
/** Forwards to href attribute of anchor element */
|
|
122
122
|
href?: string;
|
|
123
123
|
/** Tells the browser where to open the link */
|
|
@@ -126,7 +126,7 @@ interface SgdsAlertLinkProps extends SgdsBaseProps {
|
|
|
126
126
|
|
|
127
127
|
// ── Alert ─────────────────────────────────────────────────────────────
|
|
128
128
|
|
|
129
|
-
interface SgdsAlertProps extends SgdsBaseProps {
|
|
129
|
+
export interface SgdsAlertProps extends SgdsBaseProps {
|
|
130
130
|
/** Controls the appearance of the alert */
|
|
131
131
|
show?: boolean;
|
|
132
132
|
/** Enables a close button that allows the user to dismiss the alert. */
|
|
@@ -141,9 +141,70 @@ interface SgdsAlertProps extends SgdsBaseProps {
|
|
|
141
141
|
"onsgds-hide"?: SgdsEventHandler;
|
|
142
142
|
}
|
|
143
143
|
|
|
144
|
+
// ── Badge ─────────────────────────────────────────────────────────────
|
|
145
|
+
|
|
146
|
+
export interface SgdsBadgeProps extends SgdsBaseProps {
|
|
147
|
+
/** Controls the appearance of the dismissible badge. This prop only applies when dismissible is true */
|
|
148
|
+
show?: boolean;
|
|
149
|
+
/** One or more badge variant combinations.
|
|
150
|
+
Variants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.
|
|
151
|
+
|
|
152
|
+
(@deprecated) The `info` variant is deprecated. Use `primary` instead. */
|
|
153
|
+
variant?: "primary" | "accent" | "success" | "danger" | "warning" | "cyan" | "purple" | "neutral" | "white" | "info";
|
|
154
|
+
/** Manually set the outlined state to false */
|
|
155
|
+
outlined?: boolean;
|
|
156
|
+
/** Manually set the dismissible state of the button to `false` */
|
|
157
|
+
dismissible?: boolean;
|
|
158
|
+
/** Manually enable full width */
|
|
159
|
+
fullWidth?: boolean;
|
|
160
|
+
"onsgds-show"?: SgdsEventHandler;
|
|
161
|
+
"onsgds-hide"?: SgdsEventHandler;
|
|
162
|
+
"onsgds-after-show"?: SgdsEventHandler;
|
|
163
|
+
"onsgds-after-hide"?: SgdsEventHandler;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// ── BreadcrumbItem ─────────────────────────────────────────────────────────────
|
|
167
|
+
|
|
168
|
+
export interface SgdsBreadcrumbItemProps extends SgdsBaseProps {
|
|
169
|
+
/** Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item */
|
|
170
|
+
active?: boolean;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
// ── Breadcrumb ─────────────────────────────────────────────────────────────
|
|
174
|
+
|
|
175
|
+
export interface SgdsBreadcrumbProps extends SgdsBaseProps {
|
|
176
|
+
/** The aria-label of nav element within breadcrumb component. */
|
|
177
|
+
ariaLabel?: string;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
// ── Card ─────────────────────────────────────────────────────────────
|
|
181
|
+
|
|
182
|
+
export interface SgdsCardProps extends SgdsBaseProps {
|
|
183
|
+
/** Sets the image position of the card. Available options: `before`, `after` */
|
|
184
|
+
imagePosition?: CardImagePosition;
|
|
185
|
+
/** Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio` */
|
|
186
|
+
imageAdjustment?: CardImageAdjustment;
|
|
187
|
+
/** Used only for SSR to indicate the presence of the `image` slot. */
|
|
188
|
+
hasImageSlot?: boolean;
|
|
189
|
+
/** Used only for SSR to indicate the presence of the `icon` slot. */
|
|
190
|
+
hasIconSlot?: boolean;
|
|
191
|
+
/** Used only for SSR to indicate the presence of the `upper` slot. */
|
|
192
|
+
hasUpperSlot?: boolean;
|
|
193
|
+
/** Extends the link passed in either `footer` or `link`(deprecated) slot. */
|
|
194
|
+
stretchedLink?: boolean;
|
|
195
|
+
/** Disables the card */
|
|
196
|
+
disabled?: boolean;
|
|
197
|
+
/** When true, hides the default border of the card. */
|
|
198
|
+
hideBorder?: boolean;
|
|
199
|
+
/** When true, applies a tinted background color to the card. */
|
|
200
|
+
tinted?: boolean;
|
|
201
|
+
/** Sets the orientation of the card. Available options: `vertical`, `horizontal` */
|
|
202
|
+
orientation?: CardOrientation;
|
|
203
|
+
}
|
|
204
|
+
|
|
144
205
|
// ── Button ─────────────────────────────────────────────────────────────
|
|
145
206
|
|
|
146
|
-
interface SgdsButtonProps extends SgdsBaseProps {
|
|
207
|
+
export interface SgdsButtonProps extends SgdsBaseProps {
|
|
147
208
|
/** The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server */
|
|
148
209
|
type?: "button" | "submit" | "reset";
|
|
149
210
|
/** The "form owner" to associate the button with. If omitted, the closest containing form will be used instead. The
|
|
@@ -191,70 +252,9 @@ value of this attribute must be an id of a form in the same document or shadow r
|
|
|
191
252
|
"onsgds-focus"?: SgdsEventHandler;
|
|
192
253
|
}
|
|
193
254
|
|
|
194
|
-
// ── BreadcrumbItem ─────────────────────────────────────────────────────────────
|
|
195
|
-
|
|
196
|
-
interface SgdsBreadcrumbItemProps extends SgdsBaseProps {
|
|
197
|
-
/** Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item */
|
|
198
|
-
active?: boolean;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
// ── Breadcrumb ─────────────────────────────────────────────────────────────
|
|
202
|
-
|
|
203
|
-
interface SgdsBreadcrumbProps extends SgdsBaseProps {
|
|
204
|
-
/** The aria-label of nav element within breadcrumb component. */
|
|
205
|
-
ariaLabel?: string;
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
// ── Card ─────────────────────────────────────────────────────────────
|
|
209
|
-
|
|
210
|
-
interface SgdsCardProps extends SgdsBaseProps {
|
|
211
|
-
/** Sets the image position of the card. Available options: `before`, `after` */
|
|
212
|
-
imagePosition?: CardImagePosition;
|
|
213
|
-
/** Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio` */
|
|
214
|
-
imageAdjustment?: CardImageAdjustment;
|
|
215
|
-
/** Used only for SSR to indicate the presence of the `image` slot. */
|
|
216
|
-
hasImageSlot?: boolean;
|
|
217
|
-
/** Used only for SSR to indicate the presence of the `icon` slot. */
|
|
218
|
-
hasIconSlot?: boolean;
|
|
219
|
-
/** Used only for SSR to indicate the presence of the `upper` slot. */
|
|
220
|
-
hasUpperSlot?: boolean;
|
|
221
|
-
/** Extends the link passed in either `footer` or `link`(deprecated) slot. */
|
|
222
|
-
stretchedLink?: boolean;
|
|
223
|
-
/** Disables the card */
|
|
224
|
-
disabled?: boolean;
|
|
225
|
-
/** When true, hides the default border of the card. */
|
|
226
|
-
hideBorder?: boolean;
|
|
227
|
-
/** When true, applies a tinted background color to the card. */
|
|
228
|
-
tinted?: boolean;
|
|
229
|
-
/** Sets the orientation of the card. Available options: `vertical`, `horizontal` */
|
|
230
|
-
orientation?: CardOrientation;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
// ── Badge ─────────────────────────────────────────────────────────────
|
|
234
|
-
|
|
235
|
-
interface SgdsBadgeProps extends SgdsBaseProps {
|
|
236
|
-
/** Controls the appearance of the dismissible badge. This prop only applies when dismissible is true */
|
|
237
|
-
show?: boolean;
|
|
238
|
-
/** One or more badge variant combinations.
|
|
239
|
-
Variants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.
|
|
240
|
-
|
|
241
|
-
(@deprecated) The `info` variant is deprecated. Use `primary` instead. */
|
|
242
|
-
variant?: "primary" | "accent" | "success" | "danger" | "warning" | "cyan" | "purple" | "neutral" | "white" | "info";
|
|
243
|
-
/** Manually set the outlined state to false */
|
|
244
|
-
outlined?: boolean;
|
|
245
|
-
/** Manually set the dismissible state of the button to `false` */
|
|
246
|
-
dismissible?: boolean;
|
|
247
|
-
/** Manually enable full width */
|
|
248
|
-
fullWidth?: boolean;
|
|
249
|
-
"onsgds-show"?: SgdsEventHandler;
|
|
250
|
-
"onsgds-hide"?: SgdsEventHandler;
|
|
251
|
-
"onsgds-after-show"?: SgdsEventHandler;
|
|
252
|
-
"onsgds-after-hide"?: SgdsEventHandler;
|
|
253
|
-
}
|
|
254
|
-
|
|
255
255
|
// ── CheckboxGroup ─────────────────────────────────────────────────────────────
|
|
256
256
|
|
|
257
|
-
interface SgdsCheckboxGroupProps extends SgdsBaseProps {
|
|
257
|
+
export interface SgdsCheckboxGroupProps extends SgdsBaseProps {
|
|
258
258
|
/** The checkbox group's label */
|
|
259
259
|
label?: string;
|
|
260
260
|
/** Feedback text for error state when validated */
|
|
@@ -283,7 +283,7 @@ interface SgdsCheckboxGroupProps extends SgdsBaseProps {
|
|
|
283
283
|
|
|
284
284
|
// ── Checkbox ─────────────────────────────────────────────────────────────
|
|
285
285
|
|
|
286
|
-
interface SgdsCheckboxProps extends SgdsBaseProps {
|
|
286
|
+
export interface SgdsCheckboxProps extends SgdsBaseProps {
|
|
287
287
|
/** Value of the HTML form control. Primarily used to differentiate a list of related checkboxes that have the same name. */
|
|
288
288
|
value?: string;
|
|
289
289
|
/** Draws the checkbox in a checked state. */
|
|
@@ -321,7 +321,7 @@ interface SgdsCheckboxProps extends SgdsBaseProps {
|
|
|
321
321
|
|
|
322
322
|
// ── CloseButton ─────────────────────────────────────────────────────────────
|
|
323
323
|
|
|
324
|
-
interface SgdsCloseButtonProps extends SgdsBaseProps {
|
|
324
|
+
export interface SgdsCloseButtonProps extends SgdsBaseProps {
|
|
325
325
|
/** Specifies a large or small button */
|
|
326
326
|
size?: "sm" | "md";
|
|
327
327
|
/** The tone of the close button */
|
|
@@ -330,7 +330,7 @@ interface SgdsCloseButtonProps extends SgdsBaseProps {
|
|
|
330
330
|
|
|
331
331
|
// ── ComboBoxOption ─────────────────────────────────────────────────────────────
|
|
332
332
|
|
|
333
|
-
interface SgdsComboBoxOptionProps extends SgdsBaseProps {
|
|
333
|
+
export interface SgdsComboBoxOptionProps extends SgdsBaseProps {
|
|
334
334
|
/** Disables the Item */
|
|
335
335
|
disabled?: boolean;
|
|
336
336
|
/** The value of the option item */
|
|
@@ -339,7 +339,7 @@ interface SgdsComboBoxOptionProps extends SgdsBaseProps {
|
|
|
339
339
|
|
|
340
340
|
// ── ComboBox ─────────────────────────────────────────────────────────────
|
|
341
341
|
|
|
342
|
-
interface SgdsComboBoxProps extends SgdsBaseProps {
|
|
342
|
+
export interface SgdsComboBoxProps extends SgdsBaseProps {
|
|
343
343
|
/** If true, renders multiple checkbox selection items. If false, single-select. */
|
|
344
344
|
multiSelect?: boolean;
|
|
345
345
|
/** If true, renders badge that fills width of combobox */
|
|
@@ -413,7 +413,7 @@ value: string;
|
|
|
413
413
|
|
|
414
414
|
// ── Datepicker ─────────────────────────────────────────────────────────────
|
|
415
415
|
|
|
416
|
-
interface SgdsDatepickerProps extends SgdsBaseProps {
|
|
416
|
+
export interface SgdsDatepickerProps extends SgdsBaseProps {
|
|
417
417
|
/** When true, adds required attribute to input element */
|
|
418
418
|
required?: boolean;
|
|
419
419
|
/** The datepicker input's name attribute */
|
|
@@ -470,7 +470,7 @@ range mode as array of string. eg.'["22/12/2023"]' for single &
|
|
|
470
470
|
|
|
471
471
|
// ── DescriptionListGroup ─────────────────────────────────────────────────────────────
|
|
472
472
|
|
|
473
|
-
interface SgdsDescriptionListGroupProps extends SgdsBaseProps {
|
|
473
|
+
export interface SgdsDescriptionListGroupProps extends SgdsBaseProps {
|
|
474
474
|
/** When true, adds a border around the entire group. */
|
|
475
475
|
bordered?: boolean;
|
|
476
476
|
/** When true, the description lists are displayed in a stacked layout. */
|
|
@@ -483,7 +483,7 @@ interface SgdsDescriptionListGroupProps extends SgdsBaseProps {
|
|
|
483
483
|
|
|
484
484
|
// ── DescriptionList ─────────────────────────────────────────────────────────────
|
|
485
485
|
|
|
486
|
-
interface SgdsDescriptionListProps extends SgdsBaseProps {
|
|
486
|
+
export interface SgdsDescriptionListProps extends SgdsBaseProps {
|
|
487
487
|
/** Makes the label and the data stacked */
|
|
488
488
|
stacked?: boolean;
|
|
489
489
|
/** Changes the border bottom styles for bordered description list group */
|
|
@@ -492,7 +492,7 @@ interface SgdsDescriptionListProps extends SgdsBaseProps {
|
|
|
492
492
|
|
|
493
493
|
// ── Divider ─────────────────────────────────────────────────────────────
|
|
494
494
|
|
|
495
|
-
interface SgdsDividerProps extends SgdsBaseProps {
|
|
495
|
+
export interface SgdsDividerProps extends SgdsBaseProps {
|
|
496
496
|
/** Sets the orientation of divider to vertical. Defaults to horizontal */
|
|
497
497
|
orientation?: "horizontal" | "vertical";
|
|
498
498
|
/** Sets the orientation of divider to vertical. Defaults to false */
|
|
@@ -501,7 +501,7 @@ interface SgdsDividerProps extends SgdsBaseProps {
|
|
|
501
501
|
|
|
502
502
|
// ── Drawer ─────────────────────────────────────────────────────────────
|
|
503
503
|
|
|
504
|
-
interface SgdsDrawerProps extends SgdsBaseProps {
|
|
504
|
+
export interface SgdsDrawerProps extends SgdsBaseProps {
|
|
505
505
|
/** Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can
|
|
506
506
|
use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state. */
|
|
507
507
|
open?: boolean;
|
|
@@ -525,7 +525,7 @@ its parent element, set this attribute and add `position: relative` to the paren
|
|
|
525
525
|
|
|
526
526
|
// ── DropdownItem ─────────────────────────────────────────────────────────────
|
|
527
527
|
|
|
528
|
-
interface SgdsDropdownItemProps extends SgdsBaseProps {
|
|
528
|
+
export interface SgdsDropdownItemProps extends SgdsBaseProps {
|
|
529
529
|
/** when true, sets the active stylings of dropdown item */
|
|
530
530
|
active?: boolean;
|
|
531
531
|
/** Disables the SgdsMainnavItem */
|
|
@@ -534,7 +534,7 @@ interface SgdsDropdownItemProps extends SgdsBaseProps {
|
|
|
534
534
|
|
|
535
535
|
// ── Dropdown ─────────────────────────────────────────────────────────────
|
|
536
536
|
|
|
537
|
-
interface SgdsDropdownProps extends SgdsBaseProps {
|
|
537
|
+
export interface SgdsDropdownProps extends SgdsBaseProps {
|
|
538
538
|
/** Controls auto-flipping of menu */
|
|
539
539
|
noFlip?: boolean;
|
|
540
540
|
/** When true, aligns right edge of menu with right edge of button */
|
|
@@ -559,7 +559,7 @@ interface SgdsDropdownProps extends SgdsBaseProps {
|
|
|
559
559
|
|
|
560
560
|
// ── FileUpload ─────────────────────────────────────────────────────────────
|
|
561
561
|
|
|
562
|
-
interface SgdsFileUploadProps extends SgdsBaseProps {
|
|
562
|
+
export interface SgdsFileUploadProps extends SgdsBaseProps {
|
|
563
563
|
/** Allows multiple files to be listed for uploading */
|
|
564
564
|
multiple?: boolean;
|
|
565
565
|
/** Specify the acceptable file type */
|
|
@@ -591,12 +591,12 @@ interface SgdsFileUploadProps extends SgdsBaseProps {
|
|
|
591
591
|
|
|
592
592
|
// ── FooterItem ─────────────────────────────────────────────────────────────
|
|
593
593
|
|
|
594
|
-
interface SgdsFooterItemProps extends SgdsBaseProps {
|
|
594
|
+
export interface SgdsFooterItemProps extends SgdsBaseProps {
|
|
595
595
|
}
|
|
596
596
|
|
|
597
597
|
// ── Footer ─────────────────────────────────────────────────────────────
|
|
598
598
|
|
|
599
|
-
interface SgdsFooterProps extends SgdsBaseProps {
|
|
599
|
+
export interface SgdsFooterProps extends SgdsBaseProps {
|
|
600
600
|
/** Sets copyrightLiner of SgdsFooter */
|
|
601
601
|
copyrightLiner?: string;
|
|
602
602
|
/** href link for contacts */
|
|
@@ -623,7 +623,7 @@ interface SgdsFooterProps extends SgdsBaseProps {
|
|
|
623
623
|
|
|
624
624
|
// ── Icon ─────────────────────────────────────────────────────────────
|
|
625
625
|
|
|
626
|
-
interface SgdsIconProps extends SgdsBaseProps {
|
|
626
|
+
export interface SgdsIconProps extends SgdsBaseProps {
|
|
627
627
|
/** The name of the icon from sgds icon library */
|
|
628
628
|
name?: string;
|
|
629
629
|
/** Specifies a small, medium or large icon, the size is medium by default. */
|
|
@@ -632,7 +632,7 @@ interface SgdsIconProps extends SgdsBaseProps {
|
|
|
632
632
|
|
|
633
633
|
// ── IconButton ─────────────────────────────────────────────────────────────
|
|
634
634
|
|
|
635
|
-
interface SgdsIconButtonProps extends SgdsBaseProps {
|
|
635
|
+
export interface SgdsIconButtonProps extends SgdsBaseProps {
|
|
636
636
|
/** The name of the icon from sgds icon library */
|
|
637
637
|
name?: string;
|
|
638
638
|
/** Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6 */
|
|
@@ -661,7 +661,7 @@ interface SgdsIconButtonProps extends SgdsBaseProps {
|
|
|
661
661
|
|
|
662
662
|
// ── IconCard ─────────────────────────────────────────────────────────────
|
|
663
663
|
|
|
664
|
-
interface SgdsIconCardProps extends SgdsBaseProps {
|
|
664
|
+
export interface SgdsIconCardProps extends SgdsBaseProps {
|
|
665
665
|
/** Removes the card's internal padding when set to true. */
|
|
666
666
|
noPadding?: boolean;
|
|
667
667
|
/** Extends the link passed in either `footer` or `link`(deprecated) slot. */
|
|
@@ -678,7 +678,7 @@ interface SgdsIconCardProps extends SgdsBaseProps {
|
|
|
678
678
|
|
|
679
679
|
// ── IconList ─────────────────────────────────────────────────────────────
|
|
680
680
|
|
|
681
|
-
interface SgdsIconListProps extends SgdsBaseProps {
|
|
681
|
+
export interface SgdsIconListProps extends SgdsBaseProps {
|
|
682
682
|
/** Sets the aria-role of the sgds-icon-list */
|
|
683
683
|
role?: string;
|
|
684
684
|
/** The size of icon list. Changes the font-size the list items */
|
|
@@ -687,7 +687,7 @@ interface SgdsIconListProps extends SgdsBaseProps {
|
|
|
687
687
|
|
|
688
688
|
// ── ImageCard ─────────────────────────────────────────────────────────────
|
|
689
689
|
|
|
690
|
-
interface SgdsImageCardProps extends SgdsBaseProps {
|
|
690
|
+
export interface SgdsImageCardProps extends SgdsBaseProps {
|
|
691
691
|
/** Removes the card's internal padding when set to true. */
|
|
692
692
|
noPadding?: boolean;
|
|
693
693
|
/** Sets the image position of the card. Available options: `before`, `after` */
|
|
@@ -708,7 +708,7 @@ interface SgdsImageCardProps extends SgdsBaseProps {
|
|
|
708
708
|
|
|
709
709
|
// ── Input ─────────────────────────────────────────────────────────────
|
|
710
710
|
|
|
711
|
-
interface SgdsInputProps extends SgdsBaseProps {
|
|
711
|
+
export interface SgdsInputProps extends SgdsBaseProps {
|
|
712
712
|
type?: | "email"
|
|
713
713
|
| "number"
|
|
714
714
|
| "password"
|
|
@@ -781,7 +781,7 @@ implied, allowing any numeric value. Only applies to number input types. */
|
|
|
781
781
|
|
|
782
782
|
// ── Link ─────────────────────────────────────────────────────────────
|
|
783
783
|
|
|
784
|
-
interface SgdsLinkProps extends SgdsBaseProps {
|
|
784
|
+
export interface SgdsLinkProps extends SgdsBaseProps {
|
|
785
785
|
/** Determines the size of the link */
|
|
786
786
|
size?: "xs" | "sm" | "md" | "lg";
|
|
787
787
|
/** Sets the colour of the link @deprecated since 3.6.0 */
|
|
@@ -796,7 +796,7 @@ interface SgdsLinkProps extends SgdsBaseProps {
|
|
|
796
796
|
|
|
797
797
|
// ── MainnavDropdown ─────────────────────────────────────────────────────────────
|
|
798
798
|
|
|
799
|
-
interface SgdsMainnavDropdownProps extends SgdsBaseProps {
|
|
799
|
+
export interface SgdsMainnavDropdownProps extends SgdsBaseProps {
|
|
800
800
|
/** When true, applies active styles on the dropdown button */
|
|
801
801
|
active?: boolean;
|
|
802
802
|
/** When true, applies active styles on the dropdown button */
|
|
@@ -805,7 +805,7 @@ interface SgdsMainnavDropdownProps extends SgdsBaseProps {
|
|
|
805
805
|
|
|
806
806
|
// ── MainnavItem ─────────────────────────────────────────────────────────────
|
|
807
807
|
|
|
808
|
-
interface SgdsMainnavItemProps extends SgdsBaseProps {
|
|
808
|
+
export interface SgdsMainnavItemProps extends SgdsBaseProps {
|
|
809
809
|
/** when true, sets the active stylings of the navigation item */
|
|
810
810
|
active?: boolean;
|
|
811
811
|
/** Disables the SgdsMainnavItem */
|
|
@@ -814,7 +814,7 @@ interface SgdsMainnavItemProps extends SgdsBaseProps {
|
|
|
814
814
|
|
|
815
815
|
// ── Mainnav ─────────────────────────────────────────────────────────────
|
|
816
816
|
|
|
817
|
-
interface SgdsMainnavProps extends SgdsBaseProps {
|
|
817
|
+
export interface SgdsMainnavProps extends SgdsBaseProps {
|
|
818
818
|
/** Used only for SSR to indicate the presence of the `non-collapsible` slot. */
|
|
819
819
|
hasNonCollapsibleSlot?: boolean;
|
|
820
820
|
/** The href link for brand logo */
|
|
@@ -831,14 +831,14 @@ interface SgdsMainnavProps extends SgdsBaseProps {
|
|
|
831
831
|
|
|
832
832
|
// ── Masthead ─────────────────────────────────────────────────────────────
|
|
833
833
|
|
|
834
|
-
interface SgdsMastheadProps extends SgdsBaseProps {
|
|
834
|
+
export interface SgdsMastheadProps extends SgdsBaseProps {
|
|
835
835
|
/** When true, removes max-width constraint to allow content to stretch full screen width */
|
|
836
836
|
fluid?: boolean;
|
|
837
837
|
}
|
|
838
838
|
|
|
839
839
|
// ── Modal ─────────────────────────────────────────────────────────────
|
|
840
840
|
|
|
841
|
-
interface SgdsModalProps extends SgdsBaseProps {
|
|
841
|
+
export interface SgdsModalProps extends SgdsBaseProps {
|
|
842
842
|
/** Indicates whether or not the modal is open. You can use this in lieu of the show/hide methods. */
|
|
843
843
|
open?: boolean;
|
|
844
844
|
/** Removes the default animation when opening and closing of modal */
|
|
@@ -858,14 +858,14 @@ interface SgdsModalProps extends SgdsBaseProps {
|
|
|
858
858
|
|
|
859
859
|
// ── OverflowMenu ─────────────────────────────────────────────────────────────
|
|
860
860
|
|
|
861
|
-
interface SgdsOverflowMenuProps extends SgdsBaseProps {
|
|
861
|
+
export interface SgdsOverflowMenuProps extends SgdsBaseProps {
|
|
862
862
|
/** Specifies a large or small button */
|
|
863
863
|
size?: "sm" | "md";
|
|
864
864
|
}
|
|
865
865
|
|
|
866
866
|
// ── Pagination ─────────────────────────────────────────────────────────────
|
|
867
867
|
|
|
868
|
-
interface SgdsPaginationProps extends SgdsBaseProps {
|
|
868
|
+
export interface SgdsPaginationProps extends SgdsBaseProps {
|
|
869
869
|
/** Inserts the length value from a given sets of data objects */
|
|
870
870
|
dataLength?: number;
|
|
871
871
|
/** Sets the starting active page upon render */
|
|
@@ -883,7 +883,7 @@ interface SgdsPaginationProps extends SgdsBaseProps {
|
|
|
883
883
|
|
|
884
884
|
// ── ProgressBar ─────────────────────────────────────────────────────────────
|
|
885
885
|
|
|
886
|
-
interface SgdsProgressBarProps extends SgdsBaseProps {
|
|
886
|
+
export interface SgdsProgressBarProps extends SgdsBaseProps {
|
|
887
887
|
/** The background color of the progress bar. Available options: `primary`, `neutral` */
|
|
888
888
|
variant?: "primary" | "neutral";
|
|
889
889
|
/** The current progress as a percentage, from 0 to 100. */
|
|
@@ -904,7 +904,7 @@ The aria-valuemax attribute defines the maximum allowed value for a range widget
|
|
|
904
904
|
|
|
905
905
|
// ── QuantityToggle ─────────────────────────────────────────────────────────────
|
|
906
906
|
|
|
907
|
-
interface SgdsQuantityToggleProps extends SgdsBaseProps {
|
|
907
|
+
export interface SgdsQuantityToggleProps extends SgdsBaseProps {
|
|
908
908
|
/** The input's value. Set to 0 by default */
|
|
909
909
|
value?: number;
|
|
910
910
|
/** Controls the incremental / decremental value of the input */
|
|
@@ -941,7 +941,7 @@ interface SgdsQuantityToggleProps extends SgdsBaseProps {
|
|
|
941
941
|
|
|
942
942
|
// ── RadioGroup ─────────────────────────────────────────────────────────────
|
|
943
943
|
|
|
944
|
-
interface SgdsRadioGroupProps extends SgdsBaseProps {
|
|
944
|
+
export interface SgdsRadioGroupProps extends SgdsBaseProps {
|
|
945
945
|
/** The selected value of the control. */
|
|
946
946
|
value?: string;
|
|
947
947
|
/** Feedback text for error state when validated */
|
|
@@ -971,7 +971,7 @@ interface SgdsRadioGroupProps extends SgdsBaseProps {
|
|
|
971
971
|
|
|
972
972
|
// ── Radio ─────────────────────────────────────────────────────────────
|
|
973
973
|
|
|
974
|
-
interface SgdsRadioProps extends SgdsBaseProps {
|
|
974
|
+
export interface SgdsRadioProps extends SgdsBaseProps {
|
|
975
975
|
/** Draws the radio in a checked state. When used with SgdsRadioGroup, the value prop of SgdsRadioGroup overrides the checked prop */
|
|
976
976
|
checked?: boolean;
|
|
977
977
|
/** The radio's value attribute. */
|
|
@@ -988,7 +988,7 @@ interface SgdsRadioProps extends SgdsBaseProps {
|
|
|
988
988
|
|
|
989
989
|
// ── SelectOption ─────────────────────────────────────────────────────────────
|
|
990
990
|
|
|
991
|
-
interface SgdsSelectOptionProps extends SgdsBaseProps {
|
|
991
|
+
export interface SgdsSelectOptionProps extends SgdsBaseProps {
|
|
992
992
|
/** Disables the Item */
|
|
993
993
|
disabled?: boolean;
|
|
994
994
|
/** The value of the option item */
|
|
@@ -997,7 +997,7 @@ interface SgdsSelectOptionProps extends SgdsBaseProps {
|
|
|
997
997
|
|
|
998
998
|
// ── Select ─────────────────────────────────────────────────────────────
|
|
999
999
|
|
|
1000
|
-
interface SgdsSelectProps extends SgdsBaseProps {
|
|
1000
|
+
export interface SgdsSelectProps extends SgdsBaseProps {
|
|
1001
1001
|
/** The input's label */
|
|
1002
1002
|
label?: string;
|
|
1003
1003
|
/** The input's hint text below the label */
|
|
@@ -1054,7 +1054,7 @@ value: string;
|
|
|
1054
1054
|
|
|
1055
1055
|
// ── SidebarGroup ─────────────────────────────────────────────────────────────
|
|
1056
1056
|
|
|
1057
|
-
interface SgdsSidebarGroupProps extends SgdsBaseProps {
|
|
1057
|
+
export interface SgdsSidebarGroupProps extends SgdsBaseProps {
|
|
1058
1058
|
/** Reports the visibility state of the submenu for nested groups.
|
|
1059
1059
|
Returns true when the submenu is displayed showing child items, false when hidden.
|
|
1060
1060
|
Only applicable for nested groups (level 2+). Root-level groups use drawer overlay instead. */
|
|
@@ -1070,7 +1070,7 @@ Should be unique among siblings in the same navigation level. */
|
|
|
1070
1070
|
|
|
1071
1071
|
// ── SidebarItem ─────────────────────────────────────────────────────────────
|
|
1072
1072
|
|
|
1073
|
-
interface SgdsSidebarItemProps extends SgdsBaseProps {
|
|
1073
|
+
export interface SgdsSidebarItemProps extends SgdsBaseProps {
|
|
1074
1074
|
/** The display title/label for the sidebar element.
|
|
1075
1075
|
Shown in the UI and used for accessibility labels (aria-label). */
|
|
1076
1076
|
title?: string;
|
|
@@ -1082,7 +1082,7 @@ Should be unique among siblings in the same navigation level. */
|
|
|
1082
1082
|
|
|
1083
1083
|
// ── SidebarSection ─────────────────────────────────────────────────────────────
|
|
1084
1084
|
|
|
1085
|
-
interface SgdsSidebarSectionProps extends SgdsBaseProps {
|
|
1085
|
+
export interface SgdsSidebarSectionProps extends SgdsBaseProps {
|
|
1086
1086
|
/** The display title/label for the sidebar section header.
|
|
1087
1087
|
Always visible in the sidebar, used to group related items. */
|
|
1088
1088
|
title?: string;
|
|
@@ -1104,7 +1104,7 @@ Should be unique among siblings in the same navigation level. */
|
|
|
1104
1104
|
|
|
1105
1105
|
// ── Sidebar ─────────────────────────────────────────────────────────────
|
|
1106
1106
|
|
|
1107
|
-
interface SgdsSidebarProps extends SgdsBaseProps {
|
|
1107
|
+
export interface SgdsSidebarProps extends SgdsBaseProps {
|
|
1108
1108
|
/** Controls whether the sidebar is collapsed or expanded to save screen space.
|
|
1109
1109
|
When true, sidebar displays icon-only mode for root items. When false, full labels and content are shown.
|
|
1110
1110
|
On mobile devices (width <= 576px), this is automatically toggled based on screen size.
|
|
@@ -1133,7 +1133,7 @@ Override when your page uses a more specific term (e.g. `"Dashboard navigation"`
|
|
|
1133
1133
|
|
|
1134
1134
|
// ── SidenavItem ─────────────────────────────────────────────────────────────
|
|
1135
1135
|
|
|
1136
|
-
interface SgdsSidenavItemProps extends SgdsBaseProps {
|
|
1136
|
+
export interface SgdsSidenavItemProps extends SgdsBaseProps {
|
|
1137
1137
|
body?: HTMLElement;
|
|
1138
1138
|
/** when true, toggles the sidenav-item to open on first load and set the active stylings. */
|
|
1139
1139
|
active?: boolean;
|
|
@@ -1148,7 +1148,7 @@ interface SgdsSidenavItemProps extends SgdsBaseProps {
|
|
|
1148
1148
|
|
|
1149
1149
|
// ── SidenavLink ─────────────────────────────────────────────────────────────
|
|
1150
1150
|
|
|
1151
|
-
interface SgdsSidenavLinkProps extends SgdsBaseProps {
|
|
1151
|
+
export interface SgdsSidenavLinkProps extends SgdsBaseProps {
|
|
1152
1152
|
/** when true, sets the active stylings of .nav-link */
|
|
1153
1153
|
active?: boolean;
|
|
1154
1154
|
/** Disables the SgdsMainnavItem */
|
|
@@ -1157,14 +1157,14 @@ interface SgdsSidenavLinkProps extends SgdsBaseProps {
|
|
|
1157
1157
|
|
|
1158
1158
|
// ── Sidenav ─────────────────────────────────────────────────────────────
|
|
1159
1159
|
|
|
1160
|
-
interface SgdsSidenavProps extends SgdsBaseProps {
|
|
1160
|
+
export interface SgdsSidenavProps extends SgdsBaseProps {
|
|
1161
1161
|
/** Apply position sticky to the sidenav */
|
|
1162
1162
|
sticky?: boolean;
|
|
1163
1163
|
}
|
|
1164
1164
|
|
|
1165
1165
|
// ── Skeleton ─────────────────────────────────────────────────────────────
|
|
1166
1166
|
|
|
1167
|
-
interface SgdsSkeletonProps extends SgdsBaseProps {
|
|
1167
|
+
export interface SgdsSkeletonProps extends SgdsBaseProps {
|
|
1168
1168
|
/** Sets the width of skeleton. Pass value in string with length units like pixels or percentage. */
|
|
1169
1169
|
width?: string;
|
|
1170
1170
|
/** Sets the height of skeleton. Pass value in string with length units like pixels or percentage. */
|
|
@@ -1182,7 +1182,7 @@ taking into account that there is a gap set by root css variable `--sgds-gap-xs`
|
|
|
1182
1182
|
|
|
1183
1183
|
// ── Spinner ─────────────────────────────────────────────────────────────
|
|
1184
1184
|
|
|
1185
|
-
interface SgdsSpinnerProps extends SgdsBaseProps {
|
|
1185
|
+
export interface SgdsSpinnerProps extends SgdsBaseProps {
|
|
1186
1186
|
/** The variant of spinner. Deprecated in favor of `tone` @deprecated */
|
|
1187
1187
|
variant?: "primary" | "neutral";
|
|
1188
1188
|
/** The color tones of spinner, replaces variant prop */
|
|
@@ -1197,7 +1197,7 @@ interface SgdsSpinnerProps extends SgdsBaseProps {
|
|
|
1197
1197
|
|
|
1198
1198
|
// ── Step ─────────────────────────────────────────────────────────────
|
|
1199
1199
|
|
|
1200
|
-
interface SgdsStepProps extends SgdsBaseProps {
|
|
1200
|
+
export interface SgdsStepProps extends SgdsBaseProps {
|
|
1201
1201
|
/** The header text for the step */
|
|
1202
1202
|
stepHeader?: string;
|
|
1203
1203
|
/** Optional icon name to display instead of step number */
|
|
@@ -1208,7 +1208,7 @@ interface SgdsStepProps extends SgdsBaseProps {
|
|
|
1208
1208
|
|
|
1209
1209
|
// ── Stepper ─────────────────────────────────────────────────────────────
|
|
1210
1210
|
|
|
1211
|
-
interface SgdsStepperProps extends SgdsBaseProps {
|
|
1211
|
+
export interface SgdsStepperProps extends SgdsBaseProps {
|
|
1212
1212
|
/** The metadata of stepper, type `IStepMetaData`. Deprecated: use sgds-step child components instead. */
|
|
1213
1213
|
steps?: IStepMetaData[];
|
|
1214
1214
|
/** The current state of active step. Defaults to 0 */
|
|
@@ -1229,7 +1229,7 @@ interface SgdsStepperProps extends SgdsBaseProps {
|
|
|
1229
1229
|
|
|
1230
1230
|
// ── SubnavItem ─────────────────────────────────────────────────────────────
|
|
1231
1231
|
|
|
1232
|
-
interface SgdsSubnavItemProps extends SgdsBaseProps {
|
|
1232
|
+
export interface SgdsSubnavItemProps extends SgdsBaseProps {
|
|
1233
1233
|
/** when true, sets the active stylings of the navigation item */
|
|
1234
1234
|
active?: boolean;
|
|
1235
1235
|
/** Disables the SgdsSubnavItem */
|
|
@@ -1238,7 +1238,7 @@ interface SgdsSubnavItemProps extends SgdsBaseProps {
|
|
|
1238
1238
|
|
|
1239
1239
|
// ── Subnav ─────────────────────────────────────────────────────────────
|
|
1240
1240
|
|
|
1241
|
-
interface SgdsSubnavProps extends SgdsBaseProps {
|
|
1241
|
+
export interface SgdsSubnavProps extends SgdsBaseProps {
|
|
1242
1242
|
/** Used only for SSR to indicate the presence of the `actions` slot. */
|
|
1243
1243
|
hasActionsSlot?: boolean;
|
|
1244
1244
|
"onsgds-show"?: SgdsEventHandler;
|
|
@@ -1249,7 +1249,7 @@ interface SgdsSubnavProps extends SgdsBaseProps {
|
|
|
1249
1249
|
|
|
1250
1250
|
// ── Switch ─────────────────────────────────────────────────────────────
|
|
1251
1251
|
|
|
1252
|
-
interface SgdsSwitchProps extends SgdsBaseProps {
|
|
1252
|
+
export interface SgdsSwitchProps extends SgdsBaseProps {
|
|
1253
1253
|
/** The size of the switch. By default, it is small size */
|
|
1254
1254
|
size?: "sm" | "md" | "lg";
|
|
1255
1255
|
/** When enabled, icon appears in the switch */
|
|
@@ -1267,7 +1267,7 @@ interface SgdsSwitchProps extends SgdsBaseProps {
|
|
|
1267
1267
|
|
|
1268
1268
|
// ── SystemBannerItem ─────────────────────────────────────────────────────────────
|
|
1269
1269
|
|
|
1270
|
-
interface SgdsSystemBannerItemProps extends SgdsBaseProps {
|
|
1270
|
+
export interface SgdsSystemBannerItemProps extends SgdsBaseProps {
|
|
1271
1271
|
/** Used only for SSR to indicate the presence of the `action` slot. */
|
|
1272
1272
|
hasActionSlot?: boolean;
|
|
1273
1273
|
/** Disables the action link that appears when text content is clamped */
|
|
@@ -1277,7 +1277,7 @@ interface SgdsSystemBannerItemProps extends SgdsBaseProps {
|
|
|
1277
1277
|
|
|
1278
1278
|
// ── SystemBanner ─────────────────────────────────────────────────────────────
|
|
1279
1279
|
|
|
1280
|
-
interface SgdsSystemBannerProps extends SgdsBaseProps {
|
|
1280
|
+
export interface SgdsSystemBannerProps extends SgdsBaseProps {
|
|
1281
1281
|
/** Controls the appearance of the alert */
|
|
1282
1282
|
show?: boolean;
|
|
1283
1283
|
/** Enables a close button that allows the user to dismiss the alert. */
|
|
@@ -1292,7 +1292,7 @@ interface SgdsSystemBannerProps extends SgdsBaseProps {
|
|
|
1292
1292
|
|
|
1293
1293
|
// ── TabGroup ─────────────────────────────────────────────────────────────
|
|
1294
1294
|
|
|
1295
|
-
interface SgdsTabGroupProps extends SgdsBaseProps {
|
|
1295
|
+
export interface SgdsTabGroupProps extends SgdsBaseProps {
|
|
1296
1296
|
/** The variant of tabs. Controls the visual styles of all `sgds-tabs` in its slot. It also sets the variant atttribute of `sgds-tab` */
|
|
1297
1297
|
variant?: "underlined" | "solid";
|
|
1298
1298
|
/** The orientation of tabs. Controls the orientation of all `sgds-tabs` in its slot. It also sets the orientation attribute of `sgds-tab` */
|
|
@@ -1305,7 +1305,7 @@ interface SgdsTabGroupProps extends SgdsBaseProps {
|
|
|
1305
1305
|
|
|
1306
1306
|
// ── TabPanel ─────────────────────────────────────────────────────────────
|
|
1307
1307
|
|
|
1308
|
-
interface SgdsTabPanelProps extends SgdsBaseProps {
|
|
1308
|
+
export interface SgdsTabPanelProps extends SgdsBaseProps {
|
|
1309
1309
|
/** The tab panel's name. */
|
|
1310
1310
|
name?: string;
|
|
1311
1311
|
/** When true, the tab panel will be shown. When used with tab-group, this property is already being managed */
|
|
@@ -1314,7 +1314,7 @@ interface SgdsTabPanelProps extends SgdsBaseProps {
|
|
|
1314
1314
|
|
|
1315
1315
|
// ── Tab ─────────────────────────────────────────────────────────────
|
|
1316
1316
|
|
|
1317
|
-
interface SgdsTabProps extends SgdsBaseProps {
|
|
1317
|
+
export interface SgdsTabProps extends SgdsBaseProps {
|
|
1318
1318
|
/** The name of the tab panel this tab is associated with. The panel must be located in the same tab group. */
|
|
1319
1319
|
panel?: string;
|
|
1320
1320
|
/** Draws the tab in an active state. When used with tab group, this state is already managed. Use it to set the initial active tab on first load of page */
|
|
@@ -1325,22 +1325,22 @@ interface SgdsTabProps extends SgdsBaseProps {
|
|
|
1325
1325
|
|
|
1326
1326
|
// ── TableCell ─────────────────────────────────────────────────────────────
|
|
1327
1327
|
|
|
1328
|
-
interface SgdsTableCellProps extends SgdsBaseProps {
|
|
1328
|
+
export interface SgdsTableCellProps extends SgdsBaseProps {
|
|
1329
1329
|
}
|
|
1330
1330
|
|
|
1331
1331
|
// ── TableHead ─────────────────────────────────────────────────────────────
|
|
1332
1332
|
|
|
1333
|
-
interface SgdsTableHeadProps extends SgdsBaseProps {
|
|
1333
|
+
export interface SgdsTableHeadProps extends SgdsBaseProps {
|
|
1334
1334
|
}
|
|
1335
1335
|
|
|
1336
1336
|
// ── TableRow ─────────────────────────────────────────────────────────────
|
|
1337
1337
|
|
|
1338
|
-
interface SgdsTableRowProps extends SgdsBaseProps {
|
|
1338
|
+
export interface SgdsTableRowProps extends SgdsBaseProps {
|
|
1339
1339
|
}
|
|
1340
1340
|
|
|
1341
1341
|
// ── Table ─────────────────────────────────────────────────────────────
|
|
1342
1342
|
|
|
1343
|
-
interface SgdsTableProps extends SgdsBaseProps {
|
|
1343
|
+
export interface SgdsTableProps extends SgdsBaseProps {
|
|
1344
1344
|
/** Specifies the responsive breakpoint for the table.
|
|
1345
1345
|
Use "sm", "md", "lg", or "xl" to create responsive tables up to a particular breakpoint.
|
|
1346
1346
|
From that breakpoint and up, the table will behave normally and not scroll horizontally.
|
|
@@ -1369,12 +1369,12 @@ When true, displays visible borders between all table cells. */
|
|
|
1369
1369
|
|
|
1370
1370
|
// ── TableOfContents ─────────────────────────────────────────────────────────────
|
|
1371
1371
|
|
|
1372
|
-
interface SgdsTableOfContentsProps extends SgdsBaseProps {
|
|
1372
|
+
export interface SgdsTableOfContentsProps extends SgdsBaseProps {
|
|
1373
1373
|
}
|
|
1374
1374
|
|
|
1375
1375
|
// ── Textarea ─────────────────────────────────────────────────────────────
|
|
1376
1376
|
|
|
1377
|
-
interface SgdsTextareaProps extends SgdsBaseProps {
|
|
1377
|
+
export interface SgdsTextareaProps extends SgdsBaseProps {
|
|
1378
1378
|
/** The textarea's name attribute */
|
|
1379
1379
|
name?: string;
|
|
1380
1380
|
/** The textarea's value attribute. */
|
|
@@ -1436,7 +1436,7 @@ interface SgdsTextareaProps extends SgdsBaseProps {
|
|
|
1436
1436
|
|
|
1437
1437
|
// ── ThumbnailCard ─────────────────────────────────────────────────────────────
|
|
1438
1438
|
|
|
1439
|
-
interface SgdsThumbnailCardProps extends SgdsBaseProps {
|
|
1439
|
+
export interface SgdsThumbnailCardProps extends SgdsBaseProps {
|
|
1440
1440
|
/** Removes the card's internal padding when set to true. */
|
|
1441
1441
|
noPadding?: boolean;
|
|
1442
1442
|
/** Extends the link passed in either `footer` or `link`(deprecated) slot. */
|
|
@@ -1453,7 +1453,7 @@ interface SgdsThumbnailCardProps extends SgdsBaseProps {
|
|
|
1453
1453
|
|
|
1454
1454
|
// ── ToastContainer ─────────────────────────────────────────────────────────────
|
|
1455
1455
|
|
|
1456
|
-
interface SgdsToastContainerProps extends SgdsBaseProps {
|
|
1456
|
+
export interface SgdsToastContainerProps extends SgdsBaseProps {
|
|
1457
1457
|
/** Controls the position of `sgds-toast` within itself.
|
|
1458
1458
|
Since 3.7.1, the positions "top-start", "middle-start", "middle-center", and "middle-end" are deprecated. */
|
|
1459
1459
|
position?: "top-start" | "top-center" | "top-end" | "middle-start" | "middle-center" | "middle-end" | "bottom-start" | "bottom-center" | "bottom-end";
|
|
@@ -1461,7 +1461,7 @@ Since 3.7.1, the positions "top-start", "middle-start", "middle-center", and "mi
|
|
|
1461
1461
|
|
|
1462
1462
|
// ── Toast ─────────────────────────────────────────────────────────────
|
|
1463
1463
|
|
|
1464
|
-
interface SgdsToastProps extends SgdsBaseProps {
|
|
1464
|
+
export interface SgdsToastProps extends SgdsBaseProps {
|
|
1465
1465
|
/** Controls the appearance of toast */
|
|
1466
1466
|
show?: boolean;
|
|
1467
1467
|
/** The header title of toast. It is required to assign a title to toast */
|
|
@@ -1484,7 +1484,7 @@ interface SgdsToastProps extends SgdsBaseProps {
|
|
|
1484
1484
|
|
|
1485
1485
|
// ── Tooltip ─────────────────────────────────────────────────────────────
|
|
1486
1486
|
|
|
1487
|
-
interface SgdsTooltipProps extends SgdsBaseProps {
|
|
1487
|
+
export interface SgdsTooltipProps extends SgdsBaseProps {
|
|
1488
1488
|
/** The tooltip's content. Must be text */
|
|
1489
1489
|
content?: string;
|
|
1490
1490
|
/** The placement of tooltip relative to its target */
|
|
@@ -1508,11 +1508,11 @@ declare module "react" {
|
|
|
1508
1508
|
"sgds-accordion": SgdsAccordionProps;
|
|
1509
1509
|
"sgds-alert-link": SgdsAlertLinkProps;
|
|
1510
1510
|
"sgds-alert": SgdsAlertProps;
|
|
1511
|
-
"sgds-
|
|
1511
|
+
"sgds-badge": SgdsBadgeProps;
|
|
1512
1512
|
"sgds-breadcrumb-item": SgdsBreadcrumbItemProps;
|
|
1513
1513
|
"sgds-breadcrumb": SgdsBreadcrumbProps;
|
|
1514
1514
|
"sgds-card": SgdsCardProps;
|
|
1515
|
-
"sgds-
|
|
1515
|
+
"sgds-button": SgdsButtonProps;
|
|
1516
1516
|
"sgds-checkbox-group": SgdsCheckboxGroupProps;
|
|
1517
1517
|
"sgds-checkbox": SgdsCheckboxProps;
|
|
1518
1518
|
"sgds-close-button": SgdsCloseButtonProps;
|
|
@@ -1591,11 +1591,11 @@ declare global {
|
|
|
1591
1591
|
"sgds-accordion": HTMLElement;
|
|
1592
1592
|
"sgds-alert-link": HTMLElement;
|
|
1593
1593
|
"sgds-alert": HTMLElement;
|
|
1594
|
-
"sgds-
|
|
1594
|
+
"sgds-badge": HTMLElement;
|
|
1595
1595
|
"sgds-breadcrumb-item": HTMLElement;
|
|
1596
1596
|
"sgds-breadcrumb": HTMLElement;
|
|
1597
1597
|
"sgds-card": HTMLElement;
|
|
1598
|
-
"sgds-
|
|
1598
|
+
"sgds-button": HTMLElement;
|
|
1599
1599
|
"sgds-checkbox-group": HTMLElement;
|
|
1600
1600
|
"sgds-checkbox": HTMLElement;
|
|
1601
1601
|
"sgds-close-button": HTMLElement;
|