@wistia/ui 0.0.25 → 0.1.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/dist/index.d.mts CHANGED
@@ -54,9 +54,6 @@ 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
- * The color scheme to apply
59
- */
60
57
  colorScheme?: ColorSchemeTypes;
61
58
  /**
62
59
  * Children
@@ -86,9 +83,6 @@ type BaseProps = {
86
83
  * @type ReactNode
87
84
  */
88
85
  children: ReactNode;
89
- /**
90
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Link`
91
- */
92
86
  colorScheme?: ColorSchemeTypes;
93
87
  /**
94
88
  * Disables the link
@@ -141,9 +135,6 @@ type BaseButtonProps = {
141
135
  * @type ReactNode
142
136
  */
143
137
  children?: ReactNode;
144
- /**
145
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Button`
146
- */
147
138
  colorScheme?: ColorSchemeTypes;
148
139
  /**
149
140
  * Disables the button
@@ -224,9 +215,6 @@ type ToastProps = ComponentPropsWithoutRef<'div'> & {
224
215
  * Action can be undefined (default dismiss button), a Button component or false to hide the dismiss button
225
216
  */
226
217
  action?: React.ReactElement<typeof Button> | undefined;
227
- /**
228
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Toast`
229
- */
230
218
  colorScheme?: ColorSchemeTypes | undefined;
231
219
  /**
232
220
  * Optional `Icon` component to use. Must be an instance of [Icon](/?path=/docs/components-icon--docs)
@@ -289,9 +277,6 @@ declare const Avatar: {
289
277
  };
290
278
 
291
279
  type BadgeProps = ComponentPropsWithoutRef<'div'> & {
292
- /**
293
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Badge`
294
- */
295
280
  colorScheme?: ColorSchemeTypes;
296
281
  /**
297
282
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -306,9 +291,6 @@ type BadgeProps = ComponentPropsWithoutRef<'div'> & {
306
291
  * A `Badge` is a compact label, with optional icon, to convey status or context.
307
292
  */
308
293
  declare const Badge: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
309
- /**
310
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Badge`
311
- */
312
294
  colorScheme?: ColorSchemeTypes;
313
295
  /**
314
296
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -723,9 +705,6 @@ type HeadingProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT> & {
723
705
  * The content of the heading
724
706
  */
725
707
  children: ReactNode;
726
- /**
727
- * Sets the hue of the text
728
- */
729
708
  colorScheme?: ColorSchemeTypes;
730
709
  /**
731
710
  * Styles to text as disabled
@@ -767,9 +746,6 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
767
746
  * The content of the heading
768
747
  */
769
748
  children: ReactNode;
770
- /**
771
- * Sets the hue of the text
772
- */
773
749
  colorScheme?: ColorSchemeTypes;
774
750
  /**
775
751
  * Styles to text as disabled
@@ -807,9 +783,6 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
807
783
  * The content of the heading
808
784
  */
809
785
  children: ReactNode;
810
- /**
811
- * Sets the hue of the text
812
- */
813
786
  colorScheme?: ColorSchemeTypes;
814
787
  /**
815
788
  * Styles to text as disabled
@@ -1003,9 +976,6 @@ declare const iconSizeMap: {
1003
976
  xxl: string;
1004
977
  };
1005
978
  type IconProps = ComponentPropsWithoutRef<'svg'> & {
1006
- /**
1007
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Icon`
1008
- */
1009
979
  colorScheme?: ColorSchemeTypes;
1010
980
  /**
1011
981
  * Is Icon on a filled background?
@@ -1026,7 +996,7 @@ type IconProps = ComponentPropsWithoutRef<'svg'> & {
1026
996
  };
1027
997
  /**
1028
998
  * A component that renders any of our available icons. Note that icons should not be used directly
1029
- * for interactivity. If you need an interactive element, use [IconButton](?path=/docs/ui-components-iconbutton--docs).
999
+ * for interactivity. If you need an interactive element, use [IconButton](?path=/docs/components-iconbutton--docs).
1030
1000
  */
