@wistia/ui 0.3.2 → 0.4.0-beta.ebd58245.2c65ddd

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 CHANGED
@@ -54,6 +54,9 @@ type ColorSchemeWrapperProps = ComponentPropsWithoutRef<'div'> & {
54
54
  * @ignore For use in creating navs - will override any colorScheme prop
55
55
  */
56
56
  __nav?: boolean;
57
+ /**
58
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
59
+ */
57
60
  colorScheme?: ColorSchemeTypes;
58
61
  /**
59
62
  * Children
@@ -83,6 +86,9 @@ type BaseProps = {
83
86
  * @type ReactNode
84
87
  */
85
88
  children: ReactNode;
89
+ /**
90
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
91
+ */
86
92
  colorScheme?: ColorSchemeTypes;
87
93
  /**
88
94
  * Disables the link
@@ -135,6 +141,9 @@ type BaseButtonProps = {
135
141
  * @type ReactNode
136
142
  */
137
143
  children?: ReactNode;
144
+ /**
145
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
146
+ */
138
147
  colorScheme?: ColorSchemeTypes;
139
148
  /**
140
149
  * Disables the button
@@ -215,6 +224,9 @@ type ToastProps = ComponentPropsWithoutRef<'div'> & {
215
224
  * Action can be undefined (default dismiss button), a Button component or false to hide the dismiss button
216
225
  */
217
226
  action?: React.ReactElement<typeof Button> | undefined;
227
+ /**
228
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
229
+ */
218
230
  colorScheme?: ColorSchemeTypes | undefined;
219
231
  /**
220
232
  * Optional `Icon` component to use. Must be an instance of [Icon](/?path=/docs/components-icon--docs)
@@ -334,6 +346,9 @@ declare const Avatar: {
334
346
  };
335
347
 
336
348
  type BadgeProps = ComponentPropsWithoutRef<'div'> & {
349
+ /**
350
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
351
+ */
337
352
  colorScheme?: ColorSchemeTypes;
338
353
  /**
339
354
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -348,6 +363,9 @@ type BadgeProps = ComponentPropsWithoutRef<'div'> & {
348
363
  * A `Badge` is a compact label, with optional icon, to convey status or context.
349
364
  */
350
365
  declare const Badge: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
366
+ /**
367
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
368
+ */
351
369
  colorScheme?: ColorSchemeTypes;
352
370
  /**
353
371
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -762,6 +780,9 @@ type HeadingProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT> & {
762
780
  * The content of the heading
763
781
  */
764
782
  children: ReactNode;
783
+ /**
784
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
785
+ */
765
786
  colorScheme?: ColorSchemeTypes;
766
787
  /**
767
788
  * Styles to text as disabled
@@ -803,6 +824,9 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
803
824
  * The content of the heading
804
825
  */
805
826
  children: ReactNode;
827
+ /**
828
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
829
+ */
806
830
  colorScheme?: ColorSchemeTypes;
807
831
  /**
808
832
  * Styles to text as disabled
@@ -840,6 +864,9 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
840
864
  * The content of the heading
841
865
  */
842
866
  children: ReactNode;
867
+ /**
868
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
869
+ */
843
870
  colorScheme?: ColorSchemeTypes;
844
871
  /**
845
872
  * Styles to text as disabled
@@ -1033,6 +1060,9 @@ declare const iconSizeMap: {
1033
1060
  xxl: string;
1034
1061
  };
1035
1062
  type IconProps = ComponentPropsWithoutRef<'svg'> & {
1063
+ /**
1064
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1065
+ */
1036
1066
  colorScheme?: ColorSchemeTypes;
1037
1067
  /**
1038
1068
  * Is Icon on a filled background?
@@ -1400,11 +1430,6 @@ declare const variantStyleMap: {
1400
1430
  label3: styled_components.FlattenSimpleInterpolation;
1401
1431
  label4: styled_components.FlattenSimpleInterpolation;
1402
1432
  };
1403
- declare const prominenceMap: {
1404
- highContrast: styled_components.FlattenSimpleInterpolation;
1405
- vibrant: styled_components.FlattenSimpleInterpolation;
1406
- secondary: styled_components.FlattenSimpleInterpolation;
1407
- };
1408
1433
  type TextProps = ComponentPropsWithoutRef<'div'> & {
1409
1434
  /**
1410
1435
  * The horizontal alignment
@@ -1416,6 +1441,9 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1416
1441
  * The text content
1417
1442
  */
1418
1443
  children?: ReactNode | undefined;
1444
+ /**
1445
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1446
+ */
1419
1447
  colorScheme?: ColorSchemeTypes;
1420
1448
  /**
1421
1449
  * Allows user to override default button colors
@@ -1436,9 +1464,9 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1436
1464
  */
1437
1465
  preventUserSelect?: boolean;
1438
1466
  /**
1439
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1467
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1440
1468
  */
1441
- prominence?: keyof typeof prominenceMap;
1469
+ prominence?: 'button' | 'primary' | 'secondary';
1442
1470
  /**
1443
1471
  * This will inherit the jsdoc block from PolymorphicComponent
1444
1472
  */
@@ -1464,6 +1492,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1464
1492
  * The text content
1465
1493
  */
1466
1494
  children?: ReactNode | undefined;
1495
+ /**
1496
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1497
+ */
1467
1498
  colorScheme?: ColorSchemeTypes;
1468
1499
  /**
1469
1500
  * Allows user to override default button colors
@@ -1484,9 +1515,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1484
1515
  */
1485
1516
  preventUserSelect?: boolean;
1486
1517
  /**
1487
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1518
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1488
1519
  */
1489
- prominence?: keyof typeof prominenceMap;
1520
+ prominence?: "button" | "primary" | "secondary";
1490
1521
  /**
1491
1522
  * This will inherit the jsdoc block from PolymorphicComponent
1492
1523
  */
@@ -1508,6 +1539,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1508
1539
  * The text content
1509
1540
  */
1510
1541
  children?: ReactNode | undefined;
1542
+ /**
1543
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1544
+ */
1511
1545
  colorScheme?: ColorSchemeTypes;
1512
1546
  /**
1513
1547
  * Allows user to override default button colors
@@ -1528,9 +1562,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1528
1562
  */
1529
1563
  preventUserSelect?: boolean;
1530
1564
  /**
1531
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1565
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1532
1566
  */
1533
- prominence?: keyof typeof prominenceMap;
1567
+ prominence?: "button" | "primary" | "secondary";
1534
1568
  /**
1535
1569
  * This will inherit the jsdoc block from PolymorphicComponent
1536
1570
  */
@@ -1854,6 +1888,9 @@ declare const Stack: (<C = "div">(props: PolymorphicComponentProps<C, StackProps
1854
1888
  })>, never> & Record<string, never>;
1855
1889
 
1856
1890
  type TagProps = ComponentPropsWithoutRef<'div'> & {
1891
+ /**
1892
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1893
+ */
1857
1894
  colorScheme?: ColorSchemeTypes;
1858
1895
  /**
1859
1896
  * Valid URL for the `Tag` label to link to
@@ -1876,6 +1913,9 @@ type TagProps = ComponentPropsWithoutRef<'div'> & {
1876
1913
  * A `Tag` is an optionally linked label, with an optional action button, to categorize content.
1877
1914
  */
1878
1915
  declare const Tag: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
1916
+ /**
1917
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1918
+ */
1879
1919
  colorScheme?: ColorSchemeTypes;
1880
1920
  /**
1881
1921
  * Valid URL for the `Tag` label to link to
@@ -1974,4 +2014,34 @@ declare const WistiaLogo: {
1974
2014
  displayName: string;
1975
2015
  };
1976
2016
 
1977
- export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Button, ButtonGroup, type ButtonProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useFormState, useMq, useToast, useWindowSize };
2017
+ type BreadcrumbsProps = ComponentPropsWithoutRef<'div'> & {
2018
+ /**
2019
+ * Should be at least one `Breadcrumb` component
2020
+ */
2021
+ children: ReactNode;
2022
+ };
2023
+ /**
2024
+ * Used to display a screens's location within a hierarchical structure
2025
+ */
2026
+ declare const Breadcrumbs: {
2027
+ ({ children, ...props }: BreadcrumbsProps): JSX.Element;
2028
+ displayName: string;
2029
+ };
2030
+
2031
+ type BreadcrumbProps = {
2032
+ /**
2033
+ * An [Icon](../?path=/docs/components-icon--docs) to show at the beginning of the breadcrumb
2034
+ * */
2035
+ icon?: ButtonAsLinkProps['leftIcon'];
2036
+ /**
2037
+ * The text of the breadcrumb link
2038
+ */
2039
+ children: ReactNode;
2040
+ /**
2041
+ * The link to the page of the breadcrumb
2042
+ */
2043
+ href: string;
2044
+ };
2045
+ declare const Breadcrumb: ({ icon, href, children }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
2046
+
2047
+ export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useFormState, useMq, useToast, useWindowSize };
package/dist/index.d.ts CHANGED
@@ -54,6 +54,9 @@ type ColorSchemeWrapperProps = ComponentPropsWithoutRef<'div'> & {
54
54
  * @ignore For use in creating navs - will override any colorScheme prop
55
55
  */
56
56
  __nav?: boolean;
57
+ /**
58
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
59
+ */
57
60
  colorScheme?: ColorSchemeTypes;
58
61
  /**
59
62
  * Children
@@ -83,6 +86,9 @@ type BaseProps = {
83
86
  * @type ReactNode
84
87
  */
85
88
  children: ReactNode;
89
+ /**
90
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
91
+ */
86
92
  colorScheme?: ColorSchemeTypes;
87
93
  /**
88
94
  * Disables the link
@@ -135,6 +141,9 @@ type BaseButtonProps = {
135
141
  * @type ReactNode
136
142
  */
137
143
  children?: ReactNode;
144
+ /**
145
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
146
+ */
138
147
  colorScheme?: ColorSchemeTypes;
139
148
  /**
140
149
  * Disables the button
@@ -215,6 +224,9 @@ type ToastProps = ComponentPropsWithoutRef<'div'> & {
215
224
  * Action can be undefined (default dismiss button), a Button component or false to hide the dismiss button
216
225
  */
217
226
  action?: React.ReactElement<typeof Button> | undefined;
227
+ /**
228
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
229
+ */
218
230
  colorScheme?: ColorSchemeTypes | undefined;
219
231
  /**
220
232
  * Optional `Icon` component to use. Must be an instance of [Icon](/?path=/docs/components-icon--docs)
@@ -334,6 +346,9 @@ declare const Avatar: {
334
346
  };
335
347
 
336
348
  type BadgeProps = ComponentPropsWithoutRef<'div'> & {
349
+ /**
350
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
351
+ */
337
352
  colorScheme?: ColorSchemeTypes;
338
353
  /**
339
354
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -348,6 +363,9 @@ type BadgeProps = ComponentPropsWithoutRef<'div'> & {
348
363
  * A `Badge` is a compact label, with optional icon, to convey status or context.
349
364
  */
350
365
  declare const Badge: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
366
+ /**
367
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
368
+ */
351
369
  colorScheme?: ColorSchemeTypes;
352
370
  /**
353
371
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -762,6 +780,9 @@ type HeadingProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT> & {
762
780
  * The content of the heading
763
781
  */
764
782
  children: ReactNode;
783
+ /**
784
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
785
+ */
765
786
  colorScheme?: ColorSchemeTypes;
766
787
  /**
767
788
  * Styles to text as disabled
@@ -803,6 +824,9 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
803
824
  * The content of the heading
804
825
  */
805
826
  children: ReactNode;
827
+ /**
828
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
829
+ */
806
830
  colorScheme?: ColorSchemeTypes;
807
831
  /**
808
832
  * Styles to text as disabled
@@ -840,6 +864,9 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
840
864
  * The content of the heading
841
865
  */
842
866
  children: ReactNode;
867
+ /**
868
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
869
+ */
843
870
  colorScheme?: ColorSchemeTypes;
844
871
  /**
845
872
  * Styles to text as disabled
@@ -1033,6 +1060,9 @@ declare const iconSizeMap: {
1033
1060
  xxl: string;
1034
1061
  };
1035
1062
  type IconProps = ComponentPropsWithoutRef<'svg'> & {
1063
+ /**
1064
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1065
+ */
1036
1066
  colorScheme?: ColorSchemeTypes;
1037
1067
  /**
1038
1068
  * Is Icon on a filled background?
@@ -1400,11 +1430,6 @@ declare const variantStyleMap: {
1400
1430
  label3: styled_components.FlattenSimpleInterpolation;
1401
1431
  label4: styled_components.FlattenSimpleInterpolation;
1402
1432
  };
1403
- declare const prominenceMap: {
1404
- highContrast: styled_components.FlattenSimpleInterpolation;
1405
- vibrant: styled_components.FlattenSimpleInterpolation;
1406
- secondary: styled_components.FlattenSimpleInterpolation;
1407
- };
1408
1433
  type TextProps = ComponentPropsWithoutRef<'div'> & {
1409
1434
  /**
1410
1435
  * The horizontal alignment
@@ -1416,6 +1441,9 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1416
1441
  * The text content
1417
1442
  */
1418
1443
  children?: ReactNode | undefined;
1444
+ /**
1445
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1446
+ */
1419
1447
  colorScheme?: ColorSchemeTypes;
1420
1448
  /**
1421
1449
  * Allows user to override default button colors
@@ -1436,9 +1464,9 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1436
1464
  */
1437
1465
  preventUserSelect?: boolean;
1438
1466
  /**
1439
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1467
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1440
1468
  */
1441
- prominence?: keyof typeof prominenceMap;
1469
+ prominence?: 'button' | 'primary' | 'secondary';
1442
1470
  /**
1443
1471
  * This will inherit the jsdoc block from PolymorphicComponent
1444
1472
  */
@@ -1464,6 +1492,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1464
1492
  * The text content
1465
1493
  */
1466
1494
  children?: ReactNode | undefined;
1495
+ /**
1496
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1497
+ */
1467
1498
  colorScheme?: ColorSchemeTypes;
1468
1499
  /**
1469
1500
  * Allows user to override default button colors
@@ -1484,9 +1515,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1484
1515
  */
1485
1516
  preventUserSelect?: boolean;
1486
1517
  /**
1487
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1518
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1488
1519
  */
1489
- prominence?: keyof typeof prominenceMap;
1520
+ prominence?: "button" | "primary" | "secondary";
1490
1521
  /**
1491
1522
  * This will inherit the jsdoc block from PolymorphicComponent
1492
1523
  */
@@ -1508,6 +1539,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1508
1539
  * The text content
1509
1540
  */
1510
1541
  children?: ReactNode | undefined;
1542
+ /**
1543
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1544
+ */
1511
1545
  colorScheme?: ColorSchemeTypes;
1512
1546
  /**
1513
1547
  * Allows user to override default button colors
@@ -1528,9 +1562,9 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1528
1562
  */
1529
1563
  preventUserSelect?: boolean;
1530
1564
  /**
1531
- * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
1565
+ * Text prominence affects color. Use 'primary' for main non-interactive text, 'secondary' for supporting text, and 'button' in specific cases where text is used in an interactive component.
1532
1566
  */
1533
- prominence?: keyof typeof prominenceMap;
1567
+ prominence?: "button" | "primary" | "secondary";
1534
1568
  /**
1535
1569
  * This will inherit the jsdoc block from PolymorphicComponent
1536
1570
  */
@@ -1854,6 +1888,9 @@ declare const Stack: (<C = "div">(props: PolymorphicComponentProps<C, StackProps
1854
1888
  })>, never> & Record<string, never>;
1855
1889
 
1856
1890
  type TagProps = ComponentPropsWithoutRef<'div'> & {
1891
+ /**
1892
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1893
+ */
1857
1894
  colorScheme?: ColorSchemeTypes;
1858
1895
  /**
1859
1896
  * Valid URL for the `Tag` label to link to
@@ -1876,6 +1913,9 @@ type TagProps = ComponentPropsWithoutRef<'div'> & {
1876
1913
  * A `Tag` is an optionally linked label, with an optional action button, to categorize content.
1877
1914
  */
1878
1915
  declare const Tag: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
1916
+ /**
1917
+ * Sets the [color scheme](../?path=/docs/docs-color-schemes--docs)
1918
+ */
1879
1919
  colorScheme?: ColorSchemeTypes;
1880
1920
  /**
1881
1921
  * Valid URL for the `Tag` label to link to
@@ -1974,4 +2014,34 @@ declare const WistiaLogo: {
1974
2014
  displayName: string;
1975
2015
  };
1976
2016
 
1977
- export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Button, ButtonGroup, type ButtonProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useFormState, useMq, useToast, useWindowSize };
2017
+ type BreadcrumbsProps = ComponentPropsWithoutRef<'div'> & {
2018
+ /**
2019
+ * Should be at least one `Breadcrumb` component
2020
+ */
2021
+ children: ReactNode;
2022
+ };
2023
+ /**
2024
+ * Used to display a screens's location within a hierarchical structure
2025
+ */
2026
+ declare const Breadcrumbs: {
2027
+ ({ children, ...props }: BreadcrumbsProps): JSX.Element;
2028
+ displayName: string;
2029
+ };
2030
+
2031
+ type BreadcrumbProps = {
2032
+ /**
2033
+ * An [Icon](../?path=/docs/components-icon--docs) to show at the beginning of the breadcrumb
2034
+ * */
2035
+ icon?: ButtonAsLinkProps['leftIcon'];
2036
+ /**
2037
+ * The text of the breadcrumb link
2038
+ */
2039
+ children: ReactNode;
2040
+ /**
2041
+ * The link to the page of the breadcrumb
2042
+ */
2043
+ href: string;
2044
+ };
2045
+ declare const Breadcrumb: ({ icon, href, children }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
2046
+
2047
+ export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useFormState, useMq, useToast, useWindowSize };