@czi-sds/components 24.2.1 → 25.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/dist/index.cjs.d.ts +153 -65
- package/dist/index.cjs.js +665 -484
- package/dist/index.esm.d.ts +153 -65
- package/dist/index.esm.js +661 -486
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -14,20 +14,27 @@ Peer dependencies:
|
|
|
14
14
|
@emotion/styled
|
|
15
15
|
@mui/icons-material
|
|
16
16
|
@mui/material
|
|
17
|
+
@phosphor-icons/react
|
|
17
18
|
react
|
|
18
19
|
react-dom
|
|
19
20
|
```
|
|
20
21
|
|
|
21
22
|
```bash
|
|
22
23
|
# npm
|
|
23
|
-
npm i @czi-sds/components @emotion/css @emotion/react @emotion/styled @mui/material @mui/icons-material react react-dom
|
|
24
|
+
npm i @czi-sds/components @emotion/css @emotion/react @emotion/styled @mui/material @mui/icons-material @phosphor-icons/react react react-dom
|
|
24
25
|
|
|
25
26
|
# yarn
|
|
26
|
-
yarn add @czi-sds/components @emotion/css @emotion/react @emotion/styled @mui/material @mui/icons-material react react-dom
|
|
27
|
+
yarn add @czi-sds/components @emotion/css @emotion/react @emotion/styled @mui/material @mui/icons-material @phosphor-icons/react react react-dom
|
|
27
28
|
```
|
|
28
29
|
|
|
29
30
|
> **React 18 note:** Material UI ships `react-is@19`. If your app uses React 18, pin `react-is` to match (Yarn `resolutions` / npm `overrides`), e.g. `"react-is": "^18.3.1"`.
|
|
30
31
|
|
|
32
|
+
## Migrating to SDS 25.0.0
|
|
33
|
+
|
|
34
|
+
SDS `25.0.0` is a **breaking release** that reworks `Tag`, ships the reworked filter chip as `Chip` (replacing the long-deprecated old `Chip`), and adds `@phosphor-icons/react` as a peer dependency. The previous Tag ships as the deprecated `TagLegacy`, and `TagFilter` is deprecated but unchanged:
|
|
35
|
+
|
|
36
|
+
→ [Migration guide](https://github.com/chanzuckerberg/sci-components/blob/main/migration-docs/migrate-to-25.0.0.md)
|
|
37
|
+
|
|
31
38
|
## Migrating to SDS 24.0.0
|
|
32
39
|
|
|
33
40
|
SDS `24.0.0` is a **breaking release** that moves the Material UI peer dependency from v5 to v9. Follow the step-by-step guide to upgrade the SDS version:
|
package/dist/index.cjs.d.ts
CHANGED
|
@@ -544,7 +544,7 @@ declare const getBreakpoints: ({
|
|
|
544
544
|
declare function focusVisibleA11yStyle(props: CommonThemeProps): string;
|
|
545
545
|
//#endregion
|
|
546
546
|
//#region src/core/styles/common/mixins/fonts.d.ts
|
|
547
|
-
declare const fontBody: <W extends "
|
|
547
|
+
declare const fontBody: <W extends "regular" | "medium" | "semibold">(fontSize: keyof {
|
|
548
548
|
regular: {
|
|
549
549
|
l: import("@mui/material").CSSProperties;
|
|
550
550
|
m: import("@mui/material").CSSProperties;
|
|
@@ -624,7 +624,7 @@ declare const fontHeaderS: (props: CommonThemeProps) => SerializedStyles | null;
|
|
|
624
624
|
declare const fontHeaderXs: (props: CommonThemeProps) => SerializedStyles | null;
|
|
625
625
|
declare const fontHeaderXxs: (props: CommonThemeProps) => SerializedStyles | null;
|
|
626
626
|
declare const fontHeaderXxxs: (props: CommonThemeProps) => SerializedStyles | null;
|
|
627
|
-
declare const fontCode: <W extends "
|
|
627
|
+
declare const fontCode: <W extends "regular" | "medium" | "semibold">(fontSize: keyof {
|
|
628
628
|
regular: {
|
|
629
629
|
s: import("@mui/material").CSSProperties;
|
|
630
630
|
xs: import("@mui/material").CSSProperties;
|
|
@@ -644,7 +644,7 @@ declare const fontCodeMediumXs: (props: CommonThemeProps) => SerializedStyles |
|
|
|
644
644
|
declare const fontCodeMediumS: (props: CommonThemeProps) => SerializedStyles | null;
|
|
645
645
|
declare const fontCodeSemiboldXs: (props: CommonThemeProps) => SerializedStyles | null;
|
|
646
646
|
declare const fontCodeSemiboldS: (props: CommonThemeProps) => SerializedStyles | null;
|
|
647
|
-
declare const fontTabular: <W extends "
|
|
647
|
+
declare const fontTabular: <W extends "regular" | "medium" | "semibold">(fontSize: keyof {
|
|
648
648
|
regular: {
|
|
649
649
|
s: import("@mui/material").CSSProperties;
|
|
650
650
|
xs: import("@mui/material").CSSProperties;
|
|
@@ -692,7 +692,7 @@ declare const fontTitle: <W extends "bold">(fontSize: keyof {
|
|
|
692
692
|
declare const fontTitleBoldS: (props: CommonThemeProps) => SerializedStyles | null;
|
|
693
693
|
declare const fontTitleBoldM: (props: CommonThemeProps) => SerializedStyles | null;
|
|
694
694
|
declare const fontTitleBoldL: (props: CommonThemeProps) => SerializedStyles | null;
|
|
695
|
-
declare const fontLink: <W extends "
|
|
695
|
+
declare const fontLink: <W extends "regular" | "medium" | "semibold">(fontSize: keyof {
|
|
696
696
|
regular: {
|
|
697
697
|
l: import("@mui/material").CSSProperties;
|
|
698
698
|
m: import("@mui/material").CSSProperties;
|
|
@@ -972,7 +972,7 @@ type InputSearchProps = TextFieldProps & AccessibleInputSearchProps & InputSearc
|
|
|
972
972
|
/**
|
|
973
973
|
* @see https://mui.com/material-ui/react-text-field/
|
|
974
974
|
*/
|
|
975
|
-
declare const InputSearch: React$1.ForwardRefExoticComponent<(Omit<import("@mui/material").
|
|
975
|
+
declare const InputSearch: React$1.ForwardRefExoticComponent<(Omit<import("@mui/material").OutlinedTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps, "ref"> | Omit<import("@mui/material").StandardTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps, "ref"> | Omit<import("@mui/material").FilledTextFieldProps & AccessibleInputSearchProps & InputSearchExtraProps, "ref">) & React$1.RefAttributes<HTMLDivElement>>;
|
|
976
976
|
//#endregion
|
|
977
977
|
//#region src/core/MenuItem/index.d.ts
|
|
978
978
|
type ModifiedIconNameToSizes = { [K in keyof IconNameToSizes]: IconNameToSizes[K] extends "xs" | "s" | "l" | "xl" ? IconNameToSizes[K] extends "l" | "xl" ? "l" | "xl" : "xs" | "s" : IconNameToSizes[K] };
|
|
@@ -1006,7 +1006,7 @@ interface StyleProps$3 extends CommonThemeProps {
|
|
|
1006
1006
|
}
|
|
1007
1007
|
declare const StyledPaper: import("@emotion/styled").StyledComponent<import("@mui/material").PaperOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
|
|
1008
1008
|
ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
|
|
1009
|
-
}, "
|
|
1009
|
+
}, "children" | "style" | "className" | "classes" | "sx" | "variant" | "elevation" | "square"> & {
|
|
1010
1010
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1011
1011
|
} & CommonThemeProps, {}, {}>;
|
|
1012
1012
|
//#endregion
|
|
@@ -1305,7 +1305,7 @@ declare const ButtonDropdownLegacy: React$1.ForwardRefExoticComponent<(Omit<SdsI
|
|
|
1305
1305
|
}, "ref"> | Omit<SdsButtonLegacyProps & {
|
|
1306
1306
|
sdsStyle: "rounded" | "square";
|
|
1307
1307
|
sdsType?: "primary" | "secondary" | "destructive" | undefined;
|
|
1308
|
-
icon?:
|
|
1308
|
+
icon?: React$1.ReactElement<CustomSVGProps, string | React$1.JSXElementConstructor<any>> | keyof IconNameToSizes | undefined;
|
|
1309
1309
|
sdsIconProps?: Partial<IconProps<keyof IconNameToSizes>> | undefined;
|
|
1310
1310
|
sdsSize?: ButtonLegacySize | undefined;
|
|
1311
1311
|
}, "ref">) & React$1.RefAttributes<HTMLButtonElement>>;
|
|
@@ -1494,23 +1494,100 @@ interface CellHeaderRawProps extends Omit<React$1.HTMLProps<HTMLDivElement>, "as
|
|
|
1494
1494
|
type CellHeaderProps = CellHeaderRawProps & CellHeaderExtraProps & CellHeaderContentProps;
|
|
1495
1495
|
declare const CellHeader: React$1.ForwardRefExoticComponent<Omit<CellHeaderProps, "ref"> & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
1496
1496
|
//#endregion
|
|
1497
|
-
//#region src/core/
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1497
|
+
//#region src/core/Tag/style.d.ts
|
|
1498
|
+
type SdsTagIntent = "accent" | "beta" | "info" | "negative" | "neutral" | "notice" | "positive";
|
|
1499
|
+
type SdsTagColorType = SdsTagIntent | [string, string] | [string, string, string];
|
|
1500
|
+
type SdsTagStyle = "solid" | "outline";
|
|
1501
|
+
type SdsTagSize = "small" | "medium";
|
|
1502
|
+
declare const TAG_LABEL_TEXT_CLASS = "SdsTag-labelText";
|
|
1503
|
+
declare const TAG_LINK_ICON_CLASS = "SdsTag-linkIcon";
|
|
1504
|
+
//#endregion
|
|
1505
|
+
//#region src/core/Tag/index.d.ts
|
|
1506
|
+
interface SdsTagProps extends Omit<ChipProps$1, "color" | "label" | "size" | "variant"> {
|
|
1507
|
+
/**
|
|
1508
|
+
* The tag's text, and its accessible name. It is cut off with an ellipsis
|
|
1509
|
+
* rather than wrapped, so keep it to a word or two. An icon-only tag still
|
|
1510
|
+
* needs it: the text is hidden from view but read by screen readers.
|
|
1511
|
+
*/
|
|
1512
|
+
label: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* `solid` fills the tag with the intent color. `outline` tints the fill and
|
|
1515
|
+
* draws the label, the icons and a 1px border in the intent color.
|
|
1516
|
+
*/
|
|
1517
|
+
sdsStyle?: SdsTagStyle;
|
|
1518
|
+
/**
|
|
1519
|
+
* `medium` is 24px tall with a 13px label and 12px icons, `small` is 20px
|
|
1520
|
+
* tall with a 10px label and 10px icons.
|
|
1521
|
+
*/
|
|
1522
|
+
size?: SdsTagSize;
|
|
1523
|
+
/**
|
|
1524
|
+
* One of the seven intents, or CSS colors for a tag the intents do not
|
|
1525
|
+
* cover: `[label, background]` or `[label, background, icon]`. The icon
|
|
1526
|
+
* takes the label color when the third value is left out.
|
|
1527
|
+
*/
|
|
1528
|
+
color?: SdsTagColorType;
|
|
1529
|
+
/**
|
|
1530
|
+
* An icon on the leading edge, usually a Phosphor or `@czi-sds/icons` icon.
|
|
1531
|
+
* The tag draws it at its own icon size and color.
|
|
1532
|
+
*/
|
|
1533
|
+
icon?: ReactElement;
|
|
1534
|
+
/**
|
|
1535
|
+
* Draws only the icon, in a square tag. The label is hidden from view but
|
|
1536
|
+
* stays the tag's accessible name. Has no effect without an icon.
|
|
1537
|
+
*/
|
|
1538
|
+
iconOnly?: boolean;
|
|
1539
|
+
/**
|
|
1540
|
+
* Adds an arrow after the label to say the tag leads somewhere. Usually
|
|
1541
|
+
* paired with `href`, though a tag can be a link without it.
|
|
1542
|
+
*/
|
|
1543
|
+
showLinkIcon?: boolean;
|
|
1544
|
+
/**
|
|
1545
|
+
* Turns the tag into a link. It renders as an `<a>` unless `component`
|
|
1546
|
+
* says otherwise, as with a router's link component.
|
|
1547
|
+
*/
|
|
1548
|
+
href?: string;
|
|
1549
|
+
/** Where the link opens. `_blank` also sets `rel="noopener noreferrer"`. */
|
|
1550
|
+
target?: HTMLAttributeAnchorTarget;
|
|
1551
|
+
/** The link's relationship to the current page. */
|
|
1552
|
+
rel?: string;
|
|
1553
|
+
/**
|
|
1554
|
+
* Greys the tag out. On a clickable tag or a link it also takes the tag out
|
|
1555
|
+
* of the tab order.
|
|
1556
|
+
*/
|
|
1557
|
+
disabled?: boolean;
|
|
1502
1558
|
}
|
|
1559
|
+
type TagProps = SdsTagProps;
|
|
1560
|
+
/**
|
|
1561
|
+
* @see https://mui.com/material-ui/react-chip/
|
|
1562
|
+
*/
|
|
1563
|
+
declare const Tag: import("react").ForwardRefExoticComponent<Omit<SdsTagProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
|
|
1503
1564
|
//#endregion
|
|
1504
1565
|
//#region src/core/Chip/index.d.ts
|
|
1505
|
-
|
|
1566
|
+
interface SdsChipProps extends Omit<TagProps, "color" | "href" | "iconOnly" | "rel" | "showLinkIcon" | "size" | "target"> {
|
|
1567
|
+
/** The filter's text. Cut off with an ellipsis when there is not room for it. */
|
|
1568
|
+
label: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Runs when the chip is clicked or activated with Enter or Space, and when
|
|
1571
|
+
* Backspace or Delete is pressed on it. Drop the filter from your state
|
|
1572
|
+
* here; the component does not remove itself.
|
|
1573
|
+
*/
|
|
1574
|
+
onDelete: React$1.EventHandler<any>;
|
|
1575
|
+
/**
|
|
1576
|
+
* `solid` fills the chip with the accent color. `outline` tints it and
|
|
1577
|
+
* draws the label, the X and a 1px border in the accent color.
|
|
1578
|
+
*/
|
|
1579
|
+
sdsStyle?: TagProps["sdsStyle"];
|
|
1580
|
+
/**
|
|
1581
|
+
* The chip's accessible name, "Remove" followed by the label unless set.
|
|
1582
|
+
* Override it to word the removal differently.
|
|
1583
|
+
*/
|
|
1584
|
+
"aria-label"?: string;
|
|
1585
|
+
}
|
|
1586
|
+
type ChipProps = SdsChipProps;
|
|
1506
1587
|
/**
|
|
1507
1588
|
* @see https://mui.com/material-ui/react-chip/
|
|
1508
|
-
*
|
|
1509
|
-
* @deprecated
|
|
1510
|
-
* This component is deprecated and will be removed in the next major version.
|
|
1511
|
-
* Please use `Tag` or `TagFilter` instead.
|
|
1512
1589
|
*/
|
|
1513
|
-
declare const Chip:
|
|
1590
|
+
declare const Chip: React$1.ForwardRefExoticComponent<Omit<SdsChipProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
|
|
1514
1591
|
//#endregion
|
|
1515
1592
|
//#region src/core/DropdownMenu/style.d.ts
|
|
1516
1593
|
interface StyleProps$1 extends CommonThemeProps {
|
|
@@ -1526,7 +1603,7 @@ declare const StyledPopper$1: import("@emotion/styled").StyledComponent<import("
|
|
|
1526
1603
|
} & CommonThemeProps, {}, {}>;
|
|
1527
1604
|
declare const StyledPaper$1: import("@emotion/styled").StyledComponent<import("@mui/material").PaperOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
|
|
1528
1605
|
ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
|
|
1529
|
-
}, "
|
|
1606
|
+
}, "children" | "style" | "className" | "classes" | "sx" | "variant" | "elevation" | "square"> & {
|
|
1530
1607
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1531
1608
|
} & StyleProps$1, {}, {}>;
|
|
1532
1609
|
//#endregion
|
|
@@ -1724,7 +1801,7 @@ type ContentCardProps = ImageContentCardProps | IconContentCardProps | NoneConte
|
|
|
1724
1801
|
type CardExtraProps = Partial<ContentCardProps> & CommonThemeProps;
|
|
1725
1802
|
declare const StyledContentCardBody: import("@emotion/styled").StyledComponent<import("@mui/material").CardContentOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
|
|
1726
1803
|
ref?: ((instance: HTMLDivElement | null) => void) | import("react").RefObject<HTMLDivElement> | null | undefined;
|
|
1727
|
-
}, "
|
|
1804
|
+
}, "children" | "style" | "className" | "classes" | "sx"> & {
|
|
1728
1805
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1729
1806
|
} & CardExtraProps, {}, {}>;
|
|
1730
1807
|
//#endregion
|
|
@@ -1822,17 +1899,17 @@ interface DialogTitleExtraProps extends CommonThemeProps {
|
|
|
1822
1899
|
}
|
|
1823
1900
|
declare const Title: import("@emotion/styled").StyledComponent<import("@mui/material").TypographyOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
|
|
1824
1901
|
ref?: ((instance: HTMLSpanElement | null) => void) | import("react").RefObject<HTMLSpanElement> | null | undefined;
|
|
1825
|
-
}, "
|
|
1902
|
+
}, "children" | "style" | "className" | "color" | "classes" | "sx" | "variant" | "align" | "gutterBottom" | "noWrap" | "variantMapping"> & {
|
|
1826
1903
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1827
1904
|
} & DialogTitleExtraProps, {}, {}>;
|
|
1828
1905
|
declare const Subtitle: import("@emotion/styled").StyledComponent<import("@mui/material").TypographyOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
|
|
1829
1906
|
ref?: ((instance: HTMLSpanElement | null) => void) | import("react").RefObject<HTMLSpanElement> | null | undefined;
|
|
1830
|
-
}, "
|
|
1907
|
+
}, "children" | "style" | "className" | "color" | "classes" | "sx" | "variant" | "align" | "gutterBottom" | "noWrap" | "variantMapping"> & {
|
|
1831
1908
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1832
1909
|
} & DialogTitleExtraProps, {}, {}>;
|
|
1833
1910
|
declare const Overline: import("@emotion/styled").StyledComponent<import("@mui/material").TypographyOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
|
|
1834
1911
|
ref?: ((instance: HTMLSpanElement | null) => void) | import("react").RefObject<HTMLSpanElement> | null | undefined;
|
|
1835
|
-
}, "
|
|
1912
|
+
}, "children" | "style" | "className" | "color" | "classes" | "sx" | "variant" | "align" | "gutterBottom" | "noWrap" | "variantMapping"> & {
|
|
1836
1913
|
theme?: import("@emotion/react").Theme | undefined;
|
|
1837
1914
|
} & DialogTitleExtraProps, {}, {}>;
|
|
1838
1915
|
//#endregion
|
|
@@ -2000,7 +2077,7 @@ type InputTextProps = TextFieldProps & InputTextExtraProps & AccessibleInputText
|
|
|
2000
2077
|
/**
|
|
2001
2078
|
* @see https://mui.com/material-ui/react-text-field/
|
|
2002
2079
|
*/
|
|
2003
|
-
declare const InputText: import("react").ForwardRefExoticComponent<(Omit<import("@mui/material").
|
|
2080
|
+
declare const InputText: import("react").ForwardRefExoticComponent<(Omit<import("@mui/material").OutlinedTextFieldProps & InputTextExtraProps & AccessibleInputTextProps, "ref"> | Omit<import("@mui/material").StandardTextFieldProps & InputTextExtraProps & AccessibleInputTextProps, "ref"> | Omit<import("@mui/material").FilledTextFieldProps & InputTextExtraProps & AccessibleInputTextProps, "ref">) & import("react").RefAttributes<HTMLInputElement>>;
|
|
2004
2081
|
//#endregion
|
|
2005
2082
|
//#region src/core/InputToggle/style.d.ts
|
|
2006
2083
|
interface InputToggleExtraProps extends SwitchProps, CommonThemeProps {
|
|
@@ -2110,6 +2187,13 @@ interface LegendProps extends HTMLAttributes<HTMLDivElement> {
|
|
|
2110
2187
|
* external highlight.
|
|
2111
2188
|
*/
|
|
2112
2189
|
hoveredIndex?: number | null;
|
|
2190
|
+
/**
|
|
2191
|
+
* Items in popover that appears when last item is clicked. This can be used for
|
|
2192
|
+
* displaying "remaining" items that are not rendered in main legend.
|
|
2193
|
+
*
|
|
2194
|
+
* Empty means no popover is created.
|
|
2195
|
+
*/
|
|
2196
|
+
lastItemMenuItems?: LegendItemData[];
|
|
2113
2197
|
}
|
|
2114
2198
|
//#endregion
|
|
2115
2199
|
//#region src/core/Legend/index.d.ts
|
|
@@ -2211,45 +2295,6 @@ type MenuSelectProps<T, Multiple extends boolean | undefined = undefined, Disabl
|
|
|
2211
2295
|
*/
|
|
2212
2296
|
declare const MenuSelect: <T extends DefaultMenuSelectOption, Multiple extends boolean | undefined = undefined, DisableClearable extends boolean | undefined = undefined, FreeSolo extends boolean | undefined = undefined>(props: MenuSelectProps<T, Multiple, DisableClearable, FreeSolo>) => JSX.Element;
|
|
2213
2297
|
//#endregion
|
|
2214
|
-
//#region src/core/Tag/style.d.ts
|
|
2215
|
-
type SdsTagColorType = "info" | "positive" | "notice" | "negative" | "neutral" | "beta" | [string, string] | [string, string, string];
|
|
2216
|
-
interface ExtraSmallTagProps extends CommonThemeProps {
|
|
2217
|
-
hover?: boolean;
|
|
2218
|
-
sdsType?: "primary" | "secondary";
|
|
2219
|
-
sdsStyle?: "square" | "rounded";
|
|
2220
|
-
sdsSize?: "s";
|
|
2221
|
-
tagColor?: SdsTagColorType;
|
|
2222
|
-
icon?: JSX.Element;
|
|
2223
|
-
}
|
|
2224
|
-
interface ExtraLargeTagProps extends CommonThemeProps {
|
|
2225
|
-
hover?: boolean;
|
|
2226
|
-
sdsType?: "primary" | "secondary";
|
|
2227
|
-
sdsStyle?: "square" | "rounded";
|
|
2228
|
-
sdsSize?: "l";
|
|
2229
|
-
tagColor?: SdsTagColorType;
|
|
2230
|
-
icon: JSX.Element;
|
|
2231
|
-
}
|
|
2232
|
-
type ExtraTagProps = ExtraSmallTagProps | ExtraLargeTagProps;
|
|
2233
|
-
//#endregion
|
|
2234
|
-
//#region src/core/Tag/index.d.ts
|
|
2235
|
-
interface SdsTagProps extends Omit<ChipProps$1, "color"> {
|
|
2236
|
-
/**
|
|
2237
|
-
* The tag's text, and its accessible name. It is cut off with an ellipsis
|
|
2238
|
-
* rather than wrapped, so keep it to a word or two.
|
|
2239
|
-
*/
|
|
2240
|
-
label: string;
|
|
2241
|
-
color?: SdsTagColorType;
|
|
2242
|
-
}
|
|
2243
|
-
type TagProps = SdsTagProps & ExtraTagProps;
|
|
2244
|
-
/**
|
|
2245
|
-
* @see https://mui.com/material-ui/react-chip/
|
|
2246
|
-
*
|
|
2247
|
-
* @props color: {string} - applies color for tag based on default theme color values
|
|
2248
|
-
* [string, string] - applies custom colors for [font, background]
|
|
2249
|
-
* [string, string, string] - applies custom colors for [font, background, icon]
|
|
2250
|
-
*/
|
|
2251
|
-
declare const Tag: (props: TagProps) => JSX.Element;
|
|
2252
|
-
//#endregion
|
|
2253
2298
|
//#region src/core/NavigationFooter/NavigationFooter.types.d.ts
|
|
2254
2299
|
interface NavigationFooterNavItem {
|
|
2255
2300
|
label: string;
|
|
@@ -2273,7 +2318,7 @@ interface NavigationFooterProps {
|
|
|
2273
2318
|
navItems?: NavigationFooterNavItem[];
|
|
2274
2319
|
navLinks?: NavigationFooterNavItem[];
|
|
2275
2320
|
tag?: string;
|
|
2276
|
-
tagColor?:
|
|
2321
|
+
tagColor?: SdsTagColorType;
|
|
2277
2322
|
title?: string;
|
|
2278
2323
|
}
|
|
2279
2324
|
interface NavItemProps {
|
|
@@ -2701,9 +2746,52 @@ interface SdsTagFilterProps extends Omit<ChipProps$1, "color" | "variant"> {
|
|
|
2701
2746
|
type TagFilterProps = SdsTagFilterProps;
|
|
2702
2747
|
/**
|
|
2703
2748
|
* @see https://mui.com/material-ui/react-chip/
|
|
2749
|
+
*
|
|
2750
|
+
* @deprecated Use Chip instead. TagFilter will be removed in a future release.
|
|
2704
2751
|
*/
|
|
2705
2752
|
declare const TagFilter: (props: SdsTagFilterProps) => JSX.Element;
|
|
2706
2753
|
//#endregion
|
|
2754
|
+
//#region src/core/TagLegacy/style.d.ts
|
|
2755
|
+
type SdsTagLegacyColorType = "info" | "positive" | "notice" | "negative" | "neutral" | "beta" | [string, string] | [string, string, string];
|
|
2756
|
+
interface ExtraSmallTagLegacyProps extends CommonThemeProps {
|
|
2757
|
+
hover?: boolean;
|
|
2758
|
+
sdsType?: "primary" | "secondary";
|
|
2759
|
+
sdsStyle?: "square" | "rounded";
|
|
2760
|
+
sdsSize?: "s";
|
|
2761
|
+
tagColor?: SdsTagLegacyColorType;
|
|
2762
|
+
icon?: JSX.Element;
|
|
2763
|
+
}
|
|
2764
|
+
interface ExtraLargeTagLegacyProps extends CommonThemeProps {
|
|
2765
|
+
hover?: boolean;
|
|
2766
|
+
sdsType?: "primary" | "secondary";
|
|
2767
|
+
sdsStyle?: "square" | "rounded";
|
|
2768
|
+
sdsSize?: "l";
|
|
2769
|
+
tagColor?: SdsTagLegacyColorType;
|
|
2770
|
+
icon: JSX.Element;
|
|
2771
|
+
}
|
|
2772
|
+
type ExtraTagLegacyProps = ExtraSmallTagLegacyProps | ExtraLargeTagLegacyProps;
|
|
2773
|
+
//#endregion
|
|
2774
|
+
//#region src/core/TagLegacy/index.d.ts
|
|
2775
|
+
interface SdsTagLegacyProps extends Omit<ChipProps$1, "color"> {
|
|
2776
|
+
/**
|
|
2777
|
+
* The tag's text, and its accessible name. It is cut off with an ellipsis
|
|
2778
|
+
* rather than wrapped, so keep it to a word or two.
|
|
2779
|
+
*/
|
|
2780
|
+
label: string;
|
|
2781
|
+
color?: SdsTagLegacyColorType;
|
|
2782
|
+
}
|
|
2783
|
+
type TagLegacyProps = SdsTagLegacyProps & ExtraTagLegacyProps;
|
|
2784
|
+
/**
|
|
2785
|
+
* @see https://mui.com/material-ui/react-chip/
|
|
2786
|
+
*
|
|
2787
|
+
* @deprecated Use Tag instead. TagLegacy will be removed in a future release.
|
|
2788
|
+
*
|
|
2789
|
+
* @props color: {string} - applies color for tag based on default theme color values
|
|
2790
|
+
* [string, string] - applies custom colors for [font, background]
|
|
2791
|
+
* [string, string, string] - applies custom colors for [font, background, icon]
|
|
2792
|
+
*/
|
|
2793
|
+
declare const TagLegacy: (props: TagLegacyProps) => JSX.Element;
|
|
2794
|
+
//#endregion
|
|
2707
2795
|
//#region src/core/TooltipCondensed/style.d.ts
|
|
2708
2796
|
interface TooltipCondensedExtraProps extends CommonThemeProps {
|
|
2709
2797
|
indicator?: boolean;
|
|
@@ -2784,4 +2872,4 @@ interface DiscreteColorGeneratorOptions {
|
|
|
2784
2872
|
*/
|
|
2785
2873
|
declare const generateDiscreteColors: (count: number, options?: DiscreteColorGeneratorOptions) => string[];
|
|
2786
2874
|
//#endregion
|
|
2787
|
-
export { AccentColor, AccessibleInputSearchProps, Accordion, AccordionDetails, AccordionHeader, AccordionProps, Alert, AppTheme, Autocomplete, type AutocompleteBaseProps, AutocompleteMultiColumnOnChange, AutocompleteMultiColumnOption, type AutocompleteMultiColumnProps, StyledPopper as AutocompleteMultiColumnStyledPopper, AutocompleteMultiColumnValue, type AutocompleteOptionBasic, type AutocompleteOptionComponent, AutocompleteProps, AutocompleteSingleColumnOnChange, AutocompleteSingleColumnOption, StyledPaper as AutocompleteSingleColumnStyledPaper, AutocompleteSingleColumnValue, Banner, BannerIntentType, BannerProps, BaseColor, type BasicPanelProps, Border, Borders, Button, ButtonDropdown, ButtonDropdownLegacy, ButtonDropdownLegacyProps, type ButtonDropdownProps, ButtonGroup, type ButtonGroupProps, ButtonIcon, ButtonIconInternalProps, ButtonIconProps, ButtonLegacy, ButtonLegacyProps, ButtonLegacySize, ButtonLegacyType, ButtonLegacyTypeMap, type ButtonProps, ButtonToggle, ButtonToggleLegacy, ButtonToggleLegacyProps, type ButtonToggleProps, Callout, CalloutIntentType, CalloutProps, CalloutSdsStyleType, CalloutTitle, CellBasic, CellBasicProps, CellBasicRawProps, CellComponent, CellComponentProps, CellHeader, CellHeaderDirection, CellHeaderProps, CheckboxContentProps, CheckboxProps, Chip,
|
|
2875
|
+
export { AccentColor, AccessibleInputSearchProps, Accordion, AccordionDetails, AccordionHeader, AccordionProps, Alert, AppTheme, Autocomplete, type AutocompleteBaseProps, AutocompleteMultiColumnOnChange, AutocompleteMultiColumnOption, type AutocompleteMultiColumnProps, StyledPopper as AutocompleteMultiColumnStyledPopper, AutocompleteMultiColumnValue, type AutocompleteOptionBasic, type AutocompleteOptionComponent, AutocompleteProps, AutocompleteSingleColumnOnChange, AutocompleteSingleColumnOption, StyledPaper as AutocompleteSingleColumnStyledPaper, AutocompleteSingleColumnValue, Banner, BannerIntentType, BannerProps, BaseColor, type BasicPanelProps, Border, Borders, Button, ButtonDropdown, ButtonDropdownLegacy, ButtonDropdownLegacyProps, type ButtonDropdownProps, ButtonGroup, type ButtonGroupProps, ButtonIcon, ButtonIconInternalProps, ButtonIconProps, ButtonLegacy, ButtonLegacyProps, ButtonLegacySize, ButtonLegacyType, ButtonLegacyTypeMap, type ButtonProps, ButtonToggle, ButtonToggleLegacy, ButtonToggleLegacyProps, type ButtonToggleProps, Callout, CalloutIntentType, CalloutProps, CalloutSdsStyleType, CalloutTitle, CellBasic, CellBasicProps, CellBasicRawProps, CellComponent, CellComponentProps, CellHeader, CellHeaderDirection, CellHeaderProps, CheckboxContentProps, CheckboxProps, Chip, ChipProps, Color, Colors, CommonThemeProps, ComplexFilter, InputDropdown as ComplexFilterInputDropdown, InputDropdown as DropdownInputDropdown, InputDropdown, StyledPopper$1 as ComplexFilterPopper, StyledPopper$1 as DropdownPopper, ComplexFilterProps, ContentCard, ContentCardActions, type ContentCardActionsProps, StyledContentCardBody as ContentCardBody, CardMedia as ContentCardMedia, type CardMediaProps as ContentCardMediaProps, StyledMetadataText as ContentCardMetadata, StyledOverlineText as ContentCardOverline, type ContentCardProps, StyledSubtitleText as ContentCardSubtitle, StyledTitleText as ContentCardTitle, type ContentCardTitleProps, Corners, type DefaultAutocompleteOption, DefaultDropdownMenuOption, DefaultMenuSelectOption, Dialog, DialogActions, DialogActionsProps, _default as DialogContent, DialogContentProps, DialogExtraProps, DialogPaper, DialogPaperProps, DialogProps, DialogTitle, Overline as DialogTitleOverline, DialogTitleProps, Subtitle as DialogTitleSubtitle, Title as DialogTitleTitle, DiscreteColorGeneratorOptions, Dropdown, DropdownMenu, DropdownMenuProps, StyledPaper$1 as DropdownPaper, DropdownProps, ExposedCalloutProps, ExposedNotificationProps, ExtraDropdownProps, FontWeights, FooterImage, FooterLinkProps, Hero, type HeroProps, Icon, type IconButtonProps, type IconNameToSizes, IconNameToSmallSizes, IconProps, IconSize, IconSizes, InputCheckbox, InputDropdownProps$1 as InputDropdownProps, InputRadio, InputSearch, InputSearchProps, InputSlider, InputSliderProps, InputText, InputTextProps, InputToggle, type InputToggleExtraProps as InputToggleProps, IntentColor, IntentMessage, type IntentMessageItem, type IntentMessageProps, Legend, type LegendItemData, type LegendProps, Link, LinkProps, List, ListItem, ListItemLabel, ListItemProps, ListProps, ListSubheader, ListSubheaderProps, LoadingIndicator, LoadingIndicatorProps, MINIMUM_DROPDOWN_MENU_POPPER_WIDTH, Menu, MenuItem, MenuItemExtraProps, MenuItemProps, MenuProps, MenuSelect, MenuSelectProps, NavItemProps, NavigationFooter, NavigationFooterNavItem, NavigationFooterProps, NavigationHeader, type NavigationHeaderPrimaryNavItem, type NavigationHeaderPrimaryNavProps, type NavigationHeaderProps, type NavigationHeaderSecondaryNavItem, type NavigationHeaderSecondaryNavProps, NavigationJumpTo, NavigationJumpToProps, Notification, NotificationIntentType, NotificationProps, type OverlayPanelProps, Pagination, PaginationInternalProps, PaginationProps, Panel, type PanelProps, Popover, PopoverProps, PreComposedTable, PreComposedTableProps, PreComposedTableRef, RadioContentProps, RadioProps, RowHoverContext, SDSAutocompleteOnChange, SDSAutocompleteOptions, SDSAutocompleteValue, SDSChooseTheme, SDSDarkAppTheme, SDSDarkThemeColors, SDSLightAppTheme, SDSLightThemeColors, SDSPalette, SDSPaletteDark, SDSPaletteLight, SDSTheme, SDSThemeOptions, SdsButtonLegacyProps, SdsChipProps, SdsIconButtonLegacyProps, SdsIconWithColor, SdsLegacyProps, SdsMinimalButtonLegacyProps, SdsTableProps, type SdsTagColorType, SdsTagFilterProps, type SdsTagIntent, type SdsTagLegacyColorType, SdsTagLegacyProps, SdsTagProps, type SdsTagSize, type SdsTagStyle, SegmentedControl, SegmentedControlProps, Shadows, SingleButtonDefinition, Spaces, Spacings, TAG_LABEL_TEXT_CLASS, TAG_LINK_ICON_CLASS, Tab, TabProps, Table, TableHeader, TableHeaderProps, TableProps, TableRow, TableRowProps, Tabs, type TabsProps, Tag, TagFilter, TagFilterProps, TagLegacy, TagLegacyProps, TagProps, Theme, Tooltip, TooltipCondensed, TooltipCondensedProps, type TooltipProps, TooltipTableContent as TooltipTable, TooltipTableContent, type TooltipTableContentProps, Typography, TypographyStyles, defaultAppTheme, defaultTheme, focusVisibleA11yStyle, fontBody, fontBodyL, fontBodyM, fontBodyMediumL, fontBodyMediumM, fontBodyMediumS, fontBodyMediumXs, fontBodyMediumXxs, fontBodyMediumXxxs, fontBodyMediumXxxxs, fontBodyS, fontBodySemiboldL, fontBodySemiboldM, fontBodySemiboldS, fontBodySemiboldXs, fontBodySemiboldXxs, fontBodySemiboldXxxs, fontBodySemiboldXxxxs, fontBodyXs, fontBodyXxs, fontBodyXxxs, fontBodyXxxxs, fontCaps, fontCapsXxs, fontCapsXxxs, fontCapsXxxxs, fontCode, fontCodeMediumS, fontCodeMediumXs, fontCodeS, fontCodeSemiboldS, fontCodeSemiboldXs, fontCodeXs, fontHeader, fontHeaderL, fontHeaderM, fontHeaderS, fontHeaderXl, fontHeaderXs, fontHeaderXxl, fontHeaderXxs, fontHeaderXxxs, fontLink, fontLinkL, fontLinkM, fontLinkMediumL, fontLinkMediumM, fontLinkMediumS, fontLinkMediumXs, fontLinkMediumXxs, fontLinkMediumXxxs, fontLinkMediumXxxxs, fontLinkS, fontLinkSemiboldL, fontLinkSemiboldM, fontLinkSemiboldS, fontLinkSemiboldXs, fontLinkSemiboldXxs, fontLinkSemiboldXxxs, fontLinkSemiboldXxxxs, fontLinkXs, fontLinkXxs, fontLinkXxxs, fontLinkXxxxs, fontTabular, fontTabularMediumS, fontTabularMediumXs, fontTabularMediumXxs, fontTabularMediumXxxs, fontTabularMediumXxxxs, fontTabularS, fontTabularSemiboldS, fontTabularSemiboldXs, fontTabularSemiboldXxs, fontTabularSemiboldXxxs, fontTabularSemiboldXxxxs, fontTabularXs, fontTabularXxs, fontTabularXxxs, fontTabularXxxxs, fontTitle, fontTitleBoldL, fontTitleBoldM, fontTitleBoldS, generateDiscreteColors, getBorders, getBreakpoints, getColors, getCorners, getFontWeights, getIconSizes, getMode, getPalette, getSemanticColors, getShadows, getSpaces, getSpacings, getTypography, isIconOnlyButton, makeSdsSemanticAppTheme, makeThemeOptions };
|