@wistia/ui 0.0.1 → 0.0.2

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.cts CHANGED
@@ -1,6 +1,7 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import * as react from 'react';
3
3
  import { ReactNode, JSX, ComponentPropsWithoutRef, ComponentPropsWithRef, MouseEvent, JSXElementConstructor, ElementType as ElementType$1 } from 'react';
4
+ import { LinkProps as LinkProps$1 } from 'react-router-dom';
4
5
  import * as styled_components from 'styled-components';
5
6
 
6
7
  type UIProviderProps = {
@@ -151,7 +152,58 @@ type ButtonVariants = 'ghost' | 'outline' | 'soft' | 'solid';
151
152
 
152
153
  type ColorSchemeTypes = 'inherit' | 'default' | 'info' | 'success' | 'warning' | 'error' | 'blue' | 'green' | 'orange' | 'pink' | 'purple' | 'yellow';
153
154
 
154
- type LinkTypes = 'default' | 'email' | 'external' | 'phone';
155
+ type LinkTypes = 'default' | 'email' | 'external' | 'phone';
156
+ type BaseProps = {
157
+ /**
158
+ * A Promise to invoke before navigating to location.
159
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
160
+ */
161
+ beforeAction?: (() => Promise<void>) | (() => void);
162
+ /**
163
+ * Text that appears inside of the link
164
+ *
165
+ * @type ReactNode
166
+ */
167
+ children: ReactNode;
168
+ /**
169
+ * Set the color scheme of the button
170
+ * TODO - link to a color scheme page
171
+ */
172
+ colorScheme?: ColorSchemeTypes;
173
+ /**
174
+ * Disables the link
175
+ */
176
+ disabled?: boolean;
177
+ /**
178
+ * Type of link to display
179
+ *
180
+ * * `email` creates a mailto
181
+ * * `phone` creates a telephone number
182
+ * * `external` will open links in a new window
183
+ */
184
+ type?: LinkTypes | undefined;
185
+ /**
186
+ * Whether the link should be underlined
187
+ */
188
+ underline?: boolean;
189
+ };
190
+ type LinkAsLinkProps = BaseProps & ComponentPropsWithRef<'a'> & Omit<LinkProps$1, 'to'> & {
191
+ href: string | undefined;
192
+ type?: LinkTypes;
193
+ };
194
+ type LinkAsButtonProps = BaseProps & ComponentPropsWithRef<'button'> & {
195
+ href?: never;
196
+ type?: 'button' | 'reset' | 'submit';
197
+ };
198
+ type LinkProps = LinkAsButtonProps | LinkAsLinkProps;
199
+ /**
200
+ * Links are used for navigation. If no `href` is supplied, a button that is visually styled to apper as a link
201
+ * is used. If used in a react-router context, their [Link](https://reactrouter.com/en/main/components/link). component is used, otherwise a native a tag.
202
+ * This means in addition to its own props, `Link` can use props from `react-router-dom`'s `Link` component. View their documentation [here](https://reactrouter.com/en/main/components/link).
203
+ * The one prop we ignore from react-router is `to`. We use `href` instead and map it under the hood.
204
+ *
205
+ */
206
+ declare const Link: react.ForwardRefExoticComponent<(Omit<LinkAsLinkProps, "ref"> | Omit<LinkAsButtonProps, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
155
207
 
156
208
  type Breakpoints = 'isLgAndDown' | 'isLgAndUp' | 'isMdAndDown' | 'isMdAndUp' | 'isSmAndDown' | 'isSmAndUp' | 'isXlAndDown' | 'isXlAndUp' | 'isXsAndDown' | 'isXsAndUp';
157
209
  type AtLeastOneBreakpoint<T, U = {
@@ -637,6 +689,45 @@ declare const Icon: {
637
689
  displayName: string;
638
690
  };
639
691
 
692
+ type IconButtonProps = {
693
+ /**
694
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
695
+ */
696
+ label: string;
697
+ /** Disable the tooltip */
698
+ disableTooltip?: boolean;
699
+ /**
700
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
701
+ */
702
+ children: JSX.Element;
703
+ } & (Omit<ButtonAsButtonProps, 'fullWidth' | 'leftIcon' | 'rightIcon'> | Omit<ButtonAsLinkProps, 'fullWidth' | 'leftIcon' | 'rightIcon'>);
704
+ /**
705
+ * IconButton behaves like a [Button](?path=/docs/ui-components-button--docs), but only accepts an Icon as a child.
706
+ */
707
+ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
708
+ /**
709
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
710
+ */
711
+ label: string;
712
+ /** Disable the tooltip */
713
+ disableTooltip?: boolean;
714
+ /**
715
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
716
+ */
717
+ children: JSX.Element;
718
+ } & Omit<ButtonAsButtonProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref"> | Omit<{
719
+ /**
720
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
721
+ */
722
+ label: string;
723
+ /** Disable the tooltip */
724
+ disableTooltip?: boolean;
725
+ /**
726
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
727
+ */
728
+ children: JSX.Element;
729
+ } & Omit<ButtonAsLinkProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
730
+
640
731
  type ScreenReaderOnlyProps = ComponentPropsWithoutRef<'div'> & {
641
732
  /**
642
733
  * Pass an arbitrary child node
@@ -699,7 +790,8 @@ declare const variantStyleMap: {
699
790
  label4: styled_components.FlattenSimpleInterpolation;
700
791
  };
701
792
  declare const prominenceMap: {
702
- primary: styled_components.FlattenSimpleInterpolation;
793
+ highContrast: styled_components.FlattenSimpleInterpolation;
794
+ vibrant: styled_components.FlattenSimpleInterpolation;
703
795
  secondary: styled_components.FlattenSimpleInterpolation;
704
796
  };
705
797
  type TextProps = ComponentPropsWithoutRef<'div'> & {
@@ -736,7 +828,7 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
736
828
  */
737
829
  preventUserSelect?: boolean;
738
830
  /**
739
- * The prominence of the text. This affects the color of the text
831
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
740
832
  */
741
833
  prominence?: keyof typeof prominenceMap;
742
834
  renderAs?: ElementType$1;
@@ -781,7 +873,7 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
781
873
  */
782
874
  preventUserSelect?: boolean;
783
875
  /**
784
- * The prominence of the text. This affects the color of the text
876
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
785
877
  */
786
878
  prominence?: keyof typeof prominenceMap;
787
879
  renderAs?: ElementType$1;
@@ -825,7 +917,7 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
825
917
  */
826
918
  preventUserSelect?: boolean;
827
919
  /**
828
- * The prominence of the text. This affects the color of the text
920
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
829
921
  */
830
922
  prominence?: keyof typeof prominenceMap;
831
923
  renderAs?: ElementType$1;
@@ -837,44 +929,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
837
929
  renderAs: react.JSXElementConstructor<any> | keyof react.JSX.IntrinsicElements;
838
930
  })>, never> & Record<string, never>;