1031
1001
  declare const Icon: {
1032
1002
  ({ invertColor, colorScheme, size, style, type, ...otherProps }: IconProps): JSX.Element;
@@ -1038,10 +1008,6 @@ type IconButtonProps = {
1038
1008
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1039
1009
  */
1040
1010
  label: string;
1041
- /**
1042
- * Disable the tooltip
1043
- */
1044
- disableTooltip?: boolean;
1045
1011
  /**
1046
1012
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1047
1013
  */
@@ -1056,10 +1022,6 @@ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
1056
1022
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1057
1023
  */
1058
1024
  label: string;
1059
- /**
1060
- * Disable the tooltip
1061
- */
1062
- disableTooltip?: boolean;
1063
1025
  /**
1064
1026
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1065
1027
  */
@@ -1069,10 +1031,6 @@ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
1069
1031
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1070
1032
  */
1071
1033
  label: string;
1072
- /**
1073
- * Disable the tooltip
1074
- */
1075
- disableTooltip?: boolean;
1076
1034
  /**
1077
1035
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1078
1036
  */
@@ -1337,9 +1295,6 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1337
1295
  * The text content
1338
1296
  */
1339
1297
  children?: ReactNode | undefined;
1340
- /**
1341
- * Sets the hue of the text
1342
- */
1343
1298
  colorScheme?: ColorSchemeTypes;
1344
1299
  /**
1345
1300
  * Allows user to override default button colors
@@ -1388,9 +1343,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1388
1343
  * The text content
1389
1344
  */
1390
1345
  children?: ReactNode | undefined;
1391
- /**
1392
- * Sets the hue of the text
1393
- */
1394
1346
  colorScheme?: ColorSchemeTypes;
1395
1347
  /**
1396
1348
  * Allows user to override default button colors
@@ -1435,9 +1387,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1435
1387
  * The text content
1436
1388
  */
1437
1389
  children?: ReactNode | undefined;
1438
- /**
1439
- * Sets the hue of the text
1440
- */
1441
1390
  colorScheme?: ColorSchemeTypes;
1442
1391
  /**
1443
1392
  * Allows user to override default button colors
@@ -1701,9 +1650,6 @@ declare const Stack: (<C = "div">(props: PolymorphicComponentProps<C, StackProps
1701
1650
  })>, never> & Record<string, never>;
1702
1651
 
1703
1652
  type TagProps = ComponentPropsWithoutRef<'div'> & {
1704
- /**
1705
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Tag`
1706
- */
1707
1653
  colorScheme?: ColorSchemeTypes;
1708
1654
  /**
1709
1655
  * Valid URL for the `Tag` label to link to
@@ -1726,9 +1672,6 @@ type TagProps = ComponentPropsWithoutRef<'div'> & {
1726
1672
  * A `Tag` is an optionally linked label, with an optional action button, to categorize content.
1727
1673
  */
1728
1674
  declare const Tag: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
1729
- /**
1730
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Tag`
1731
- */
1732
1675
  colorScheme?: ColorSchemeTypes;
1733
1676
  /**
1734
1677
  * Valid URL for the `Tag` label to link to
package/dist/index.d.ts CHANGED
@@ -54,9 +54,6 @@ 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
- * The color scheme to apply
59
- */
60
57
  colorScheme?: ColorSchemeTypes;
61
58
  /**
62
59
  * Children
@@ -86,9 +83,6 @@ type BaseProps = {
86
83
  * @type ReactNode
87
84
  */
88
85
  children: ReactNode;
89
- /**
90
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Link`
91
- */
92
86
  colorScheme?: ColorSchemeTypes;
93
87
  /**
94
88
  * Disables the link
@@ -141,9 +135,6 @@ type BaseButtonProps = {
141
135
  * @type ReactNode
142
136
  */
143
137
  children?: ReactNode;
144
- /**
145
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Button`
146
- */
147
138
  colorScheme?: ColorSchemeTypes;
148
139
  /**
149
140
  * Disables the button
@@ -224,9 +215,6 @@ type ToastProps = ComponentPropsWithoutRef<'div'> & {
224
215
  * Action can be undefined (default dismiss button), a Button component or false to hide the dismiss button
225
216
  */
226
217
  action?: React.ReactElement<typeof Button> | undefined;
227
- /**
228
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Toast`
229
- */
230
218
  colorScheme?: ColorSchemeTypes | undefined;
231
219
  /**
232
220
  * Optional `Icon` component to use. Must be an instance of [Icon](/?path=/docs/components-icon--docs)
@@ -289,9 +277,6 @@ declare const Avatar: {
289
277
  };
290
278
 
291
279
  type BadgeProps = ComponentPropsWithoutRef<'div'> & {
292
- /**
293
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Badge`
294
- */
295
280
  colorScheme?: ColorSchemeTypes;
296
281
  /**
297
282
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -306,9 +291,6 @@ type BadgeProps = ComponentPropsWithoutRef<'div'> & {
306
291
  * A `Badge` is a compact label, with optional icon, to convey status or context.
307
292
  */
308
293
  declare const Badge: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
309
- /**
310
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Badge`
311
- */
312
294
  colorScheme?: ColorSchemeTypes;
313
295
  /**
314
296
  * The `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
@@ -723,9 +705,6 @@ type HeadingProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT> & {
723
705
  * The content of the heading
724
706
  */
725
707
  children: ReactNode;
726
- /**
727
- * Sets the hue of the text
728
- */
729
708
  colorScheme?: ColorSchemeTypes;
730
709
  /**
731
710
  * Styles to text as disabled
@@ -767,9 +746,6 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
767
746
  * The content of the heading
768
747
  */
769
748
  children: ReactNode;
770
- /**
771
- * Sets the hue of the text
772
- */
773
749
  colorScheme?: ColorSchemeTypes;
774
750
  /**
775
751
  * Styles to text as disabled
@@ -807,9 +783,6 @@ declare const Heading: (<C = "h1">(props: PolymorphicComponentProps<C, HeadingPr
807
783
  * The content of the heading
808
784
  */
809
785
  children: ReactNode;
810
- /**
811
- * Sets the hue of the text
812
- */
813
786
  colorScheme?: ColorSchemeTypes;
814
787
  /**
815
788
  * Styles to text as disabled
@@ -1003,9 +976,6 @@ declare const iconSizeMap: {
1003
976
  xxl: string;
1004
977
  };
1005
978
  type IconProps = ComponentPropsWithoutRef<'svg'> & {
1006
- /**
1007
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Icon`
1008
- */
1009
979
  colorScheme?: ColorSchemeTypes;
1010
980
  /**
1011
981
  * Is Icon on a filled background?
@@ -1026,7 +996,7 @@ type IconProps = ComponentPropsWithoutRef<'svg'> & {
1026
996
  };
1027
997
  /**
1028
998
  * A component that renders any of our available icons. Note that icons should not be used directly
1029
- * for interactivity. If you need an interactive element, use [IconButton](?path=/docs/ui-components-iconbutton--docs).
999
+ * for interactivity. If you need an interactive element, use [IconButton](?path=/docs/components-iconbutton--docs).
1030
1000
  */
1031
1001
  declare const Icon: {
1032
1002
  ({ invertColor, colorScheme, size, style, type, ...otherProps }: IconProps): JSX.Element;
@@ -1038,10 +1008,6 @@ type IconButtonProps = {
1038
1008
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1039
1009
  */
1040
1010
  label: string;
1041
- /**
1042
- * Disable the tooltip
1043
- */
1044
- disableTooltip?: boolean;
1045
1011
  /**
1046
1012
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1047
1013
  */
@@ -1056,10 +1022,6 @@ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
1056
1022
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1057
1023
  */
1058
1024
  label: string;
1059
- /**
1060
- * Disable the tooltip
1061
- */
1062
- disableTooltip?: boolean;
1063
1025
  /**
1064
1026
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1065
1027
  */
@@ -1069,10 +1031,6 @@ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
1069
1031
  * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
1070
1032
  */
1071
1033
  label: string;
1072
- /**
1073
- * Disable the tooltip
1074
- */
1075
- disableTooltip?: boolean;
1076
1034
  /**
1077
1035
  * The Icon component to use, e.g. `<Icon type="favorite" />`
1078
1036
  */
@@ -1337,9 +1295,6 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
1337
1295
  * The text content
1338
1296
  */
1339
1297
  children?: ReactNode | undefined;
1340
- /**
1341
- * Sets the hue of the text
1342
- */
1343
1298
  colorScheme?: ColorSchemeTypes;
1344
1299
  /**
1345
1300
  * Allows user to override default button colors
@@ -1388,9 +1343,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1388
1343
  * The text content
1389
1344
  */
1390
1345
  children?: ReactNode | undefined;
1391
- /**
1392
- * Sets the hue of the text
1393
- */
1394
1346
  colorScheme?: ColorSchemeTypes;
1395
1347
  /**
1396
1348
  * Allows user to override default button colors
@@ -1435,9 +1387,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
1435
1387
  * The text content
1436
1388
  */
1437
1389
  children?: ReactNode | undefined;
1438
- /**
1439
- * Sets the hue of the text
1440
- */
1441
1390
  colorScheme?: ColorSchemeTypes;
1442
1391
  /**
1443
1392
  * Allows user to override default button colors
@@ -1701,9 +1650,6 @@ declare const Stack: (<C = "div">(props: PolymorphicComponentProps<C, StackProps
1701
1650
  })>, never> & Record<string, never>;
1702
1651
 
1703
1652
  type TagProps = ComponentPropsWithoutRef<'div'> & {
1704
- /**
1705
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Tag`
1706
- */
1707
1653
  colorScheme?: ColorSchemeTypes;
1708
1654
  /**
1709
1655
  * Valid URL for the `Tag` label to link to
@@ -1726,9 +1672,6 @@ type TagProps = ComponentPropsWithoutRef<'div'> & {
1726
1672
  * A `Tag` is an optionally linked label, with an optional action button, to categorize content.
1727
1673
  */
1728
1674
  declare const Tag: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
1729
- /**
1730
- * Set the [color scheme](../?path=/docs/docs-color-schemes--docs) of the `Tag`
1731
- */
1732
1675
  colorScheme?: ColorSchemeTypes;
1733
1676
  /**
1734
1677
  * Valid URL for the `Tag` label to link to