839
931
 
840
- type WistiaLogoProps = Omit<ComponentPropsWithoutRef<'svg'>, 'href'> & {
841
- /**
842
- * An optional accessible description for the logo
843
- */
844
- description?: string;
845
- /**
846
- * Height, in pixels, of the logo
847
- */
848
- height?: number;
849
- /**
850
- * @ignore
851
- * Change the color when hovering over the logo
852
- */
853
- hoverColor?: string;
854
- /**
855
- * Display just the icon portion of the logo (ie. hide `Wistia` text)
856
- * note: there is no analogue to this because by brand guidelines, the
857
- * `Wistia` text must not be displayed without the "flags" iconography
858
- */
859
- iconOnly?: boolean;
860
- /**
861
- * If provided, will wrap the logo in a link
862
- */
863
- href?: string;
864
- /**
865
- * An accessible title for the logo (defaults to "Wistia Logo")
866
- */
867
- title?: string;
868
- /**
869
- * Style of the logo
870
- */
871
- variant?: 'dark' | 'light' | 'standard';
872
- };
873
- declare const WistiaLogo: {
874
- ({ description, height, hoverColor, href, iconOnly, title, variant, ...otherProps }: WistiaLogoProps): react_jsx_runtime.JSX.Element;
875
- displayName: string;
876
- };
877
-
878
932
  type TooltipProps = {
879
933
  /**
880
934
  * The content of the tooltip
@@ -914,43 +968,42 @@ declare const Tooltip: {
914
968
  displayName: string;
915
969
  };
916
970
 
917
- type IconButtonProps = {
971
+ type WistiaLogoProps = Omit<ComponentPropsWithoutRef<'svg'>, 'href'> & {
918
972
  /**
919
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
973
+ * An optional accessible description for the logo
920
974
  */
921
- label: string;
922
- /** Disable the tooltip */
923
- disableTooltip?: boolean;
975
+ description?: string;
924
976
  /**
925
- * The Icon component to use, e.g. `<Icon type="favorite" />`
977
+ * Height, in pixels, of the logo
926
978
  */
927
- children: JSX.Element;
928
- } & (Omit<ButtonAsButtonProps, 'fullWidth' | 'leftIcon' | 'rightIcon'> | Omit<ButtonAsLinkProps, 'fullWidth' | 'leftIcon' | 'rightIcon'>);
929
- /**
930
- * IconButton behaves like a [Button](?path=/docs/ui-components-button--docs), but only accepts an Icon as a child.
931
- */
932
- declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
979
+ height?: number;
933
980
  /**
934
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
981
+ * @ignore
982
+ * Change the color when hovering over the logo
935
983
  */
936
- label: string;
937
- /** Disable the tooltip */
938
- disableTooltip?: boolean;
984
+ hoverColor?: string;
939
985
  /**
940
- * The Icon component to use, e.g. `<Icon type="favorite" />`
986
+ * Display just the icon portion of the logo (ie. hide `Wistia` text)
987
+ * note: there is no analogue to this because by brand guidelines, the
988
+ * `Wistia` text must not be displayed without the "flags" iconography
941
989
  */
942
- children: JSX.Element;
943
- } & Omit<ButtonAsButtonProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref"> | Omit<{
990
+ iconOnly?: boolean;
944
991
  /**
945
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
992
+ * If provided, will wrap the logo in a link
946
993
  */
947
- label: string;
948
- /** Disable the tooltip */
949
- disableTooltip?: boolean;
994
+ href?: string;
950
995
  /**
951
- * The Icon component to use, e.g. `<Icon type="favorite" />`
996
+ * An accessible title for the logo (defaults to "Wistia Logo")
952
997
  */
953
- children: JSX.Element;
954
- } & Omit<ButtonAsLinkProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
998
+ title?: string;
999
+ /**
1000
+ * Style of the logo
1001
+ */
1002
+ variant?: 'dark' | 'light' | 'standard';
1003
+ };
1004
+ declare const WistiaLogo: {
1005
+ ({ description, height, hoverColor, href, iconOnly, title, variant, ...otherProps }: WistiaLogoProps): react_jsx_runtime.JSX.Element;
1006
+ displayName: string;
1007
+ };
955
1008
 
956
- export { Box, Button, ButtonGroup, type ButtonProps, Divider, Ellipsis, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, ScreenReaderOnly, Stack, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, useActiveMq, useAriaLive, useMq, useWindowSize };
1009
+ export { Box, Button, ButtonGroup, type ButtonProps, Divider, Ellipsis, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Link, type LinkProps, ScreenReaderOnly, Stack, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, useActiveMq, useAriaLive, useMq, useWindowSize };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import * as react from 'react';
3
3
  import { ReactNode, JSX, ComponentPropsWithoutRef, ComponentPropsWithRef, MouseEvent, JSXElementConstructor, ElementType as ElementType$1 } from 'react';
4
+ import { LinkProps as LinkProps$1 } from 'react-router-dom';
4
5
  import * as styled_components from 'styled-components';
5
6
 
6
7
  type UIProviderProps = {
@@ -151,7 +152,58 @@ type ButtonVariants = 'ghost' | 'outline' | 'soft' | 'solid';
151
152
 
152
153
  type ColorSchemeTypes = 'inherit' | 'default' | 'info' | 'success' | 'warning' | 'error' | 'blue' | 'green' | 'orange' | 'pink' | 'purple' | 'yellow';
153
154
 
154
- type LinkTypes = 'default' | 'email' | 'external' | 'phone';
155
+ type LinkTypes = 'default' | 'email' | 'external' | 'phone';
156
+ type BaseProps = {
157
+ /**
158
+ * A Promise to invoke before navigating to location.
159
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
160
+ */
161
+ beforeAction?: (() => Promise<void>) | (() => void);
162
+ /**
163
+ * Text that appears inside of the link
164
+ *
165
+ * @type ReactNode
166
+ */
167
+ children: ReactNode;
168
+ /**
169
+ * Set the color scheme of the button
170
+ * TODO - link to a color scheme page
171
+ */
172
+ colorScheme?: ColorSchemeTypes;
173
+ /**
174
+ * Disables the link
175
+ */
176
+ disabled?: boolean;
177
+ /**
178
+ * Type of link to display
179
+ *
180
+ * * `email` creates a mailto
181
+ * * `phone` creates a telephone number
182
+ * * `external` will open links in a new window
183
+ */
184
+ type?: LinkTypes | undefined;
185
+ /**
186
+ * Whether the link should be underlined
187
+ */
188
+ underline?: boolean;
189
+ };
190
+ type LinkAsLinkProps = BaseProps & ComponentPropsWithRef<'a'> & Omit<LinkProps$1, 'to'> & {
191
+ href: string | undefined;
192
+ type?: LinkTypes;
193
+ };
194
+ type LinkAsButtonProps = BaseProps & ComponentPropsWithRef<'button'> & {
195
+ href?: never;
196
+ type?: 'button' | 'reset' | 'submit';
197
+ };
198
+ type LinkProps = LinkAsButtonProps | LinkAsLinkProps;
199
+ /**
200
+ * Links are used for navigation. If no `href` is supplied, a button that is visually styled to apper as a link
201
+ * is used. If used in a react-router context, their [Link](https://reactrouter.com/en/main/components/link). component is used, otherwise a native a tag.
202
+ * This means in addition to its own props, `Link` can use props from `react-router-dom`'s `Link` component. View their documentation [here](https://reactrouter.com/en/main/components/link).
203
+ * The one prop we ignore from react-router is `to`. We use `href` instead and map it under the hood.
204
+ *
205
+ */
206
+ declare const Link: react.ForwardRefExoticComponent<(Omit<LinkAsLinkProps, "ref"> | Omit<LinkAsButtonProps, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
155
207
 
156
208
  type Breakpoints = 'isLgAndDown' | 'isLgAndUp' | 'isMdAndDown' | 'isMdAndUp' | 'isSmAndDown' | 'isSmAndUp' | 'isXlAndDown' | 'isXlAndUp' | 'isXsAndDown' | 'isXsAndUp';
157
209
  type AtLeastOneBreakpoint<T, U = {
@@ -637,6 +689,45 @@ declare const Icon: {
637
689
  displayName: string;
638
690
  };
639
691
 
692
+ type IconButtonProps = {
693
+ /**
694
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
695
+ */
696
+ label: string;
697
+ /** Disable the tooltip */
698
+ disableTooltip?: boolean;
699
+ /**
700
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
701
+ */
702
+ children: JSX.Element;
703
+ } & (Omit<ButtonAsButtonProps, 'fullWidth' | 'leftIcon' | 'rightIcon'> | Omit<ButtonAsLinkProps, 'fullWidth' | 'leftIcon' | 'rightIcon'>);
704
+ /**
705
+ * IconButton behaves like a [Button](?path=/docs/ui-components-button--docs), but only accepts an Icon as a child.
706
+ */
707
+ declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
708
+ /**
709
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
710
+ */
711
+ label: string;
712
+ /** Disable the tooltip */
713
+ disableTooltip?: boolean;
714
+ /**
715
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
716
+ */
717
+ children: JSX.Element;
718
+ } & Omit<ButtonAsButtonProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref"> | Omit<{
719
+ /**
720
+ * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
721
+ */
722
+ label: string;
723
+ /** Disable the tooltip */
724
+ disableTooltip?: boolean;
725
+ /**
726
+ * The Icon component to use, e.g. `<Icon type="favorite" />`
727
+ */
728
+ children: JSX.Element;
729
+ } & Omit<ButtonAsLinkProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
730
+
640
731
  type ScreenReaderOnlyProps = ComponentPropsWithoutRef<'div'> & {
641
732
  /**
642
733
  * Pass an arbitrary child node
@@ -699,7 +790,8 @@ declare const variantStyleMap: {
699
790
  label4: styled_components.FlattenSimpleInterpolation;
700
791
  };
701
792
  declare const prominenceMap: {
702
- primary: styled_components.FlattenSimpleInterpolation;
793
+ highContrast: styled_components.FlattenSimpleInterpolation;
794
+ vibrant: styled_components.FlattenSimpleInterpolation;
703
795
  secondary: styled_components.FlattenSimpleInterpolation;
704
796
  };
705
797
  type TextProps = ComponentPropsWithoutRef<'div'> & {
@@ -736,7 +828,7 @@ type TextProps = ComponentPropsWithoutRef<'div'> & {
736
828
  */
737
829
  preventUserSelect?: boolean;
738
830
  /**
739
- * The prominence of the text. This affects the color of the text
831
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
740
832
  */
741
833
  prominence?: keyof typeof prominenceMap;
742
834
  renderAs?: ElementType$1;
@@ -781,7 +873,7 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
781
873
  */
782
874
  preventUserSelect?: boolean;
783
875
  /**
784
- * The prominence of the text. This affects the color of the text
876
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
785
877
  */
786
878
  prominence?: keyof typeof prominenceMap;
787
879
  renderAs?: ElementType$1;
@@ -825,7 +917,7 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
825
917
  */
826
918
  preventUserSelect?: boolean;
827
919
  /**
828
- * The prominence of the text. This affects the color of the text
920
+ * Text prominence affects color. Use 'highContrast' for main non-interactive text, 'vibrant' for interactive elements, and 'secondary' for less important or supplementary content.
829
921
  */
830
922
  prominence?: keyof typeof prominenceMap;
831
923
  renderAs?: ElementType$1;
@@ -837,44 +929,6 @@ declare const Text: (<C = "div">(props: PolymorphicComponentProps<C, TextProps>)
837
929
  renderAs: react.JSXElementConstructor<any> | keyof react.JSX.IntrinsicElements;
838
930
  })>, never> & Record<string, never>;
839
931
 
840
- type WistiaLogoProps = Omit<ComponentPropsWithoutRef<'svg'>, 'href'> & {
841
- /**
842
- * An optional accessible description for the logo
843
- */
844
- description?: string;
845
- /**
846
- * Height, in pixels, of the logo
847
- */
848
- height?: number;
849
- /**
850
- * @ignore
851
- * Change the color when hovering over the logo
852
- */
853
- hoverColor?: string;
854
- /**
855
- * Display just the icon portion of the logo (ie. hide `Wistia` text)
856
- * note: there is no analogue to this because by brand guidelines, the
857
- * `Wistia` text must not be displayed without the "flags" iconography
858
- */
859
- iconOnly?: boolean;
860
- /**
861
- * If provided, will wrap the logo in a link
862
- */
863
- href?: string;
864
- /**
865
- * An accessible title for the logo (defaults to "Wistia Logo")
866
- */
867
- title?: string;
868
- /**
869
- * Style of the logo
870
- */
871
- variant?: 'dark' | 'light' | 'standard';
872
- };
873
- declare const WistiaLogo: {
874
- ({ description, height, hoverColor, href, iconOnly, title, variant, ...otherProps }: WistiaLogoProps): react_jsx_runtime.JSX.Element;
875
- displayName: string;
876
- };
877
-
878
932
  type TooltipProps = {
879
933
  /**
880
934
  * The content of the tooltip
@@ -914,43 +968,42 @@ declare const Tooltip: {
914
968
  displayName: string;
915
969
  };
916
970
 
917
- type IconButtonProps = {
971
+ type WistiaLogoProps = Omit<ComponentPropsWithoutRef<'svg'>, 'href'> & {
918
972
  /**
919
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
973
+ * An optional accessible description for the logo
920
974
  */
921
- label: string;
922
- /** Disable the tooltip */
923
- disableTooltip?: boolean;
975
+ description?: string;
924
976
  /**
925
- * The Icon component to use, e.g. `<Icon type="favorite" />`
977
+ * Height, in pixels, of the logo
926
978
  */
927
- children: JSX.Element;
928
- } & (Omit<ButtonAsButtonProps, 'fullWidth' | 'leftIcon' | 'rightIcon'> | Omit<ButtonAsLinkProps, 'fullWidth' | 'leftIcon' | 'rightIcon'>);
929
- /**
930
- * IconButton behaves like a [Button](?path=/docs/ui-components-button--docs), but only accepts an Icon as a child.
931
- */
932
- declare const IconButton: react.ForwardRefExoticComponent<(Omit<{
979
+ height?: number;
933
980
  /**
934
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
981
+ * @ignore
982
+ * Change the color when hovering over the logo
935
983
  */
936
- label: string;
937
- /** Disable the tooltip */
938
- disableTooltip?: boolean;
984
+ hoverColor?: string;
939
985
  /**
940
- * The Icon component to use, e.g. `<Icon type="favorite" />`
986
+ * Display just the icon portion of the logo (ie. hide `Wistia` text)
987
+ * note: there is no analogue to this because by brand guidelines, the
988
+ * `Wistia` text must not be displayed without the "flags" iconography
941
989
  */
942
- children: JSX.Element;
943
- } & Omit<ButtonAsButtonProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref"> | Omit<{
990
+ iconOnly?: boolean;
944
991
  /**
945
- * Accessible text for screen readers. Also shows up in a tooltip unless `disableTooltip` is true.
992
+ * If provided, will wrap the logo in a link
946
993
  */
947
- label: string;
948
- /** Disable the tooltip */
949
- disableTooltip?: boolean;
994
+ href?: string;
950
995
  /**
951
- * The Icon component to use, e.g. `<Icon type="favorite" />`
996
+ * An accessible title for the logo (defaults to "Wistia Logo")
952
997
  */
953
- children: JSX.Element;
954
- } & Omit<ButtonAsLinkProps, "leftIcon" | "fullWidth" | "rightIcon">, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
998
+ title?: string;
999
+ /**
1000
+ * Style of the logo
1001
+ */
1002
+ variant?: 'dark' | 'light' | 'standard';
1003
+ };
1004
+ declare const WistiaLogo: {
1005
+ ({ description, height, hoverColor, href, iconOnly, title, variant, ...otherProps }: WistiaLogoProps): react_jsx_runtime.JSX.Element;
1006
+ displayName: string;
1007
+ };
955
1008
 
956
- export { Box, Button, ButtonGroup, type ButtonProps, Divider, Ellipsis, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, ScreenReaderOnly, Stack, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, useActiveMq, useAriaLive, useMq, useWindowSize };
1009
+ export { Box, Button, ButtonGroup, type ButtonProps, Divider, Ellipsis, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Link, type LinkProps, ScreenReaderOnly, Stack, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, useActiveMq, useAriaLive, useMq, useWindowSize };