@wistia/vhs 5.0.4-beta.fbbdd3f9.3ee7519 → 5.0.4-beta.fe607306.d0df8d8

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.ts CHANGED
@@ -225,11 +225,11 @@ interface VHSTheme {
225
225
  }
226
226
  //#endregion
227
227
  //#region src/helpers/copyToClipboard/copyToClipboard.d.ts
228
- /**
229
- * Copies a string to user's clipboard for easy pasting in another location
230
- *
231
- * @param {string} textToCopy - the string that will be copied to users clipboard
232
- * @returns {Promise} - Promise object that represents the copied string
228
+ /**
229
+ * Copies a string to user's clipboard for easy pasting in another location
230
+ *
231
+ * @param {string} textToCopy - the string that will be copied to users clipboard
232
+ * @returns {Promise} - Promise object that represents the copied string
233
233
  */
234
234
  declare const copyToClipboard: (textToCopy: string) => Promise<void>;
235
235
  //#endregion
@@ -355,20 +355,20 @@ declare const gradients: {
355
355
  };
356
356
  type GradientNameType = keyof typeof gradients;
357
357
  type GetBackgroundGradientType = GradientNameType | undefined;
358
- /**
359
- * Retrieves the CSS background gradient corresponding to the given gradient name.
360
- * If the specified gradient name is not found, the default gradient ('defaultDarkOne') is returned.
361
- * @param {GradientName} gradientName - The name of the gradient to retrieve.
362
- * @returns {FlattenSimpleInterpolation} The CSS string representing the specified gradient.
358
+ /**
359
+ * Retrieves the CSS background gradient corresponding to the given gradient name.
360
+ * If the specified gradient name is not found, the default gradient ('defaultDarkOne') is returned.
361
+ * @param {GradientName} gradientName - The name of the gradient to retrieve.
362
+ * @returns {FlattenSimpleInterpolation} The CSS string representing the specified gradient.
363
363
  */
364
364
  declare const getBackgroundGradient: (gradientName?: GetBackgroundGradientType) => ReturnType<typeof css>;
365
365
  //#endregion
366
366
  //#region src/helpers/getBackgroundGradient/getSemiRandomBackgroundGradient.d.ts
367
- /**
368
- * Retrieves a semi-random background gradient based on the given id.
369
- *
370
- * @param {string} id - The id to use to generate the semi-random background gradient.
371
- * @returns {GradientName} gradientName
367
+ /**
368
+ * Retrieves a semi-random background gradient based on the given id.
369
+ *
370
+ * @param {string} id - The id to use to generate the semi-random background gradient.
371
+ * @returns {GradientName} gradientName
372
372
  */
373
373
  declare const getSemiRandomBackgroundGradient: (id: string) => GradientNameType | undefined;
374
374
  //#endregion
@@ -462,108 +462,108 @@ type DefaultLinkWrapperProps = {
462
462
  children: ReactNode;
463
463
  };
464
464
  type LinkProps = ComponentPropsWithoutRef<'a'> & {
465
- /**
466
- * A Promise to invoke before navigating to location.
467
- * _Caution: if used with `external` type prop a new window will **not** be opened_
465
+ /**
466
+ * A Promise to invoke before navigating to location.
467
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
468
468
  */
469
469
  beforeAction?: (() => Promise<void>) | (() => void);
470
- /**
471
- * The content that will be rendered inside the link
470
+ /**
471
+ * The content that will be rendered inside the link
472
472
  */
473
473
  children: ReactNode;
474
- /**
475
- * Disables Link
474
+ /**
475
+ * Disables Link
476
476
  */
477
477
  disabled?: boolean;
478
- /**
479
- * @ignore
480
- * Force a Link into a particular css state (for debugging)
478
+ /**
479
+ * @ignore
480
+ * Force a Link into a particular css state (for debugging)
481
481
  */
482
482
  forceState?: 'active' | 'focus' | 'hover';
483
- /**
484
- * The entity to link to (url, email address, telephone number)
483
+ /**
484
+ * The entity to link to (url, email address, telephone number)
485
485
  */
486
486
  href: string;
487
- /**
488
- * Use this if your link is "nested" inside another link
487
+ /**
488
+ * Use this if your link is "nested" inside another link
489
489
  */
490
490
  nested?: boolean;
491
- /**
492
- * An object that will be converted into a search parameter string and appended to
493
- * the `to` prop value
491
+ /**
492
+ * An object that will be converted into a search parameter string and appended to
493
+ * the `to` prop value
494
494
  */
495
495
  params?: LinkURLParameters;
496
- /**
497
- * Type of link to display
498
- *
499
- * * `email` creates a mailto
500
- * * `phone` creates a telephone number
501
- * * `external` will open links in a new window
496
+ /**
497
+ * Type of link to display
498
+ *
499
+ * * `email` creates a mailto
500
+ * * `phone` creates a telephone number
501
+ * * `external` will open links in a new window
502
502
  */
503
503
  type?: LinkTypes;
504
- /**
505
- * Will only display an underline when the Link is in a hover state
504
+ /**
505
+ * Will only display an underline when the Link is in a hover state
506
506
  */
507
507
  underlineOnHover?: boolean;
508
- /**
509
- * Renders a link without any of the default styling applied
508
+ /**
509
+ * Renders a link without any of the default styling applied
510
510
  */
511
511
  unstyled?: boolean;
512
- /**
513
- * The visual type of Link to display
512
+ /**
513
+ * The visual type of Link to display
514
514
  */
515
515
  variant?: 'dangerous' | 'primary' | 'secondary';
516
516
  };
517
517
  declare const Link$1: _$react.ForwardRefExoticComponent<Omit<_$react.DetailedHTMLProps<_$react.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref"> & {
518
- /**
519
- * A Promise to invoke before navigating to location.
520
- * _Caution: if used with `external` type prop a new window will **not** be opened_
518
+ /**
519
+ * A Promise to invoke before navigating to location.
520
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
521
521
  */
522
522
  beforeAction?: (() => Promise<void>) | (() => void);
523
- /**
524
- * The content that will be rendered inside the link
523
+ /**
524
+ * The content that will be rendered inside the link
525
525
  */
526
526
  children: ReactNode;
527
- /**
528
- * Disables Link
527
+ /**
528
+ * Disables Link
529
529
  */
530
530
  disabled?: boolean;
531
- /**
532
- * @ignore
533
- * Force a Link into a particular css state (for debugging)
531
+ /**
532
+ * @ignore
533
+ * Force a Link into a particular css state (for debugging)
534
534
  */
535
535
  forceState?: "active" | "focus" | "hover";
536
- /**
537
- * The entity to link to (url, email address, telephone number)
536
+ /**
537
+ * The entity to link to (url, email address, telephone number)
538
538
  */
539
539
  href: string;
540
- /**
541
- * Use this if your link is "nested" inside another link
540
+ /**
541
+ * Use this if your link is "nested" inside another link
542
542
  */
543
543
  nested?: boolean;
544
- /**
545
- * An object that will be converted into a search parameter string and appended to
546
- * the `to` prop value
544
+ /**
545
+ * An object that will be converted into a search parameter string and appended to
546
+ * the `to` prop value
547
547
  */
548
548
  params?: LinkURLParameters;
549
- /**
550
- * Type of link to display
551
- *
552
- * * `email` creates a mailto
553
- * * `phone` creates a telephone number
554
- * * `external` will open links in a new window
549
+ /**
550
+ * Type of link to display
551
+ *
552
+ * * `email` creates a mailto
553
+ * * `phone` creates a telephone number
554
+ * * `external` will open links in a new window
555
555
  */
556
556
  type?: LinkTypes;
557
- /**
558
- * Will only display an underline when the Link is in a hover state
557
+ /**
558
+ * Will only display an underline when the Link is in a hover state
559
559
  */
560
560
  underlineOnHover?: boolean;
561
- /**
562
- * Renders a link without any of the default styling applied
561
+ /**
562
+ * Renders a link without any of the default styling applied
563
563
  */
564
564
  unstyled?: boolean;
565
- /**
566
- * The visual type of Link to display
565
+ /**
566
+ * The visual type of Link to display
567
567
  */
568
568
  variant?: "dangerous" | "primary" | "secondary";
569
569
  } & _$react.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
@@ -649,7 +649,7 @@ declare const useKeyPress: (keyFilter: Parameters<typeof useKey>[0]) => KeyPress
649
649
  //#endregion
650
650
  //#region src/hooks/useKeyPressOnce/useKeyPressOnce.d.ts
651
651
  type KeyEventHandler = (keyboardEvent: KeyboardEvent) => unknown;
652
- declare const useKeyPressOnce: (key: Parameters<typeof useKeyPress>[0], keydownHandler?: KeyEventHandler | null | undefined, keyupHandler?: KeyEventHandler | null | undefined) => void;
652
+ declare const useKeyPressOnce: (key: Parameters<typeof useKeyPress>[0], keydownHandler?: KeyEventHandler | null, keyupHandler?: KeyEventHandler | null) => void;
653
653
  //#endregion
654
654
  //#region src/hooks/useLocalStorage/useLocalStorage.d.ts
655
655
  type SetItemType = Storage['setItem'];
@@ -708,37 +708,37 @@ type OnBeforeHideInterface = {
708
708
  message: string;
709
709
  };
710
710
  type ModalBaseContentProps = {
711
- /**
712
- * Class name applied to the modal root
711
+ /**
712
+ * Class name applied to the modal root
713
713
  */
714
714
  className?: string | undefined;
715
- /**
716
- * Render the modal initially in shown state
715
+ /**
716
+ * Render the modal initially in shown state
717
717
  */
718
718
  initialShownState?: boolean;
719
- /**
720
- * The modal can be dismissed via esc button
719
+ /**
720
+ * The modal can be dismissed via esc button
721
721
  */
722
722
  isDismissible?: boolean;
723
- /**
724
- * Callback invoked before the modal is hidden
723
+ /**
724
+ * Callback invoked before the modal is hidden
725
725
  */
726
726
  onBeforeHide?: (() => OnBeforeHideInterface) | undefined;
727
- /**
728
- * Callback invoked when the modal is dismissed
727
+ /**
728
+ * Callback invoked when the modal is dismissed
729
729
  */
730
730
  onHide?: ((...args: unknown[]) => unknown) | undefined;
731
- /**
732
- * Callback invoked when the modal is shown
731
+ /**
732
+ * Callback invoked when the modal is shown
733
733
  */
734
734
  onShow?: ((...args: unknown[]) => unknown) | undefined;
735
- /**
736
- * Optional function that exposes the `hide` function at the call site allowing
737
- * the option to call the `hide` function from outside of this component
735
+ /**
736
+ * Optional function that exposes the `hide` function at the call site allowing
737
+ * the option to call the `hide` function from outside of this component
738
738
  */
739
739
  render?: (attemptHide: () => unknown) => ReactNode;
740
- /**
741
- * function(show, ref) that returns a node to open the modal
740
+ /**
741
+ * function(show, ref) that returns a node to open the modal
742
742
  */
743
743
  toggle?: ((show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode) | undefined;
744
744
  };
@@ -749,96 +749,96 @@ declare const ModalBase: {
749
749
  //#endregion
750
750
  //#region src/components/ActionModal/ActionModal.d.ts
751
751
  type ActionModalProps = ComponentPropsWithoutRef<'div'> & {
752
- /**
753
- * Horizontally align modal to the left, center, or right of the container
752
+ /**
753
+ * Horizontally align modal to the left, center, or right of the container
754
754
  */
755
755
  alignHorizontal?: 'center' | 'left' | 'normal' | 'right';
756
- /**
757
- * Vertically align modal to the top, center, or bottom of the container
756
+ /**
757
+ * Vertically align modal to the top, center, or bottom of the container
758
758
  */
759
759
  alignVertical?: 'bottom' | 'center' | 'normal' | 'top';
760
- /**
761
- * Buttons to be shown at the bottom of the modal
760
+ /**
761
+ * Buttons to be shown at the bottom of the modal
762
762
  */
763
763
  buttons?: ReactNode | ((hide: () => void) => ReactNode);
764
- /**
765
- * Contents of the modal
764
+ /**
765
+ * Contents of the modal
766
766
  */
767
767
  children?: ReactNode;
768
- /**
769
- * Class to be applied to the base element of the modal
768
+ /**
769
+ * Class to be applied to the base element of the modal
770
770
  */
771
771
  className?: string;
772
- /**
773
- * A prop that determines whether the modal will span the entirety of the screen vertically
772
+ /**
773
+ * A prop that determines whether the modal will span the entirety of the screen vertically
774
774
  */
775
775
  fullHeight?: boolean;
776
- /**
777
- * Allows user to override default icon color
776
+ /**
777
+ * Allows user to override default icon color
778
778
  */
779
779
  closeIconColorOverride?: string;
780
- /**
781
- * Increase the zIndex of the Modal, this should be used when calling ActionModal from a Menu
782
- * this will prevent the Menu from staying above the ActionModal
780
+ /**
781
+ * Increase the zIndex of the Modal, this should be used when calling ActionModal from a Menu
782
+ * this will prevent the Menu from staying above the ActionModal
783
783
  */
784
784
  elevated?: boolean;
785
- /**
786
- * Optional illustration to display alongside the modal
785
+ /**
786
+ * Optional illustration to display alongside the modal
787
787
  */
788
788
  illustration?: ReactNode;
789
- /**
790
- * Background color that appears behind the optional illustration
791
- * Can be any css background color or "blue", "brandBlue", "green",
792
- * "pink", "purple", or "yellow" for theme colors
789
+ /**
790
+ * Background color that appears behind the optional illustration
791
+ * Can be any css background color or "blue", "brandBlue", "green",
792
+ * "pink", "purple", or "yellow" for theme colors
793
793
  */
794
794
  illustrationBackgroundColor?: string;
795
- /**
796
- * Render the modal initially in shown state
795
+ /**
796
+ * Render the modal initially in shown state
797
797
  */
798
798
  initialShownState?: boolean;
799
- /**
800
- * Allow the user to close the modal via x button or backdrop click
799
+ /**
800
+ * Allow the user to close the modal via x button or backdrop click
801
801
  */
802
802
  isDismissible?: boolean;
803
- /**
804
- * Callback invoked before the modal is hidden
803
+ /**
804
+ * Callback invoked before the modal is hidden
805
805
  */
806
806
  onBeforeHide?: () => OnBeforeHideInterface;
807
- /**
808
- * Callback invoked when the modal is dismissed
807
+ /**
808
+ * Callback invoked when the modal is dismissed
809
809
  */
810
810
  onHide?: () => void;
811
- /**
812
- * Callback invoked when the modal is shown
811
+ /**
812
+ * Callback invoked when the modal is shown
813
813
  */
814
814
  onShow?: () => void;
815
- /**
816
- * Optional function that exposes the `hide` function at the call site allowing
817
- * the option to call the `hide` function from outside of this component
815
+ /**
816
+ * Optional function that exposes the `hide` function at the call site allowing
817
+ * the option to call the `hide` function from outside of this component
818
818
  */
819
819
  render?: (hide: (event?: MouseEvent) => void) => ReactNode;
820
- /**
821
- * Title to display in the modal
820
+ /**
821
+ * Title to display in the modal
822
822
  */
823
823
  title: string;
824
- /**
825
- * function(show, ref) that returns a node to open the modal
824
+ /**
825
+ * function(show, ref) that returns a node to open the modal
826
826
  */
827
827
  toggle?: (show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode;
828
- /**
829
- * The css width property of the modal. Ex - 'max-content', '532px', '100%', etc
828
+ /**
829
+ * The css width property of the modal. Ex - 'max-content', '532px', '100%', etc
830
830
  */
831
831
  width?: string;
832
832
  };
833
- /**
834
- * @deprecated Please use Modal component, see [documentation](?path=/docs/components-modal--docs).
835
- *
836
- * #### Why ActionModal is being deprecated
837
- * ActionModal's API tightly couples the modal itself with the button or element that toggles it. This makes it difficult to
838
- * implement in several scenarios (such as within a Menu) or if it needs to be programatically opened by an external action.
839
- *
840
- * [Modal](?path=/docs/components-modal--docs) allows for a separate state control to toggle its visibility and is also more composable
841
- * allowing for more variation.
833
+ /**
834
+ * @deprecated Please use Modal component, see [documentation](?path=/docs/components-modal--docs).
835
+ *
836
+ * #### Why ActionModal is being deprecated
837
+ * ActionModal's API tightly couples the modal itself with the button or element that toggles it. This makes it difficult to
838
+ * implement in several scenarios (such as within a Menu) or if it needs to be programatically opened by an external action.
839
+ *
840
+ * [Modal](?path=/docs/components-modal--docs) allows for a separate state control to toggle its visibility and is also more composable
841
+ * allowing for more variation.
842
842
  */
843
843
  declare const ActionModal: {
844
844
  ({
@@ -869,26 +869,26 @@ declare const ActionModal: {
869
869
  //#region src/components/Avatar/Avatar.d.ts
870
870
  type AvatarInstanceType = 'image' | 'initials';
871
871
  type AvatarProps = ComponentPropsWithoutRef<'div'> & {
872
- /**
873
- * The height and width of the avatar
872
+ /**
873
+ * The height and width of the avatar
874
874
  */
875
875
  heightAndWidth?: number;
876
- /**
877
- * The URL of the image to display
876
+ /**
877
+ * The URL of the image to display
878
878
  */
879
879
  imageUrl?: string | null;
880
- /**
881
- * Initials to display if no image is provided
882
- *
883
- * _note: only first initial shown regardless of characters provided_
880
+ /**
881
+ * Initials to display if no image is provided
882
+ *
883
+ * _note: only first initial shown regardless of characters provided_
884
884
  */
885
885
  initials?: string | null;
886
- /**
887
- * A string that will deterministicly set the background color of the avatar
886
+ /**
887
+ * A string that will deterministicly set the background color of the avatar
888
888
  */
889
889
  name?: string | null;
890
- /**
891
- * A callback that is invoked after the image has loaded or failed to load
890
+ /**
891
+ * A callback that is invoked after the image has loaded or failed to load
892
892
  */
893
893
  onImageLoad?: (avatarType: AvatarInstanceType) => void;
894
894
  };
@@ -918,24 +918,24 @@ declare const alignHorizontalMap: {
918
918
  right: string;
919
919
  };
920
920
  type BackdropProps = ComponentPropsWithoutRef<'div'> & {
921
- /**
922
- * Optional prop to align the child content along the horizontal axis
921
+ /**
922
+ * Optional prop to align the child content along the horizontal axis
923
923
  */
924
924
  alignHorizontal?: keyof typeof alignHorizontalMap;
925
- /**
926
- * Optional prop to align the child content along the vertical axis
925
+ /**
926
+ * Optional prop to align the child content along the vertical axis
927
927
  */
928
928
  alignVertical?: keyof typeof alignVerticalMap;
929
- /**
930
- * Color of the backdrop
929
+ /**
930
+ * Color of the backdrop
931
931
  */
932
932
  backgroundColor?: string;
933
- /**
934
- * Pass an arbitrary child node
933
+ /**
934
+ * Pass an arbitrary child node
935
935
  */
936
936
  children?: ReactNode;
937
- /**
938
- * increase the z-index (workaround for ActionModals called within Menu)
937
+ /**
938
+ * increase the z-index (workaround for ActionModals called within Menu)
939
939
  */
940
940
  elevated?: boolean;
941
941
  };
@@ -957,61 +957,61 @@ type OverflowObject = {
957
957
  vertical: string;
958
958
  };
959
959
  type BackgroundImageProps = Omit<ComponentPropsWithoutRef<'img'>, 'src'> & {
960
- /**
961
- * The content that will be rendered inside
960
+ /**
961
+ * The content that will be rendered inside
962
962
  */
963
963
  children?: ReactNode;
964
- /**
965
- * Sets whether a background image's position is fixed within the viewport,
966
- * or scrolls with its containing block. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-attachment).
964
+ /**
965
+ * Sets whether a background image's position is fixed within the viewport,
966
+ * or scrolls with its containing block. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-attachment).
967
967
  */
968
968
  attachment?: string;
969
- /**
970
- * Sets whether an element's background extends underneath its border box,
971
- * padding box, or content box. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip).
969
+ /**
970
+ * Sets whether an element's background extends underneath its border box,
971
+ * padding box, or content box. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip).
972
972
  */
973
973
  clip?: string;
974
- /**
975
- * Color (as hex) of the component
974
+ /**
975
+ * Color (as hex) of the component
976
976
  */
977
977
  color?: string | undefined;
978
- /**
979
- * Height of the component
978
+ /**
979
+ * Height of the component
980
980
  */
981
981
  height?: string;
982
- /**
983
- * Sets the background's origin: from the border start, inside the border, or inside the padding.
984
- * _Note: origin is ignored when attachment is `fixed`._
985
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-origin).
982
+ /**
983
+ * Sets the background's origin: from the border start, inside the border, or inside the padding.
984
+ * _Note: origin is ignored when attachment is `fixed`._
985
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-origin).
986
986
  */
987
987
  origin?: string;
988
- /**
989
- * Sets the desired behavior for an element's overflow (i.e. when an element's content is
990
- * too big to fit in its block formatting context).
991
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
988
+ /**
989
+ * Sets the desired behavior for an element's overflow (i.e. when an element's content is
990
+ * too big to fit in its block formatting context).
991
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
992
992
  */
993
993
  overflow?: OverflowObject | string;
994
- /**
995
- * Sets the initial position for each image; relative to the position layer
996
- * set by origin. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position).
994
+ /**
995
+ * Sets the initial position for each image; relative to the position layer
996
+ * set by origin. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position).
997
997
  */
998
998
  position?: string;
999
- /**
1000
- * Sets how background images are repeated.
1001
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat).
999
+ /**
1000
+ * Sets how background images are repeated.
1001
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat).
1002
1002
  */
1003
1003
  repeat?: string;
1004
- /**
1005
- * Sets the size of the element's background image.
1006
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size).
1004
+ /**
1005
+ * Sets the size of the element's background image.
1006
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size).
1007
1007
  */
1008
1008
  size?: string;
1009
- /**
1010
- * URL(s) to image file
1009
+ /**
1010
+ * URL(s) to image file
1011
1011
  */
1012
1012
  src?: string[] | string;
1013
- /**
1014
- * Width of the component
1013
+ /**
1014
+ * Width of the component
1015
1015
  */
1016
1016
  width?: string;
1017
1017
  };
@@ -1156,16 +1156,16 @@ type IconNameType = keyof typeof iconMap;
1156
1156
  //#region src/components/Badge/Badge.d.ts
1157
1157
  type BadgeColorScheme = 'brandBlue' | 'error' | 'green' | 'grey' | 'orange' | 'pink' | 'purple' | 'red' | 'success' | 'warning' | 'yellow';
1158
1158
  type BadgeProps = ComponentPropsWithoutRef<'div'> & {
1159
- /**
1160
- * The color scheme to use for the badge
1159
+ /**
1160
+ * The color scheme to use for the badge
1161
1161
  */
1162
1162
  colorScheme?: BadgeColorScheme;
1163
- /**
1164
- * The icon to display in the badge
1163
+ /**
1164
+ * The icon to display in the badge
1165
1165
  */
1166
1166
  icon?: IconNameType;
1167
- /**
1168
- * The text to display in the badge
1167
+ /**
1168
+ * The text to display in the badge
1169
1169
  */
1170
1170
  label: string;
1171
1171
  };
@@ -1181,16 +1181,16 @@ declare const Badge: {
1181
1181
  //#endregion
1182
1182
  //#region src/components/Banner/Banner.d.ts
1183
1183
  type BannerProps = ComponentPropsWithoutRef<'div'> & {
1184
- /**
1185
- * color string
1184
+ /**
1185
+ * color string
1186
1186
  */
1187
1187
  backgroundColor?: string;
1188
- /**
1189
- * Pass an arbitrary child node
1188
+ /**
1189
+ * Pass an arbitrary child node
1190
1190
  */
1191
1191
  children?: ReactNode;
1192
- /**
1193
- * icon name from the icon library to be displayed on left side of banner
1192
+ /**
1193
+ * icon name from the icon library to be displayed on left side of banner
1194
1194
  */
1195
1195
  icon?: ReactNode;
1196
1196
  };
@@ -1227,178 +1227,178 @@ type Gap = {
1227
1227
  row: number | string;
1228
1228
  };
1229
1229
  type BoxProps = ComponentPropsWithoutRef<'div'> & {
1230
- /**
1231
- * Specifies how the browser distributes space between and around
1232
- * items along the cross-axis of their container; has no effect on
1233
- * single line flexible boxes
1230
+ /**
1231
+ * Specifies how the browser distributes space between and around
1232
+ * items along the cross-axis of their container; has no effect on
1233
+ * single line flexible boxes
1234
1234
  */
1235
1235
  alignContent?: 'around' | 'between' | 'center' | 'end' | 'start' | 'stretch';
1236
- /**
1237
- * Specifies how the browser distributes space between and around
1238
- * items along the cross-axis of their container; the difference
1239
- * to the alignContent prop is that alignItems specifies the
1240
- * alignment of the items within the current container's line,
1241
- * whereas alignContent specifies the alignment of the lines themselves
1236
+ /**
1237
+ * Specifies how the browser distributes space between and around
1238
+ * items along the cross-axis of their container; the difference
1239
+ * to the alignContent prop is that alignItems specifies the
1240
+ * alignment of the items within the current container's line,
1241
+ * whereas alignContent specifies the alignment of the lines themselves
1242
1242
  */
1243
1243
  alignItems?: 'baseline' | 'center' | 'end' | 'start' | 'stretch';
1244
- /**
1245
- * Specifies how the browser aligns items of the current line, overriding the
1246
- * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
1247
- * then alignSelf is ignored
1248
- *
1249
- * *Note: only works for nested `<Box />`*
1244
+ /**
1245
+ * Specifies how the browser aligns items of the current line, overriding the
1246
+ * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
1247
+ * then alignSelf is ignored
1248
+ *
1249
+ * *Note: only works for nested `<Box />`*
1250
1250
  */
1251
1251
  alignSelf?: 'auto' | 'baseline' | 'center' | 'end' | 'start' | 'stretch';
1252
- /**
1253
- * Specifies the initial main size of an item
1254
- *
1255
- * *Note: only works for nested `<Box />`*
1252
+ /**
1253
+ * Specifies the initial main size of an item
1254
+ *
1255
+ * *Note: only works for nested `<Box />`*
1256
1256
  */
1257
1257
  basis?: number | string;
1258
- /**
1259
- * Pass an arbitrary child node
1258
+ /**
1259
+ * Pass an arbitrary child node
1260
1260
  */
1261
1261
  children?: ReactNode;
1262
- /**
1263
- * Specifies the main axis of the container
1262
+ /**
1263
+ * Specifies the main axis of the container
1264
1264
  */
1265
1265
  direction?: 'column-reverse' | 'column' | 'row-reverse' | 'row';
1266
- /**
1267
- * Specifies whether the width and/or height should fill the container
1266
+ /**
1267
+ * Specifies whether the width and/or height should fill the container
1268
1268
  */
1269
1269
  fill?: boolean | 'horizontal' | 'vertical';
1270
- /**
1271
- * Specifies whether the width and/or height should fill the viewport
1270
+ /**
1271
+ * Specifies whether the width and/or height should fill the viewport
1272
1272
  */
1273
1273
  fillViewport?: boolean | 'horizontal' | 'vertical';
1274
- /**
1275
- * Specifies the gaps (gutters) between rows and columns
1274
+ /**
1275
+ * Specifies the gaps (gutters) between rows and columns
1276
1276
  */
1277
1277
  gap?: Gap | number | string;
1278
- /**
1279
- * Specifies what amount of space inside the flex container the item should take up
1280
- *
1281
- * *Note: only works for nested `<Box />`*
1278
+ /**
1279
+ * Specifies what amount of space inside the flex container the item should take up
1280
+ *
1281
+ * *Note: only works for nested `<Box />`*
1282
1282
  */
1283
1283
  grow?: number;
1284
- /**
1285
- * Make Layout behave like an inline element but still lay out its content according to flexbox model
1284
+ /**
1285
+ * Make Layout behave like an inline element but still lay out its content according to flexbox model
1286
1286
  */
1287
1287
  inline?: boolean;
1288
- /**
1289
- * Specifies how the browser distributes space between and around
1290
- * items along the main axis of their container
1288
+ /**
1289
+ * Specifies how the browser distributes space between and around
1290
+ * items along the main axis of their container
1291
1291
  */
1292
1292
  justifyContent?: 'around' | 'between' | 'center' | 'end' | 'evenly' | 'start';
1293
- /**
1294
- * Specifies the order used to lay out an item in its container. Items within the same
1295
- * container are rendered in ascending order according to their order values.
1296
- * Elements with the _same_ order value are rendered in the order in which they appear in code
1297
- *
1298
- * *Note: only works for nested `<Box />`*
1293
+ /**
1294
+ * Specifies the order used to lay out an item in its container. Items within the same
1295
+ * container are rendered in ascending order according to their order values.
1296
+ * Elements with the _same_ order value are rendered in the order in which they appear in code
1297
+ *
1298
+ * *Note: only works for nested `<Box />`*
1299
1299
  */
1300
1300
  order?: number | 'inherit' | 'initial' | 'unset';
1301
- /**
1302
- * The DOM tag to use for the element
1301
+ /**
1302
+ * The DOM tag to use for the element
1303
1303
  */
1304
1304
  renderAs?: keyof JSX.IntrinsicElements;
1305
- /**
1306
- * Specifies how items will shrink inside the container when the default size of
1307
- * items is larger than their container
1308
- *
1309
- * *Note: only works for nested `<Box />`*
1305
+ /**
1306
+ * Specifies how items will shrink inside the container when the default size of
1307
+ * items is larger than their container
1308
+ *
1309
+ * *Note: only works for nested `<Box />`*
1310
1310
  */
1311
1311
  shrink?: number;
1312
- /**
1313
- * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
1312
+ /**
1313
+ * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
1314
1314
  */
1315
1315
  wrapItems?: boolean;
1316
1316
  };
1317
1317
  declare const Box: _$react.ForwardRefExoticComponent<Omit<_$react.DetailedHTMLProps<_$react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
1318
- /**
1319
- * Specifies how the browser distributes space between and around
1320
- * items along the cross-axis of their container; has no effect on
1321
- * single line flexible boxes
1318
+ /**
1319
+ * Specifies how the browser distributes space between and around
1320
+ * items along the cross-axis of their container; has no effect on
1321
+ * single line flexible boxes
1322
1322
  */
1323
1323
  alignContent?: "around" | "between" | "center" | "end" | "start" | "stretch";
1324
- /**
1325
- * Specifies how the browser distributes space between and around
1326
- * items along the cross-axis of their container; the difference
1327
- * to the alignContent prop is that alignItems specifies the
1328
- * alignment of the items within the current container's line,
1329
- * whereas alignContent specifies the alignment of the lines themselves
1324
+ /**
1325
+ * Specifies how the browser distributes space between and around
1326
+ * items along the cross-axis of their container; the difference
1327
+ * to the alignContent prop is that alignItems specifies the
1328
+ * alignment of the items within the current container's line,
1329
+ * whereas alignContent specifies the alignment of the lines themselves
1330
1330
  */
1331
1331
  alignItems?: "baseline" | "center" | "end" | "start" | "stretch";
1332
- /**
1333
- * Specifies how the browser aligns items of the current line, overriding the
1334
- * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
1335
- * then alignSelf is ignored
1336
- *
1337
- * *Note: only works for nested `<Box />`*
1332
+ /**
1333
+ * Specifies how the browser aligns items of the current line, overriding the
1334
+ * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
1335
+ * then alignSelf is ignored
1336
+ *
1337
+ * *Note: only works for nested `<Box />`*
1338
1338
  */
1339
1339
  alignSelf?: "auto" | "baseline" | "center" | "end" | "start" | "stretch";
1340
- /**
1341
- * Specifies the initial main size of an item
1342
- *
1343
- * *Note: only works for nested `<Box />`*
1340
+ /**
1341
+ * Specifies the initial main size of an item
1342
+ *
1343
+ * *Note: only works for nested `<Box />`*
1344
1344
  */
1345
1345
  basis?: number | string;
1346
- /**
1347
- * Pass an arbitrary child node
1346
+ /**
1347
+ * Pass an arbitrary child node
1348
1348
  */
1349
1349
  children?: ReactNode;
1350
- /**
1351
- * Specifies the main axis of the container
1350
+ /**
1351
+ * Specifies the main axis of the container
1352
1352
  */
1353
1353
  direction?: "column-reverse" | "column" | "row-reverse" | "row";
1354
- /**
1355
- * Specifies whether the width and/or height should fill the container
1354
+ /**
1355
+ * Specifies whether the width and/or height should fill the container
1356
1356
  */
1357
1357
  fill?: boolean | "horizontal" | "vertical";
1358
- /**
1359
- * Specifies whether the width and/or height should fill the viewport
1358
+ /**
1359
+ * Specifies whether the width and/or height should fill the viewport
1360
1360
  */
1361
1361
  fillViewport?: boolean | "horizontal" | "vertical";
1362
- /**
1363
- * Specifies the gaps (gutters) between rows and columns
1362
+ /**
1363
+ * Specifies the gaps (gutters) between rows and columns
1364
1364
  */
1365
1365
  gap?: Gap | number | string;
1366
- /**
1367
- * Specifies what amount of space inside the flex container the item should take up
1368
- *
1369
- * *Note: only works for nested `<Box />`*
1366
+ /**
1367
+ * Specifies what amount of space inside the flex container the item should take up
1368
+ *
1369
+ * *Note: only works for nested `<Box />`*
1370
1370
  */
1371
1371
  grow?: number;
1372
- /**
1373
- * Make Layout behave like an inline element but still lay out its content according to flexbox model
1372
+ /**
1373
+ * Make Layout behave like an inline element but still lay out its content according to flexbox model
1374
1374
  */
1375
1375
  inline?: boolean;
1376
- /**
1377
- * Specifies how the browser distributes space between and around
1378
- * items along the main axis of their container
1376
+ /**
1377
+ * Specifies how the browser distributes space between and around
1378
+ * items along the main axis of their container
1379
1379
  */
1380
1380
  justifyContent?: "around" | "between" | "center" | "end" | "evenly" | "start";
1381
- /**
1382
- * Specifies the order used to lay out an item in its container. Items within the same
1383
- * container are rendered in ascending order according to their order values.
1384
- * Elements with the _same_ order value are rendered in the order in which they appear in code
1385
- *
1386
- * *Note: only works for nested `<Box />`*
1381
+ /**
1382
+ * Specifies the order used to lay out an item in its container. Items within the same
1383
+ * container are rendered in ascending order according to their order values.
1384
+ * Elements with the _same_ order value are rendered in the order in which they appear in code
1385
+ *
1386
+ * *Note: only works for nested `<Box />`*
1387
1387
  */
1388
1388
  order?: number | "inherit" | "initial" | "unset";
1389
- /**
1390
- * The DOM tag to use for the element
1389
+ /**
1390
+ * The DOM tag to use for the element
1391
1391
  */
1392
1392
  renderAs?: keyof JSX.IntrinsicElements;
1393
- /**
1394
- * Specifies how items will shrink inside the container when the default size of
1395
- * items is larger than their container
1396
- *
1397
- * *Note: only works for nested `<Box />`*
1393
+ /**
1394
+ * Specifies how items will shrink inside the container when the default size of
1395
+ * items is larger than their container
1396
+ *
1397
+ * *Note: only works for nested `<Box />`*
1398
1398
  */
1399
1399
  shrink?: number;
1400
- /**
1401
- * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
1400
+ /**
1401
+ * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
1402
1402
  */
1403
1403
  wrapItems?: boolean;
1404
1404
  } & _$react.RefAttributes<HTMLDivElement>>;
@@ -1406,78 +1406,78 @@ declare const Box: _$react.ForwardRefExoticComponent<Omit<_$react.DetailedHTMLPr
1406
1406
  //#region src/components/Button/Button.d.ts
1407
1407
  type TextAlignValues = 'center' | 'left' | 'right';
1408
1408
  type ButtonProps = ComponentPropsWithRef<'button'> & {
1409
- /**
1410
- * Text that appears inside of the button *THIS WILL OVERRIDE THE LABEL PROP*
1409
+ /**
1410
+ * Text that appears inside of the button *THIS WILL OVERRIDE THE LABEL PROP*
1411
1411
  */
1412
1412
  children?: ReactNode;
1413
- /**
1414
- * Allows user to override default button colors
1413
+ /**
1414
+ * Allows user to override default button colors
1415
1415
  */
1416
1416
  colorOverride?: string;
1417
- /**
1418
- * Disables button
1417
+ /**
1418
+ * Disables button
1419
1419
  */
1420
1420
  disabled?: boolean;
1421
- /**
1422
- * @ignore
1423
- * Force a button into a particular css state (for debugging)
1421
+ /**
1422
+ * @ignore
1423
+ * Force a button into a particular css state (for debugging)
1424
1424
  */
1425
1425
  forceState?: 'active' | 'focus' | 'hover' | undefined;
1426
- /**
1427
- * Is the button full-width?
1426
+ /**
1427
+ * Is the button full-width?
1428
1428
  */
1429
1429
  fullWidth?: boolean;
1430
- /**
1431
- * An SVG component
1430
+ /**
1431
+ * An SVG component
1432
1432
  */
1433
1433
  icon?: ReactNode;
1434
- /**
1435
- * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
1434
+ /**
1435
+ * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
1436
1436
  */
1437
1437
  iconName?: keyof typeof iconMap;
1438
- /**
1439
- * Should the icon appear at the start of the button or the end?
1438
+ /**
1439
+ * Should the icon appear at the start of the button or the end?
1440
1440
  */
1441
1441
  iconPosition?: 'end' | 'start';
1442
- /**
1443
- * Show a spinner when the button is in a loading state
1442
+ /**
1443
+ * Show a spinner when the button is in a loading state
1444
1444
  */
1445
1445
  isLoading?: boolean;
1446
- /**
1447
- * Text that appears inside the button
1446
+ /**
1447
+ * Text that appears inside the button
1448
1448
  */
1449
1449
  label?: string;
1450
- /**
1451
- * Should the label wrap if the button container is too narrow to fit the label text on one line
1452
- * @deprecated Apply white-space styling as needed
1450
+ /**
1451
+ * Should the label wrap if the button container is too narrow to fit the label text on one line
1452
+ * @deprecated Apply white-space styling as needed
1453
1453
  */
1454
1454
  labelWrap?: boolean;
1455
- /**
1456
- * Provides a button without any styling (useful for wrapping another element)
1455
+ /**
1456
+ * Provides a button without any styling (useful for wrapping another element)
1457
1457
  */
1458
1458
  noStyle?: boolean;
1459
- /**
1460
- * Callback function invoked when the button is clicked
1459
+ /**
1460
+ * Callback function invoked when the button is clicked
1461
1461
  */
1462
1462
  onClick?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
1463
- /**
1464
- * The size of button to display
1463
+ /**
1464
+ * The size of button to display
1465
1465
  */
1466
1466
  size?: 'lg' | 'md' | 'sm';
1467
- /**
1468
- * If true then rounded corners will be squared
1467
+ /**
1468
+ * If true then rounded corners will be squared
1469
1469
  */
1470
1470
  square?: boolean;
1471
- /**
1472
- * Alignment of the button label
1471
+ /**
1472
+ * Alignment of the button label
1473
1473
  */
1474
1474
  textAlign?: TextAlignValues;
1475
- /**
1476
- * The type of button element that should be rendered
1475
+ /**
1476
+ * The type of button element that should be rendered
1477
1477
  */
1478
1478
  type?: 'button' | 'reset' | 'submit';
1479
- /**
1480
- * The visual type of button to display
1479
+ /**
1480
+ * The visual type of button to display
1481
1481
  */
1482
1482
  variant?: 'dangerous' | 'primary' | 'secondary' | 'tertiary';
1483
1483
  };
@@ -1485,16 +1485,16 @@ declare const Button: _$react.ForwardRefExoticComponent<Omit<ButtonProps, "ref">
1485
1485
  //#endregion
1486
1486
  //#region src/components/ButtonGroup/ButtonGroup.d.ts
1487
1487
  type ButtonGroupProps = ComponentPropsWithoutRef<'div'> & {
1488
- /**
1489
- * Align buttons to the left or right of their container
1488
+ /**
1489
+ * Align buttons to the left or right of their container
1490
1490
  */
1491
1491
  align?: 'center' | 'left' | 'right';
1492
- /**
1493
- * Buttons that will be rendered in grouping
1492
+ /**
1493
+ * Buttons that will be rendered in grouping
1494
1494
  */
1495
1495
  children?: ReactNode;
1496
- /**
1497
- * Force ButtonGroup to fill the width of it's container
1496
+ /**
1497
+ * Force ButtonGroup to fill the width of it's container
1498
1498
  */
1499
1499
  fullWidth?: boolean;
1500
1500
  };
@@ -1510,148 +1510,148 @@ declare const ButtonGroup: {
1510
1510
  //#endregion
1511
1511
  //#region src/components/ButtonLink/ButtonLink.d.ts
1512
1512
  type ButtonLinkProps = ComponentPropsWithRef<'a'> & {
1513
- /**
1514
- * A Promise to invoke before navigating to location.
1515
- * _Caution: if used with `external` type prop a new window will **not** be opened_
1513
+ /**
1514
+ * A Promise to invoke before navigating to location.
1515
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
1516
1516
  */
1517
1517
  beforeAction?: (() => Promise<void>) | (() => void);
1518
- /**
1519
- * The content that will be rendered inside the button
1518
+ /**
1519
+ * The content that will be rendered inside the button
1520
1520
  */
1521
1521
  children?: ReactNode;
1522
- /**
1523
- * Option CSS color string
1522
+ /**
1523
+ * Option CSS color string
1524
1524
  */
1525
1525
  colorOverride?: string;
1526
- /**
1527
- * Disables Link
1526
+ /**
1527
+ * Disables Link
1528
1528
  */
1529
1529
  disabled?: boolean;
1530
- /**
1531
- * @ignore
1532
- * Force a Link into a particular css state (for debugging)
1530
+ /**
1531
+ * @ignore
1532
+ * Force a Link into a particular css state (for debugging)
1533
1533
  */
1534
1534
  forceState?: 'active' | 'focus' | 'hover';
1535
- /**
1536
- * Is the button full-width?
1535
+ /**
1536
+ * Is the button full-width?
1537
1537
  */
1538
1538
  fullWidth?: boolean;
1539
- /**
1540
- * The entity to link to (url, email address, telephone number)
1539
+ /**
1540
+ * The entity to link to (url, email address, telephone number)
1541
1541
  */
1542
1542
  href: string;
1543
- /**
1544
- * An SVG component
1543
+ /**
1544
+ * An SVG component
1545
1545
  */
1546
1546
  icon?: ReactNode;
1547
- /**
1548
- * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
1547
+ /**
1548
+ * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
1549
1549
  */
1550
1550
  iconName?: keyof typeof iconMap;
1551
- /**
1552
- * Should the icon appear at the start of the button or the end?
1551
+ /**
1552
+ * Should the icon appear at the start of the button or the end?
1553
1553
  */
1554
1554
  iconPosition?: 'end' | 'start';
1555
- /**
1556
- * Text that appears inside the button
1555
+ /**
1556
+ * Text that appears inside the button
1557
1557
  */
1558
1558
  label?: string;
1559
- /**
1560
- * Should the label wrap if the button container is too narrow to fit the label text on one line
1559
+ /**
1560
+ * Should the label wrap if the button container is too narrow to fit the label text on one line
1561
1561
  */
1562
1562
  labelWrap?: boolean;
1563
- /**
1564
- * An object that will be converted into a search parameter string and appended to
1565
- * the `to` prop value
1563
+ /**
1564
+ * An object that will be converted into a search parameter string and appended to
1565
+ * the `to` prop value
1566
1566
  */
1567
1567
  params?: Record<string, string>;
1568
- /**
1569
- * The size of button to display
1568
+ /**
1569
+ * The size of button to display
1570
1570
  */
1571
1571
  size?: 'lg' | 'md' | 'sm';
1572
- /**
1573
- * If true, rounded corners are disabled
1572
+ /**
1573
+ * If true, rounded corners are disabled
1574
1574
  */
1575
1575
  square?: boolean;
1576
- /**
1577
- * Alignment of the button label
1576
+ /**
1577
+ * Alignment of the button label
1578
1578
  */
1579
1579
  textAlign?: TextAlignValues;
1580
- /**
1581
- * Type of link to display
1582
- *
1583
- * * `email` creates a mailto
1584
- * * `phone` creates a telephone number
1585
- * * `external` will open links in a new window
1580
+ /**
1581
+ * Type of link to display
1582
+ *
1583
+ * * `email` creates a mailto
1584
+ * * `phone` creates a telephone number
1585
+ * * `external` will open links in a new window
1586
1586
  */
1587
1587
  type?: 'default' | 'email' | 'external' | 'phone';
1588
- /**
1589
- * The visual type of button to display
1588
+ /**
1589
+ * The visual type of button to display
1590
1590
  */
1591
1591
  variant?: 'dangerous' | 'primary' | 'secondary' | 'tertiary';
1592
1592
  };
1593
- /**
1594
- * The `ButtonLink` component is useful for getting the functionality of a
1595
- * `Link` with the styling of a `Button`.
1596
- *
1597
- * A useful heuristic for using this component: Do you have an `href`? Some of the advantages are having a right-click
1598
- * context menu available opening a new tab, and copying the URL.
1599
- *
1600
- * **Note:** the props table below is incomplete; please
1601
- * refer to [Link](?path=/docs/link--link-stories) for additional props.
1593
+ /**
1594
+ * The `ButtonLink` component is useful for getting the functionality of a
1595
+ * `Link` with the styling of a `Button`.
1596
+ *
1597
+ * A useful heuristic for using this component: Do you have an `href`? Some of the advantages are having a right-click
1598
+ * context menu available opening a new tab, and copying the URL.
1599
+ *
1600
+ * **Note:** the props table below is incomplete; please
1601
+ * refer to [Link](?path=/docs/link--link-stories) for additional props.
1602
1602
  */
1603
1603
  declare const ButtonLink: _$react.ForwardRefExoticComponent<Omit<ButtonLinkProps, "ref"> & _$react.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
1604
1604
  //#endregion
1605
1605
  //#region src/components/Checkbox/Checkbox.d.ts
1606
1606
  type CheckboxProps = Omit<ComponentPropsWithRef<'label'>, 'onChange'> & {
1607
- /**
1608
- * Indicates the state of the checkbox
1607
+ /**
1608
+ * Indicates the state of the checkbox
1609
1609
  */
1610
1610
  checked?: boolean;
1611
- /**
1612
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
1611
+ /**
1612
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
1613
1613
  */
1614
1614
  direction?: 'column' | 'row';
1615
- /**
1616
- * Disables checkbox
1615
+ /**
1616
+ * Disables checkbox
1617
1617
  */
1618
1618
  disabled?: boolean;
1619
- /**
1620
- * @ignore
1621
- * Force a Checkbox into a particular css state (for debugging)
1619
+ /**
1620
+ * @ignore
1621
+ * Force a Checkbox into a particular css state (for debugging)
1622
1622
  */
1623
1623
  forceState?: 'focus' | 'hover';
1624
- /**
1625
- * Indicates that there is an error with the input
1624
+ /**
1625
+ * Indicates that there is an error with the input
1626
1626
  */
1627
1627
  hasError?: boolean;
1628
- /**
1629
- * Provides an ID for the checkbox
1628
+ /**
1629
+ * Provides an ID for the checkbox
1630
1630
  */
1631
1631
  id?: string;
1632
- /**
1633
- * The label for the checkbox
1632
+ /**
1633
+ * The label for the checkbox
1634
1634
  */
1635
1635
  label?: JSX.Element | string | undefined;
1636
- /**
1637
- * The description for the checkbox
1636
+ /**
1637
+ * The description for the checkbox
1638
1638
  */
1639
1639
  labelDescription?: JSX.Element | string | undefined;
1640
- /**
1641
- * Should match the ID attribute of the checkbox.
1642
- * Can be used to group together multiple checkboxes
1640
+ /**
1641
+ * Should match the ID attribute of the checkbox.
1642
+ * Can be used to group together multiple checkboxes
1643
1643
  */
1644
1644
  name?: string;
1645
- /**
1646
- * Callback function invoked when the checkbox value changes
1645
+ /**
1646
+ * Callback function invoked when the checkbox value changes
1647
1647
  */
1648
1648
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
1649
- /**
1650
- * Make Input a required element
1649
+ /**
1650
+ * Make Input a required element
1651
1651
  */
1652
1652
  required?: boolean;
1653
- /**
1654
- * The value attribute of the checkbox
1653
+ /**
1654
+ * The value attribute of the checkbox
1655
1655
  */
1656
1656
  value?: string;
1657
1657
  };
@@ -1662,47 +1662,47 @@ type CheckboxPropsWithName = Omit<CheckboxProps, 'name'> & {
1662
1662
  name: string;
1663
1663
  };
1664
1664
  type CheckboxGroupProps = Omit<ComponentPropsWithoutRef<'div'>, 'onChange'> & {
1665
- /**
1666
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
1665
+ /**
1666
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
1667
1667
  */
1668
1668
  direction?: 'column' | 'row';
1669
- /**
1670
- * Whether CheckboxGroup is disabled
1669
+ /**
1670
+ * Whether CheckboxGroup is disabled
1671
1671
  */
1672
1672
  disabled?: boolean;
1673
- /**
1674
- * Error message to be displayed
1673
+ /**
1674
+ * Error message to be displayed
1675
1675
  */
1676
1676
  error?: string | undefined;
1677
- /**
1678
- * The label for the form field
1677
+ /**
1678
+ * The label for the form field
1679
1679
  */
1680
1680
  label?: JSX.Element | string | undefined;
1681
- /**
1682
- * The hint/helper text under the label
1681
+ /**
1682
+ * The hint/helper text under the label
1683
1683
  */
1684
1684
  labelDescription?: JSX.Element | string | undefined;
1685
- /**
1686
- * Props that are passed through to the underlying `<Label>` component
1685
+ /**
1686
+ * Props that are passed through to the underlying `<Label>` component
1687
1687
  */
1688
1688
  labelProps?: {
1689
1689
  disabled?: boolean;
1690
1690
  screenReaderOnly?: boolean;
1691
1691
  };
1692
- /**
1693
- * Name of the form element
1692
+ /**
1693
+ * Name of the form element
1694
1694
  */
1695
1695
  name: string;
1696
- /**
1697
- * Callback function invoked when the value changes
1696
+ /**
1697
+ * Callback function invoked when the value changes
1698
1698
  */
1699
1699
  onChange?: (event: ChangeEvent<HTMLInputElement>, name: string) => unknown;
1700
- /**
1701
- * Array of checkbox attributes
1700
+ /**
1701
+ * Array of checkbox attributes
1702
1702
  */
1703
1703
  options: CheckboxPropsWithName[];
1704
- /**
1705
- * Currently selected checkbox value
1704
+ /**
1705
+ * Currently selected checkbox value
1706
1706
  */
1707
1707
  value?: string[] | boolean | undefined;
1708
1708
  };
@@ -1725,43 +1725,43 @@ declare const CheckboxGroup: {
1725
1725
  //#endregion
1726
1726
  //#region src/components/ClickArea/ClickArea.d.ts
1727
1727
  type ClickAreaProps = ComponentPropsWithRef<'div'> & {
1728
- /**
1729
- * Supply an element or Component to render as the root compoennt (default is div)
1728
+ /**
1729
+ * Supply an element or Component to render as the root compoennt (default is div)
1730
1730
  */
1731
1731
  renderAs?: ElementType;
1732
- /**
1733
- * The content within the clickarea
1732
+ /**
1733
+ * The content within the clickarea
1734
1734
  */
1735
1735
  children: ReactNode;
1736
- /**
1737
- * If provided, this click event happens instead of the target ref's click event
1736
+ /**
1737
+ * If provided, this click event happens instead of the target ref's click event
1738
1738
  */
1739
1739
  onClick?: (event: Event) => void;
1740
- /**
1741
- * A ref to the element within chldren that will be used as the target of the click event
1742
- * Should typically be a button or link
1740
+ /**
1741
+ * A ref to the element within chldren that will be used as the target of the click event
1742
+ * Should typically be a button or link
1743
1743
  */
1744
1744
  targetRef: RefObject<HTMLElement | null>;
1745
1745
  };
1746
- /**
1747
- * ClickArea is useful when you want an entire element to be clickable, such as a card or an item in a list. Making the
1748
- * entire element clickable provides a better click target for users, especially on mobile devices. The problem with this is
1749
- * clickable divs are not accessible or tabbable. Using a `button` or `a` tag causes both styling and screenreader problems.
1750
- *
1751
- * To solve these issues, `ClickArea` maps a click event on the container element to a click event on a button or link within
1752
- * it, via a ref. Assistive devices can utilize the target element and ignore the container element's click property.
1753
- *
1754
- * ClickArea also makes having interactive elements within the clickable container easier. For example, if you have a card element
1755
- * that is clickable but with a "close" button in the top right, include `event.preventDefault()` in the close button's click handler
1756
- * to prevent the container's click handler from firing.
1757
- *
1746
+ /**
1747
+ * ClickArea is useful when you want an entire element to be clickable, such as a card or an item in a list. Making the
1748
+ * entire element clickable provides a better click target for users, especially on mobile devices. The problem with this is
1749
+ * clickable divs are not accessible or tabbable. Using a `button` or `a` tag causes both styling and screenreader problems.
1750
+ *
1751
+ * To solve these issues, `ClickArea` maps a click event on the container element to a click event on a button or link within
1752
+ * it, via a ref. Assistive devices can utilize the target element and ignore the container element's click property.
1753
+ *
1754
+ * ClickArea also makes having interactive elements within the clickable container easier. For example, if you have a card element
1755
+ * that is clickable but with a "close" button in the top right, include `event.preventDefault()` in the close button's click handler
1756
+ * to prevent the container's click handler from firing.
1757
+ *
1758
1758
  */
1759
1759
  declare const ClickArea: _$react.ForwardRefExoticComponent<Omit<ClickAreaProps, "ref"> & _$react.RefAttributes<HTMLElement>>;
1760
1760
  //#endregion
1761
1761
  //#region src/components/CloseButton/CloseButton.d.ts
1762
1762
  type CloseButtonProps = ComponentPropsWithoutRef<'button'> & {
1763
- /**
1764
- * Callback function invoked when the button is clicked
1763
+ /**
1764
+ * Callback function invoked when the button is clicked
1765
1765
  */
1766
1766
  onClick?: () => void;
1767
1767
  };
@@ -1780,43 +1780,43 @@ declare const CARET_DIRECTION_DOWN = "down";
1780
1780
  declare const CARET_DIRECTION_LEFT = "left";
1781
1781
  declare const CARET_DIRECTION_RIGHT = "right";
1782
1782
  type CollapsibleGroupProps = {
1783
- /**
1784
- * Slot for adjacent options
1783
+ /**
1784
+ * Slot for adjacent options
1785
1785
  */
1786
1786
  actions?: ReactNode;
1787
- /**
1788
- * Custom background color
1787
+ /**
1788
+ * Custom background color
1789
1789
  */
1790
1790
  backgroundColor?: string;
1791
- /**
1792
- * Custom direction of the caret when open or closed
1791
+ /**
1792
+ * Custom direction of the caret when open or closed
1793
1793
  */
1794
1794
  caretDirection?: {
1795
1795
  closed: typeof CARET_DIRECTION_DOWN | typeof CARET_DIRECTION_LEFT | typeof CARET_DIRECTION_RIGHT | typeof CARET_DIRECTION_UP;
1796
1796
  open: typeof CARET_DIRECTION_DOWN | typeof CARET_DIRECTION_LEFT | typeof CARET_DIRECTION_RIGHT | typeof CARET_DIRECTION_UP;
1797
1797
  };
1798
- /**
1799
- * Toggleable contents
1798
+ /**
1799
+ * Toggleable contents
1800
1800
  */
1801
1801
  children?: ReactNode;
1802
- /**
1803
- * Optional CSS padding to be applied to the content container
1802
+ /**
1803
+ * Optional CSS padding to be applied to the content container
1804
1804
  */
1805
1805
  contentPadding?: string | null;
1806
- /**
1807
- * The control has a caret by default. Set this to true to suppress the caret
1806
+ /**
1807
+ * The control has a caret by default. Set this to true to suppress the caret
1808
1808
  */
1809
1809
  hideCaret?: boolean;
1810
- /**
1811
- * Optional ID attribute
1810
+ /**
1811
+ * Optional ID attribute
1812
1812
  */
1813
1813
  id?: string;
1814
- /**
1815
- * Control the initial open state. If not provided, the default is to start closed.
1814
+ /**
1815
+ * Control the initial open state. If not provided, the default is to start closed.
1816
1816
  */
1817
1817
  isOpen?: boolean;
1818
- /**
1819
- * Clickable text label for the control, or perhaps an inline editable
1818
+ /**
1819
+ * Clickable text label for the control, or perhaps an inline editable
1820
1820
  * control? Whatever suits you */
1821
1821
  label?: ReactNode | (({
1822
1822
  open,
@@ -1825,29 +1825,29 @@ type CollapsibleGroupProps = {
1825
1825
  open: boolean;
1826
1826
  caret: JSX.Element;
1827
1827
  }) => ReactNode);
1828
- /**
1829
- * Choose on which side the caret shows
1828
+ /**
1829
+ * Choose on which side the caret shows
1830
1830
  */
1831
1831
  layout?: 'leading' | 'trailing';
1832
- /**
1833
- * Callback function invoked when the button is clicked
1832
+ /**
1833
+ * Callback function invoked when the button is clicked
1834
1834
  */
1835
1835
  onClick?: () => unknown;
1836
- /**
1837
- * Callback function invoked when the open state changes
1836
+ /**
1837
+ * Callback function invoked when the open state changes
1838
1838
  */
1839
1839
  onOpenChange?: (newOpen: boolean) => unknown;
1840
- /**
1841
- * Extra actions are hidden by default and shown on hover. Set this to false
1842
- * to make always visible
1840
+ /**
1841
+ * Extra actions are hidden by default and shown on hover. Set this to false
1842
+ * to make always visible
1843
1843
  */
1844
1844
  showActionsOnHover?: boolean;
1845
- /**
1846
- * Display the open / close transition animation
1845
+ /**
1846
+ * Display the open / close transition animation
1847
1847
  */
1848
1848
  showTransition?: boolean;
1849
- /**
1850
- * Changes the styling of the collapsible group banner when active
1849
+ /**
1850
+ * Changes the styling of the collapsible group banner when active
1851
1851
  */
1852
1852
  variant?: typeof VARIANT_BRAND_BLUE;
1853
1853
  };
@@ -1874,16 +1874,16 @@ declare const CollapsibleGroup: {
1874
1874
  //#endregion
1875
1875
  //#region src/components/Divider/Divider.d.ts
1876
1876
  type DividerProps = ComponentPropsWithoutRef<'hr'> & {
1877
- /**
1878
- * Allows user to override default divider color
1877
+ /**
1878
+ * Allows user to override default divider color
1879
1879
  */
1880
1880
  colorOverride?: string;
1881
- /**
1882
- * Height (in pixels) of divider
1881
+ /**
1882
+ * Height (in pixels) of divider
1883
1883
  */
1884
1884
  height?: number;
1885
- /**
1886
- * The visual type of divider to display
1885
+ /**
1886
+ * The visual type of divider to display
1887
1887
  */
1888
1888
  variant?: 'dashed' | 'solid';
1889
1889
  };
@@ -1901,12 +1901,12 @@ declare const Divider: {
1901
1901
  declare const ellipsisStyle: _$styled_components0.RuleSet<object>;
1902
1902
  declare const ellipsisFlexParentStyle: _$styled_components0.RuleSet<object>;
1903
1903
  type EllipsisProps = ComponentPropsWithoutRef<'div'> & {
1904
- /**
1905
- * The text that will be truncated with an ellipsis
1904
+ /**
1905
+ * The text that will be truncated with an ellipsis
1906
1906
  */
1907
1907
  children?: ReactNode;
1908
- /**
1909
- * The number that will be truncated with an ellipsis
1908
+ /**
1909
+ * The number that will be truncated with an ellipsis
1910
1910
  */
1911
1911
  lines?: number;
1912
1912
  };
@@ -1921,45 +1921,45 @@ declare const Ellipsis: {
1921
1921
  //#endregion
1922
1922
  //#region src/components/FileSelect/FileSelect.d.ts
1923
1923
  type FileSelectProps = {
1924
- /**
1925
- * Allowlist of file types that the server will accept
1926
- * (see: <a href="https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-accept">file input docs</a>)
1924
+ /**
1925
+ * Allowlist of file types that the server will accept
1926
+ * (see: <a href="https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-accept">file input docs</a>)
1927
1927
  */
1928
1928
  accept: string;
1929
- /**
1930
- * Pass an arbitrary child node
1929
+ /**
1930
+ * Pass an arbitrary child node
1931
1931
  */
1932
1932
  children: ReactNode;
1933
- /**
1934
- * Disable the input. <em>Note: Does not "disable" the child component, only the hidden input</em>
1933
+ /**
1934
+ * Disable the input. <em>Note: Does not "disable" the child component, only the hidden input</em>
1935
1935
  */
1936
1936
  disabled?: boolean;
1937
- /**
1938
- * ID of the input
1937
+ /**
1938
+ * ID of the input
1939
1939
  */
1940
1940
  id: string;
1941
- /**
1942
- * File size limit specified in MB
1941
+ /**
1942
+ * File size limit specified in MB
1943
1943
  */
1944
1944
  maxSize?: number;
1945
- /**
1946
- * Allow multiple files to be selected
1945
+ /**
1946
+ * Allow multiple files to be selected
1947
1947
  */
1948
1948
  multiple?: boolean;
1949
- /**
1950
- * Name of the input
1949
+ /**
1950
+ * Name of the input
1951
1951
  */
1952
1952
  name?: string;
1953
- /**
1954
- * Callback invoked when file has been selected
1953
+ /**
1954
+ * Callback invoked when file has been selected
1955
1955
  */
1956
1956
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
1957
- /**
1958
- * Callback invoked when the file input is clicked (before the file has been selected)
1957
+ /**
1958
+ * Callback invoked when the file input is clicked (before the file has been selected)
1959
1959
  */
1960
1960
  onClick?: (...args: unknown[]) => unknown;
1961
- /**
1962
- * Callback invoked when there is an error selecting file(s)
1961
+ /**
1962
+ * Callback invoked when there is an error selecting file(s)
1963
1963
  */
1964
1964
  onError?: (error: Error) => void;
1965
1965
  };
@@ -1970,68 +1970,68 @@ type ValuesType = Record<string, unknown>;
1970
1970
  type Values = Record<string, unknown>;
1971
1971
  type FormState = FormikProps<Values>;
1972
1972
  type FormProps = {
1973
- /**
1974
- * Pass an arbitrary child node
1973
+ /**
1974
+ * Pass an arbitrary child node
1975
1975
  */
1976
1976
  children?: ReactNode;
1977
- /**
1978
- * Class(es) to be applied to formik container
1977
+ /**
1978
+ * Class(es) to be applied to formik container
1979
1979
  */
1980
1980
  className?: string;
1981
- /**
1982
- * Unique ID for Form, used for React Testing Library
1981
+ /**
1982
+ * Unique ID for Form, used for React Testing Library
1983
1983
  */
1984
1984
  formId: string;
1985
- /**
1986
- * Ref required to be ref of FormGlobalError. Simply assign `const globalErrorRef = useRef(null)`. Either a function or the instance of a DOM native element.
1985
+ /**
1986
+ * Ref required to be ref of FormGlobalError. Simply assign `const globalErrorRef = useRef(null)`. Either a function or the instance of a DOM native element.
1987
1987
  */
1988
1988
  globalErrorRef: RefObject<HTMLElement | null | undefined>;
1989
- /**
1990
- * Form input values on initial load, often populated from server
1989
+ /**
1990
+ * Form input values on initial load, often populated from server
1991
1991
  */
1992
1992
  initialValues: ValuesType;
1993
- /**
1994
- * Ref to access the form's state and API
1993
+ /**
1994
+ * Ref to access the form's state and API
1995
1995
  */
1996
1996
  innerRef?: Ref<FormState>;
1997
- /**
1998
- * On-submit callback
1997
+ /**
1998
+ * On-submit callback
1999
1999
  */
2000
2000
  onSubmit: (values: Record<string, unknown>, ref: FormikHelpers<Values>) => unknown;
2001
- /**
2002
- * On form submission with errors (isValid=false), scroll to GlobalError section
2001
+ /**
2002
+ * On form submission with errors (isValid=false), scroll to GlobalError section
2003
2003
  */
2004
2004
  scrollToFormErrorsOnSubmit?: boolean;
2005
- /**
2006
- * On-validate callback, params include values, and the rest of the form state params available in [Formik](https://jaredpalmer.com/formik/docs/api/formik#props-1)
2005
+ /**
2006
+ * On-validate callback, params include values, and the rest of the form state params available in [Formik](https://jaredpalmer.com/formik/docs/api/formik#props-1)
2007
2007
  */
2008
2008
  shareFormContext?: (props: FormikProps<Values>) => unknown;
2009
- /**
2010
- * Show a top-level rundown of all the errors in the form
2009
+ /**
2010
+ * Show a top-level rundown of all the errors in the form
2011
2011
  */
2012
2012
  showGlobalError?: boolean;
2013
- /**
2014
- * Style object applied to Form component
2013
+ /**
2014
+ * Style object applied to Form component
2015
2015
  */
2016
2016
  style?: Record<string, string>;
2017
- /**
2018
- * Should form submit when an input's onChange is invoked?
2017
+ /**
2018
+ * Should form submit when an input's onChange is invoked?
2019
2019
  */
2020
2020
  submitOnChange?: boolean;
2021
- /**
2022
- * Validate function passed to formik
2021
+ /**
2022
+ * Validate function passed to formik
2023
2023
  */
2024
2024
  validate?: (values: Values) => Promise<FormikErrors<Values>> | object | void;
2025
- /**
2026
- * Should form run validate function on form blur?
2025
+ /**
2026
+ * Should form run validate function on form blur?
2027
2027
  */
2028
2028
  validateOnBlur?: boolean;
2029
- /**
2030
- * Should form run validate function on form change?
2029
+ /**
2030
+ * Should form run validate function on form change?
2031
2031
  */
2032
2032
  validateOnChange?: boolean;
2033
- /**
2034
- * __[`yup` schema](https://github.com/jquense/yup#yup)__
2033
+ /**
2034
+ * __[`yup` schema](https://github.com/jquense/yup#yup)__
2035
2035
  */
2036
2036
  validationSchema?: ValidationSchemaType;
2037
2037
  };
@@ -2067,12 +2067,12 @@ type ButtonsType = {
2067
2067
  type?: 'button' | 'reset' | 'submit' | undefined;
2068
2068
  };
2069
2069
  type FormButtonsProps = {
2070
- /**
2071
- * Align button left (typically on a page) or right (typically on a modal).
2070
+ /**
2071
+ * Align button left (typically on a page) or right (typically on a modal).
2072
2072
  */
2073
2073
  align?: 'left' | 'right';
2074
- /**
2075
- * Each button object must have a name, but can also be passed any props that apply to a Button component.
2074
+ /**
2075
+ * Each button object must have a name, but can also be passed any props that apply to a Button component.
2076
2076
  */
2077
2077
  buttons: ButtonsType[];
2078
2078
  };
@@ -2145,59 +2145,59 @@ declare const rteFormatTypes: Readonly<{
2145
2145
  //#endregion
2146
2146
  //#region src/components/FormField/FormField.d.ts
2147
2147
  type FormFieldProps = Omit<ComponentPropsWithRef<'input'>, 'placeholder'> & {
2148
- /**
2149
- * A custom component that acts as a field and that needs access to Formik fields
2148
+ /**
2149
+ * A custom component that acts as a field and that needs access to Formik fields
2150
2150
  */
2151
2151
  customComponent?: ComponentClass<CustomComponentClass> | ((arg?: ComponentProps<typeof Field>) => ReactNode) | ((arg?: Record<string, unknown>) => ReactNode) | undefined;
2152
- /**
2153
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
2152
+ /**
2153
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
2154
2154
  */
2155
2155
  direction?: 'column' | 'row';
2156
- /**
2157
- * Disables form field
2156
+ /**
2157
+ * Disables form field
2158
2158
  */
2159
2159
  disabled?: boolean;
2160
- /**
2161
- * Only takes effect if type is richTextEditor. An array of formats that should be enabled in the toolbar.
2160
+ /**
2161
+ * Only takes effect if type is richTextEditor. An array of formats that should be enabled in the toolbar.
2162
2162
  */
2163
2163
  enabledFormats?: (keyof typeof rteFormatTypes)[];
2164
- /**
2165
- * Visual label above the input
2164
+ /**
2165
+ * Visual label above the input
2166
2166
  */
2167
2167
  label?: JSX.Element | string | undefined;
2168
- /**
2169
- * The hint/helper text under the label
2168
+ /**
2169
+ * The hint/helper text under the label
2170
2170
  */
2171
2171
  labelDescription?: ReactNode;
2172
- /**
2173
- * Props that are passed through to the underlying `<Label>` component
2172
+ /**
2173
+ * Props that are passed through to the underlying `<Label>` component
2174
2174
  */
2175
2175
  labelProps?: {
2176
2176
  disabled?: boolean;
2177
2177
  screenReaderOnly?: boolean;
2178
2178
  };
2179
- /**
2180
- * HTML "name" attribute. Also needs to be unique in the form
2179
+ /**
2180
+ * HTML "name" attribute. Also needs to be unique in the form
2181
2181
  */
2182
2182
  name?: string;
2183
- /**
2184
- * Custom onChange callback add-on. args: "value"
2183
+ /**
2184
+ * Custom onChange callback add-on. args: "value"
2185
2185
  */
2186
2186
  onChangeCustom?: (value: string) => unknown;
2187
- /**
2188
- * Options passed down to the `<Field>` component
2187
+ /**
2188
+ * Options passed down to the `<Field>` component
2189
2189
  */
2190
2190
  options?: Record<string, unknown>[];
2191
- /**
2192
- * Input's visual placeholder text
2191
+ /**
2192
+ * Input's visual placeholder text
2193
2193
  */
2194
2194
  placeholder?: string | null | undefined;
2195
- /**
2196
- * Allows user to vertically or horizontally resize the form field, or to disable resizing altogether
2195
+ /**
2196
+ * Allows user to vertically or horizontally resize the form field, or to disable resizing altogether
2197
2197
  */
2198
2198
  resize?: 'horizontal' | 'none' | 'vertical';
2199
- /**
2200
- * The type of the field sets the type of input or select, texarea, radio, checkbox, etc.
2199
+ /**
2200
+ * The type of the field sets the type of input or select, texarea, radio, checkbox, etc.
2201
2201
  */
2202
2202
  type: 'checkbox' | 'custom' | 'email' | 'hidden' | 'multiline' | 'number' | 'password' | 'radio' | 'richTextEditor' | 'select' | 'text' | 'url';
2203
2203
  };
@@ -2220,28 +2220,28 @@ declare const FormGlobalError: _$react.ForwardRefExoticComponent<_$react.RefAttr
2220
2220
  //#endregion
2221
2221
  //#region src/components/FullScreenModal/FullScreenModal.d.ts
2222
2222
  type FullScreenModalProps = {
2223
- /**
2224
- * Color of the modal background
2223
+ /**
2224
+ * Color of the modal background
2225
2225
  */
2226
2226
  backgroundColor?: string;
2227
- /**
2228
- * Contents of the modal
2227
+ /**
2228
+ * Contents of the modal
2229
2229
  */
2230
2230
  content: (hide: () => unknown) => ReactNode;
2231
- /**
2232
- * Render the modal initially in shown state
2231
+ /**
2232
+ * Render the modal initially in shown state
2233
2233
  */
2234
2234
  initialShownState?: boolean;
2235
- /**
2236
- * Callback invoked before the modal is hidden
2235
+ /**
2236
+ * Callback invoked before the modal is hidden
2237
2237
  */
2238
2238
  onBeforeHide?: (() => OnBeforeHideInterface) | undefined;
2239
- /**
2240
- * Callback invoked when the modal is shown
2239
+ /**
2240
+ * Callback invoked when the modal is shown
2241
2241
  */
2242
2242
  onHide?: () => unknown;
2243
- /**
2244
- * function(show, ref) that returns a node to open the modal
2243
+ /**
2244
+ * function(show, ref) that returns a node to open the modal
2245
2245
  */
2246
2246
  toggle?: ((show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode) | undefined;
2247
2247
  };
@@ -2266,20 +2266,20 @@ declare const iconSizeMap: {
2266
2266
  xxl: string;
2267
2267
  };
2268
2268
  type IconProps = ComponentPropsWithoutRef<'svg'> & {
2269
- /**
2270
- * Color (as hex) of the Icon
2269
+ /**
2270
+ * Color (as hex) of the Icon
2271
2271
  */
2272
2272
  color?: string;
2273
- /**
2274
- * The size of the icon to display
2273
+ /**
2274
+ * The size of the icon to display
2275
2275
  */
2276
2276
  size?: keyof typeof iconSizeMap;
2277
- /**
2278
- * @ignore
2277
+ /**
2278
+ * @ignore
2279
2279
  */
2280
2280
  style?: Record<string, unknown>;
2281
- /**
2282
- * Determines which icon to display
2281
+ /**
2282
+ * Determines which icon to display
2283
2283
  */
2284
2284
  type: IconNameType;
2285
2285
  };
@@ -2307,40 +2307,40 @@ declare const componentStyleMap: {
2307
2307
  type sizeType = keyof typeof sizeMap;
2308
2308
  type componentStyleType = keyof typeof componentStyleMap;
2309
2309
  type IconButtonProps = ComponentPropsWithRef<'button'> & {
2310
- /**
2311
- * Allows user to override default button colors
2310
+ /**
2311
+ * Allows user to override default button colors
2312
2312
  */
2313
2313
  colorOverride?: string | undefined;
2314
- /**
2315
- * Choose light styles if this component appears on a dark background
2314
+ /**
2315
+ * Choose light styles if this component appears on a dark background
2316
2316
  */
2317
2317
  componentStyle?: componentStyleType;
2318
- /**
2319
- * Disables button
2318
+ /**
2319
+ * Disables button
2320
2320
  */
2321
2321
  disabled?: boolean;
2322
- /**
2323
- * An SVG component
2322
+ /**
2323
+ * An SVG component
2324
2324
  */
2325
2325
  icon?: ReactNode;
2326
- /**
2327
- * Text that appears as a tooltip when the user hovers over the button
2326
+ /**
2327
+ * Text that appears as a tooltip when the user hovers over the button
2328
2328
  */
2329
2329
  label?: string;
2330
- /**
2331
- * Callback function invoked when the button is clicked
2330
+ /**
2331
+ * Callback function invoked when the button is clicked
2332
2332
  */
2333
2333
  onClick?: ((event: MouseEvent) => void) | undefined;
2334
- /**
2335
- * Prevent a Tooltip from appearing on hover
2334
+ /**
2335
+ * Prevent a Tooltip from appearing on hover
2336
2336
  */
2337
2337
  preventTooltip?: boolean;
2338
- /**
2339
- * The size of the button
2338
+ /**
2339
+ * The size of the button
2340
2340
  */
2341
2341
  size?: sizeType;
2342
- /**
2343
- * The direction of the tooltip
2342
+ /**
2343
+ * The direction of the tooltip
2344
2344
  */
2345
2345
  tooltipDirection?: 'bottom' | 'left' | 'right' | 'top';
2346
2346
  };
@@ -2348,33 +2348,33 @@ declare const IconButton: _$react.ForwardRefExoticComponent<Omit<IconButtonProps
2348
2348
  //#endregion
2349
2349
  //#region src/components/Image/Image.d.ts
2350
2350
  type ImageProps = ComponentPropsWithoutRef<'img'> & {
2351
- /**
2352
- * Accessible text to apply to the image
2351
+ /**
2352
+ * Accessible text to apply to the image
2353
2353
  */
2354
2354
  alt: string;
2355
- /**
2356
- * Specifies whether the width and/or height should fill the container
2357
- *
2358
- * *Note: this will override height/width attributes*
2355
+ /**
2356
+ * Specifies whether the width and/or height should fill the container
2357
+ *
2358
+ * *Note: this will override height/width attributes*
2359
2359
  */
2360
2360
  fill?: boolean | 'horizontal' | 'vertical';
2361
- /**
2362
- * Specifies how the image's intrinsic size (ie. its natural size) should
2363
- * be adjusted to fit within its container
2361
+ /**
2362
+ * Specifies how the image's intrinsic size (ie. its natural size) should
2363
+ * be adjusted to fit within its container
2364
2364
  */
2365
2365
  fit?: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down';
2366
- /**
2367
- * Indicates how the browser should load the image; `eager`loads the image immediately,
2368
- * `lazy` defers loading the image until it reaches a calculated distance from the viewport.
2369
- * See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading
2366
+ /**
2367
+ * Indicates how the browser should load the image; `eager`loads the image immediately,
2368
+ * `lazy` defers loading the image until it reaches a calculated distance from the viewport.
2369
+ * See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading
2370
2370
  */
2371
2371
  loading?: 'eager' | 'lazy';
2372
- /**
2373
- * Specifies how the image will align itself in its container
2372
+ /**
2373
+ * Specifies how the image will align itself in its container
2374
2374
  */
2375
2375
  position?: string;
2376
- /**
2377
- * URL to image file
2376
+ /**
2377
+ * URL to image file
2378
2378
  */
2379
2379
  src: string;
2380
2380
  };
@@ -2395,85 +2395,85 @@ declare const Image: {
2395
2395
  type IconPositionStrings = 'end' | 'start';
2396
2396
  type ForcedStateStrings = 'active' | 'focus' | 'hover';
2397
2397
  type InputProps = ComponentPropsWithRef<'input'> & {
2398
- /**
2399
- * Copy-to-clipboard-on-click of input's value with copy icon
2398
+ /**
2399
+ * Copy-to-clipboard-on-click of input's value with copy icon
2400
2400
  */
2401
2401
  clickToCopy?: boolean;
2402
- /**
2403
- * Disables Input
2402
+ /**
2403
+ * Disables Input
2404
2404
  */
2405
2405
  disabled?: boolean | undefined;
2406
- /**
2407
- * @ignore
2408
- * Force an Input into a particular css state (for debugging)
2406
+ /**
2407
+ * @ignore
2408
+ * Force an Input into a particular css state (for debugging)
2409
2409
  */
2410
2410
  forceState?: ForcedStateStrings;
2411
- /**
2412
- * Should Input occupy 100% of available space
2411
+ /**
2412
+ * Should Input occupy 100% of available space
2413
2413
  */
2414
2414
  fullWidth?: boolean;
2415
- /**
2416
- * Indicates that there is an error with the input
2415
+ /**
2416
+ * Indicates that there is an error with the input
2417
2417
  */
2418
2418
  hasError?: boolean;
2419
- /**
2420
- * An SVG component that will appear on the right-hand side of the input
2421
- * _Note:_ some input types will apply a icon by default
2419
+ /**
2420
+ * An SVG component that will appear on the right-hand side of the input
2421
+ * _Note:_ some input types will apply a icon by default
2422
2422
  */
2423
2423
  icon?: ReactNode;
2424
- /**
2425
- * Indicates on which side of the input the icon should render. Will default to `end` unless the `type` prop is `search`.
2424
+ /**
2425
+ * Indicates on which side of the input the icon should render. Will default to `end` unless the `type` prop is `search`.
2426
2426
  */
2427
2427
  iconPosition?: IconPositionStrings;
2428
- /**
2429
- * @ignore
2430
- * This is a prop that is here for use by FormField. Otherwise,
2431
- * the ref prop should just be used
2428
+ /**
2429
+ * @ignore
2430
+ * This is a prop that is here for use by FormField. Otherwise,
2431
+ * the ref prop should just be used
2432
2432
  */
2433
2433
  innerRef?: RefObject<HTMLInputElement | null>;
2434
- /**
2435
- * Displays text in monospace font
2434
+ /**
2435
+ * Displays text in monospace font
2436
2436
  */
2437
2437
  monospace?: boolean;
2438
- /**
2439
- * Callback function invoked when the input focus blurs
2438
+ /**
2439
+ * Callback function invoked when the input focus blurs
2440
2440
  */
2441
2441
  onBlur?: (event: FocusEvent<HTMLInputElement>) => void;
2442
- /**
2443
- * Callback function invoked when the input value changes
2442
+ /**
2443
+ * Callback function invoked when the input value changes
2444
2444
  */
2445
2445
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
2446
- /**
2447
- * Callback function invoked when the input value is copied
2446
+ /**
2447
+ * Callback function invoked when the input value is copied
2448
2448
  */
2449
2449
  onClickToCopy?: () => void;
2450
- /**
2451
- * Callback function invoked when the input is focused
2450
+ /**
2451
+ * Callback function invoked when the input is focused
2452
2452
  */
2453
2453
  onFocus?: (event: FocusEvent<HTMLInputElement>) => void;
2454
- /**
2455
- * Callback function that will select input text when input is focused;
2456
- * receives event object but if that is not needed just pass a no-op function
2454
+ /**
2455
+ * Callback function that will select input text when input is focused;
2456
+ * receives event object but if that is not needed just pass a no-op function
2457
2457
  */
2458
2458
  onFocusToSelect?: ((event: ChangeEvent<HTMLInputElement>) => void) | undefined;
2459
- /**
2460
- * A short hint for the user about what value the Input expects
2459
+ /**
2460
+ * A short hint for the user about what value the Input expects
2461
2461
  */
2462
2462
  placeholder?: string | undefined;
2463
- /**
2464
- * Prevent the Input from being writable (different styling from disabled)
2463
+ /**
2464
+ * Prevent the Input from being writable (different styling from disabled)
2465
2465
  */
2466
2466
  readOnly?: boolean;
2467
- /**
2468
- * Make Input a required element
2467
+ /**
2468
+ * Make Input a required element
2469
2469
  */
2470
2470
  required?: boolean;
2471
- /**
2472
- * The type of Input to render
2471
+ /**
2472
+ * The type of Input to render
2473
2473
  */
2474
2474
  type?: HTMLInputTypeAttribute;
2475
- /**
2476
- * The content of Input
2475
+ /**
2476
+ * The content of Input
2477
2477
  */
2478
2478
  value?: number | string | undefined;
2479
2479
  };
@@ -2488,20 +2488,20 @@ type KeyboardKeys = AlphanumericKeyboardKeys | ArrowKeys | ModifierKeys | Whites
2488
2488
  //#endregion
2489
2489
  //#region src/components/KeyboardShortcut/KeyboardShortcut.d.ts
2490
2490
  type KeyboardShortcutProps = ComponentPropsWithoutRef<'div'> & {
2491
- /**
2492
- * @description The visual style of the keyboard shortcut. Choose light if the background is dark and dark if the background is light.
2491
+ /**
2492
+ * @description The visual style of the keyboard shortcut. Choose light if the background is dark and dark if the background is light.
2493
2493
  */
2494
2494
  componentStyle?: 'dark' | 'light';
2495
- /**
2496
- * @description If set to true, the keyboard shortcut will stretch the full width of its container.
2495
+ /**
2496
+ * @description If set to true, the keyboard shortcut will stretch the full width of its container.
2497
2497
  */
2498
2498
  fullWidth?: boolean;
2499
- /**
2500
- * @description The keys displayed.
2499
+ /**
2500
+ * @description The keys displayed.
2501
2501
  */
2502
2502
  keyboardKeys: KeyboardKeys | KeyboardKeys[];
2503
- /**
2504
- * @description A visual label for the keyboard shortcut.
2503
+ /**
2504
+ * @description A visual label for the keyboard shortcut.
2505
2505
  */
2506
2506
  label?: string;
2507
2507
  };
@@ -2518,29 +2518,29 @@ declare const KeyboardShortcut: {
2518
2518
  //#endregion
2519
2519
  //#region src/components/Label/Label.d.ts
2520
2520
  type LabelProps = ComponentPropsWithoutRef<'label'> & {
2521
- /**
2522
- * Pass an arbitrary child node
2521
+ /**
2522
+ * Pass an arbitrary child node
2523
2523
  */
2524
2524
  children?: ReactNode;
2525
- /**
2526
- * To indicate that the label is for a disabled form component
2525
+ /**
2526
+ * To indicate that the label is for a disabled form component
2527
2527
  */
2528
2528
  disabled?: boolean;
2529
- /**
2530
- * ID of the form component that the label should be associated with
2529
+ /**
2530
+ * ID of the form component that the label should be associated with
2531
2531
  */
2532
2532
  htmlFor?: string | undefined;
2533
- /**
2534
- * To use 'legend', 'p', 'span', or other instead of 'label'
2533
+ /**
2534
+ * To use 'legend', 'p', 'span', or other instead of 'label'
2535
2535
  */
2536
2536
  renderAs?: 'div' | 'label' | 'legend' | 'p' | 'span' | undefined;
2537
- /**
2538
- * Use if label describes a required form component
2537
+ /**
2538
+ * Use if label describes a required form component
2539
2539
  */
2540
2540
  required?: boolean;
2541
- /**
2542
- * For label text that needs to be available to assistive technology (e.g. screen readers)
2543
- * but otherwise hidden on screen.
2541
+ /**
2542
+ * For label text that needs to be available to assistive technology (e.g. screen readers)
2543
+ * but otherwise hidden on screen.
2544
2544
  */
2545
2545
  screenReaderOnly?: boolean;
2546
2546
  };
@@ -2573,72 +2573,72 @@ declare const LabelDescription: {
2573
2573
  //#endregion
2574
2574
  //#region src/components/LinkButton/LinkButton.d.ts
2575
2575
  type LinkButtonProps = ComponentPropsWithoutRef<'button'> & {
2576
- /**
2577
- * Pass an arbitrary child node
2576
+ /**
2577
+ * Pass an arbitrary child node
2578
2578
  */
2579
2579
  children?: ReactNode;
2580
- /**
2581
- * Disables Button
2580
+ /**
2581
+ * Disables Button
2582
2582
  */
2583
2583
  disabled?: boolean;
2584
- /**
2585
- * @ignore
2586
- * Force a Button into a particular css state (for debugging)
2584
+ /**
2585
+ * @ignore
2586
+ * Force a Button into a particular css state (for debugging)
2587
2587
  */
2588
2588
  forceState?: 'active' | 'focus' | 'hover';
2589
- /**
2590
- * Text that appears inside the button
2589
+ /**
2590
+ * Text that appears inside the button
2591
2591
  */
2592
2592
  label?: string;
2593
- /**
2594
- * Provides a button without any styling (useful for wrapping another element)
2593
+ /**
2594
+ * Provides a button without any styling (useful for wrapping another element)
2595
2595
  */
2596
2596
  noStyle?: boolean;
2597
- /**
2598
- * Callback function invoked when the button is clicked
2597
+ /**
2598
+ * Callback function invoked when the button is clicked
2599
2599
  */
2600
2600
  onClick?: (event: KeyboardEvent$1 | MouseEvent) => void;
2601
- /**
2602
- * Will only display an underline when the Link is in a hover state
2601
+ /**
2602
+ * Will only display an underline when the Link is in a hover state
2603
2603
  */
2604
2604
  underlineOnHover?: boolean;
2605
- /**
2606
- * The visual type of Button to display
2605
+ /**
2606
+ * The visual type of Button to display
2607
2607
  */
2608
2608
  variant?: 'primary' | 'secondary';
2609
2609
  };
2610
2610
  declare const LinkButton: _$react.ForwardRefExoticComponent<Omit<_$react.DetailedHTMLProps<_$react.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
2611
- /**
2612
- * Pass an arbitrary child node
2611
+ /**
2612
+ * Pass an arbitrary child node
2613
2613
  */
2614
2614
  children?: ReactNode;
2615
- /**
2616
- * Disables Button
2615
+ /**
2616
+ * Disables Button
2617
2617
  */
2618
2618
  disabled?: boolean;
2619
- /**
2620
- * @ignore
2621
- * Force a Button into a particular css state (for debugging)
2619
+ /**
2620
+ * @ignore
2621
+ * Force a Button into a particular css state (for debugging)
2622
2622
  */
2623
2623
  forceState?: "active" | "focus" | "hover";
2624
- /**
2625
- * Text that appears inside the button
2624
+ /**
2625
+ * Text that appears inside the button
2626
2626
  */
2627
2627
  label?: string;
2628
- /**
2629
- * Provides a button without any styling (useful for wrapping another element)
2628
+ /**
2629
+ * Provides a button without any styling (useful for wrapping another element)
2630
2630
  */
2631
2631
  noStyle?: boolean;
2632
- /**
2633
- * Callback function invoked when the button is clicked
2632
+ /**
2633
+ * Callback function invoked when the button is clicked
2634
2634
  */
2635
2635
  onClick?: (event: KeyboardEvent$1 | MouseEvent) => void;
2636
- /**
2637
- * Will only display an underline when the Link is in a hover state
2636
+ /**
2637
+ * Will only display an underline when the Link is in a hover state
2638
2638
  */
2639
2639
  underlineOnHover?: boolean;
2640
- /**
2641
- * The visual type of Button to display
2640
+ /**
2641
+ * The visual type of Button to display
2642
2642
  */
2643
2643
  variant?: "primary" | "secondary";
2644
2644
  } & _$react.RefAttributes<HTMLSpanElement>>;
@@ -2647,17 +2647,17 @@ declare const LinkButton: _$react.ForwardRefExoticComponent<Omit<_$react.Detaile
2647
2647
  type VariantType = 'breadcrumbs' | 'bullets' | 'commas' | 'ordered' | 'slashes' | 'spaces' | 'unbulleted';
2648
2648
  type ItemType = ItemType[] | string[] | string;
2649
2649
  type ListProps = ComponentPropsWithoutRef<'ul'> & {
2650
- /**
2651
- * Children should be wrapped in `<ListItem>`
2650
+ /**
2651
+ * Children should be wrapped in `<ListItem>`
2652
2652
  */
2653
2653
  children?: ReactNode;
2654
- /**
2655
- * As an alternative to passing children you can supply an array of strings that
2656
- * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
2654
+ /**
2655
+ * As an alternative to passing children you can supply an array of strings that
2656
+ * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
2657
2657
  */
2658
2658
  items?: ItemType[];
2659
- /**
2660
- * The kind of list to render
2659
+ /**
2660
+ * The kind of list to render
2661
2661
  */
2662
2662
  variant?: VariantType;
2663
2663
  };
@@ -2673,8 +2673,8 @@ declare const List: {
2673
2673
  //#endregion
2674
2674
  //#region src/components/List/ListItem.d.ts
2675
2675
  type ListItemProps = {
2676
- /**
2677
- * Pass an arbitrary child node
2676
+ /**
2677
+ * Pass an arbitrary child node
2678
2678
  */
2679
2679
  children?: ReactNode;
2680
2680
  };
@@ -2688,8 +2688,8 @@ declare const ListItem: {
2688
2688
  //#region src/components/Menu/Menu.d.ts
2689
2689
  type ControlledMenuProps = {
2690
2690
  /** Is the menu open. Must be used with `onOpenChange`. */isOpen: boolean;
2691
- /** When an attempt to toggle the menu is triggered,
2692
- * must be used with `isOpen`.
2691
+ /** When an attempt to toggle the menu is triggered,
2692
+ * must be used with `isOpen`.
2693
2693
  */
2694
2694
  onOpenChange: (isOpen: boolean) => void;
2695
2695
  };
@@ -2812,60 +2812,60 @@ declare const SubMenu: ({
2812
2812
  //#endregion
2813
2813
  //#region src/components/MenuButton/MenuButton.d.ts
2814
2814
  type MenuButtonProps = ButtonProps & {
2815
- /**
2816
- * Disables button
2815
+ /**
2816
+ * Disables button
2817
2817
  */
2818
2818
  disabled?: boolean;
2819
- /**
2820
- * Use this prop to pass an IconButton as the "trigger" instead of a standard Button
2819
+ /**
2820
+ * Use this prop to pass an IconButton as the "trigger" instead of a standard Button
2821
2821
  */
2822
2822
  iconButtonComponent?: JSX.Element | ReactElement;
2823
- /**
2824
- * Text that appears inside the button
2823
+ /**
2824
+ * Text that appears inside the button
2825
2825
  */
2826
2826
  label: string;
2827
- /**
2828
- * Which side of the button should the menu be aligned
2827
+ /**
2828
+ * Which side of the button should the menu be aligned
2829
2829
  */
2830
2830
  menuAlignment?: 'left' | 'right';
2831
- /**
2832
- * An array of Button/Link components
2831
+ /**
2832
+ * An array of Button/Link components
2833
2833
  */
2834
2834
  menuItems?: JSX.Element[];
2835
- /**
2836
- * Where should the menu appear relative to the button
2835
+ /**
2836
+ * Where should the menu appear relative to the button
2837
2837
  */
2838
2838
  menuPosition?: 'above' | 'below';
2839
- /**
2840
- * Can be a CSS width value string, 'fullWidth' or 'maxItem' (sized to the largest item width)
2839
+ /**
2840
+ * Can be a CSS width value string, 'fullWidth' or 'maxItem' (sized to the largest item width)
2841
2841
  */
2842
2842
  menuWidth?: string;
2843
- /**
2844
- * Function that is called after the menu is closed
2843
+ /**
2844
+ * Function that is called after the menu is closed
2845
2845
  */
2846
2846
  onMenuClosed?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
2847
- /**
2848
- * Function that is called when the menu button is clicked
2847
+ /**
2848
+ * Function that is called when the menu button is clicked
2849
2849
  */
2850
2850
  onMenuClick?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
2851
- /**
2852
- * A custom node to be displayed in the menu on extra small screens.
2851
+ /**
2852
+ * A custom node to be displayed in the menu on extra small screens.
2853
2853
  */
2854
2854
  overrideMenuHeader?: ReactNode;
2855
- /**
2856
- * The size of button to display
2855
+ /**
2856
+ * The size of button to display
2857
2857
  */
2858
2858
  size?: 'lg' | 'md' | 'sm';
2859
2859
  };
2860
- /**
2861
- * @deprecated Please use Menu with a Button trigger, see [documentation](https://wistia.github.io/vhs/?path=/docs-components-menu--docs).
2862
- *
2863
- * #### Why MenuButton is being deprecated
2864
- *
2865
- * The [Menu](https://wistia.github.io/vhs/?path=/docs-components-menu--docs) component is preferred over MenuButton for several reasons:
2866
- * 1. Menu has better alignment and collision detection.
2867
- * 2. Menu supports submenus.
2868
- * 3. Menu is properly portalled.
2860
+ /**
2861
+ * @deprecated Please use Menu with a Button trigger, see [documentation](https://wistia.github.io/vhs/?path=/docs-components-menu--docs).
2862
+ *
2863
+ * #### Why MenuButton is being deprecated
2864
+ *
2865
+ * The [Menu](https://wistia.github.io/vhs/?path=/docs-components-menu--docs) component is preferred over MenuButton for several reasons:
2866
+ * 1. Menu has better alignment and collision detection.
2867
+ * 2. Menu supports submenus.
2868
+ * 3. Menu is properly portalled.
2869
2869
  */
2870
2870
  declare const MenuButton: {
2871
2871
  ({
@@ -2887,59 +2887,59 @@ declare const MenuButton: {
2887
2887
  //#endregion
2888
2888
  //#region src/components/Modal/Modal.d.ts
2889
2889
  type ModalProps = ComponentPropsWithoutRef<'div'> & {
2890
- /**
2891
- * Horizontally align modal to the left, center, or right of the container
2890
+ /**
2891
+ * Horizontally align modal to the left, center, or right of the container
2892
2892
  */
2893
2893
  alignHorizontal?: 'center' | 'left' | 'normal' | 'right';
2894
- /**
2895
- * Vertically align modal to the top, center, or bottom of the container
2894
+ /**
2895
+ * Vertically align modal to the top, center, or bottom of the container
2896
2896
  */
2897
2897
  alignVertical?: 'bottom' | 'center' | 'normal' | 'top';
2898
- /**
2899
- * Whether or not the modal should be allowed to exceed the viewport bounds.
2900
- * If it exceeds the bounds, the entire backdrop will be scrollable.
2898
+ /**
2899
+ * Whether or not the modal should be allowed to exceed the viewport bounds.
2900
+ * If it exceeds the bounds, the entire backdrop will be scrollable.
2901
2901
  */
2902
2902
  allowModalToExceedViewportBounds?: boolean;
2903
- /**
2904
- * Contents of the modal
2903
+ /**
2904
+ * Contents of the modal
2905
2905
  */
2906
2906
  children?: ReactNode;
2907
- /**
2908
- * Class to be applied to the base element of the modal
2907
+ /**
2908
+ * Class to be applied to the base element of the modal
2909
2909
  */
2910
2910
  className?: string;
2911
- /**
2912
- * Whether or not the modal should take up the full height of the viewport
2911
+ /**
2912
+ * Whether or not the modal should take up the full height of the viewport
2913
2913
  */
2914
2914
  fullHeight?: boolean;
2915
- /**
2916
- * Ref to the element that should receive focus when the modal opens
2915
+ /**
2916
+ * Ref to the element that should receive focus when the modal opens
2917
2917
  */
2918
2918
  initialFocusRef?: RefObject<HTMLElement | null>;
2919
- /**
2920
- * Whether or not the modal is open, and should be rendered
2919
+ /**
2920
+ * Whether or not the modal is open, and should be rendered
2921
2921
  */
2922
2922
  isOpen: boolean;
2923
- /**
2924
- * When the Modal is dismissed, this function will be called. You'll typically want to set the
2925
- * state of `isOpen` to false here
2926
- * @returns
2923
+ /**
2924
+ * When the Modal is dismissed, this function will be called. You'll typically want to set the
2925
+ * state of `isOpen` to false here
2926
+ * @returns
2927
2927
  */
2928
2928
  onRequestClose?: () => void;
2929
- /**
2930
- * Whether or not the modal should be closed when the user clicks outside of it
2931
- * @default true
2929
+ /**
2930
+ * Whether or not the modal should be closed when the user clicks outside of it
2931
+ * @default true
2932
2932
  */
2933
2933
  shouldCloseOnClickOutside?: boolean;
2934
- /**
2935
- * Whether or not the modal should trap focus within itself
2936
- *
2934
+ /**
2935
+ * Whether or not the modal should trap focus within itself
2936
+ *
2937
2937
  */
2938
2938
  shouldTrapFocus?: boolean; /** The base width to apply to the Modal */
2939
2939
  width?: string;
2940
- /**
2941
- * The overflow behavior to apply to the modal
2942
- * @default 'auto'
2940
+ /**
2941
+ * The overflow behavior to apply to the modal
2942
+ * @default 'auto'
2943
2943
  */
2944
2944
  overflow?: 'auto' | 'clip' | 'hidden' | 'scroll' | 'visible';
2945
2945
  };
@@ -2953,8 +2953,8 @@ declare const ModalHeader: _$styled_components_dist_types0.IStyledComponentBase<
2953
2953
  declare const ModalBody: _$styled_components_dist_types0.IStyledComponentBase<"web", _$styled_components0.FastOmit<_$react.DetailedHTMLProps<_$react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
2954
2954
  declare const ModalFooter: _$styled_components_dist_types0.IStyledComponentBase<"web", _$styled_components0.FastOmit<_$react.DetailedHTMLProps<_$react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
2955
2955
  type ModalCloseButtonProps = {
2956
- /**
2957
- * Callback invoked when the button is clicked
2956
+ /**
2957
+ * Callback invoked when the button is clicked
2958
2958
  */
2959
2959
  onClick?: (event: MouseEvent) => void;
2960
2960
  };
@@ -2965,12 +2965,12 @@ declare const ModalCloseButton: ({
2965
2965
  //#endregion
2966
2966
  //#region src/components/Paper/Paper.d.ts
2967
2967
  type PaperProps = ComponentPropsWithoutRef<'div'> & {
2968
- /**
2969
- * The content within Paper component
2968
+ /**
2969
+ * The content within Paper component
2970
2970
  */
2971
2971
  children: ReactNode;
2972
- /**
2973
- * The "elevation" level of the Paper component
2972
+ /**
2973
+ * The "elevation" level of the Paper component
2974
2974
  */
2975
2975
  elevation?: 0 | 1 | 2 | undefined;
2976
2976
  };
@@ -2985,24 +2985,24 @@ declare const Paper: {
2985
2985
  //#endregion
2986
2986
  //#region src/components/ProgressBar/ProgressBar.d.ts
2987
2987
  type ProgressBarProps = ComponentPropsWithoutRef<'div'> & {
2988
- /**
2989
- * Whether the progress bar has a label
2988
+ /**
2989
+ * Whether the progress bar has a label
2990
2990
  */
2991
2991
  hasLabel?: boolean;
2992
- /**
2993
- * Current numeric level of the progress (0 -> 1)
2992
+ /**
2993
+ * Current numeric level of the progress (0 -> 1)
2994
2994
  */
2995
2995
  progress?: number;
2996
- /**
2997
- * Allows user to override default progress bar label colors
2996
+ /**
2997
+ * Allows user to override default progress bar label colors
2998
2998
  */
2999
2999
  labelColorOverride?: string;
3000
- /**
3001
- * Allows user to override default progress bar meter background colors
3000
+ /**
3001
+ * Allows user to override default progress bar meter background colors
3002
3002
  */
3003
3003
  meterBgColorOverride?: string;
3004
- /**
3005
- * Allows user to override default colors
3004
+ /**
3005
+ * Allows user to override default colors
3006
3006
  */
3007
3007
  colorOverride?: string;
3008
3008
  };
@@ -3020,145 +3020,145 @@ declare const ProgressBar: {
3020
3020
  //#endregion
3021
3021
  //#region src/components/Radio/Radio.d.ts
3022
3022
  type RadioProps = Omit<ComponentPropsWithoutRef<'input'>, 'value'> & {
3023
- /**
3024
- * Indicates the state of the radio
3023
+ /**
3024
+ * Indicates the state of the radio
3025
3025
  */
3026
3026
  checked?: boolean;
3027
- /**
3028
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
3027
+ /**
3028
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
3029
3029
  */
3030
3030
  direction?: 'column' | 'row';
3031
- /**
3032
- * Disables input
3031
+ /**
3032
+ * Disables input
3033
3033
  */
3034
3034
  disabled?: boolean;
3035
- /**
3036
- * @ignore // I don't know what to do with this
3037
- * Force a Radio into a particular css state (for debugging)
3035
+ /**
3036
+ * @ignore // I don't know what to do with this
3037
+ * Force a Radio into a particular css state (for debugging)
3038
3038
  */
3039
3039
  forceState?: 'focus' | 'hover';
3040
- /**
3041
- * Indicates that there is an error with the input
3040
+ /**
3041
+ * Indicates that there is an error with the input
3042
3042
  */
3043
3043
  hasError?: boolean;
3044
- /**
3045
- * Provides an ID for the input
3044
+ /**
3045
+ * Provides an ID for the input
3046
3046
  */
3047
3047
  id?: string;
3048
- /**
3049
- * The label for the input
3048
+ /**
3049
+ * The label for the input
3050
3050
  */
3051
3051
  label: JSX.Element | string;
3052
- /**
3053
- * The description for the input
3052
+ /**
3053
+ * The description for the input
3054
3054
  */
3055
3055
  labelDescription?: JSX.Element | string | undefined;
3056
- /**
3057
- * Should match the ID attribute of the radio.
3058
- * Can be used to group together multiple radios
3056
+ /**
3057
+ * Should match the ID attribute of the radio.
3058
+ * Can be used to group together multiple radios
3059
3059
  */
3060
3060
  name?: string;
3061
- /**
3062
- * Callback function invoked when the value changes
3061
+ /**
3062
+ * Callback function invoked when the value changes
3063
3063
  */
3064
3064
  onChange?: (event: ChangeEvent) => unknown;
3065
- /**
3066
- * The value attribute of the input
3065
+ /**
3066
+ * The value attribute of the input
3067
3067
  */
3068
3068
  value?: string;
3069
3069
  };
3070
3070
  declare const Radio: _$react.ForwardRefExoticComponent<Omit<Omit<_$react.DetailedHTMLProps<_$react.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "value"> & {
3071
- /**
3072
- * Indicates the state of the radio
3071
+ /**
3072
+ * Indicates the state of the radio
3073
3073
  */
3074
3074
  checked?: boolean;
3075
- /**
3076
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
3075
+ /**
3076
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
3077
3077
  */
3078
3078
  direction?: "column" | "row";
3079
- /**
3080
- * Disables input
3079
+ /**
3080
+ * Disables input
3081
3081
  */
3082
3082
  disabled?: boolean;
3083
- /**
3084
- * @ignore // I don't know what to do with this
3085
- * Force a Radio into a particular css state (for debugging)
3083
+ /**
3084
+ * @ignore // I don't know what to do with this
3085
+ * Force a Radio into a particular css state (for debugging)
3086
3086
  */
3087
3087
  forceState?: "focus" | "hover";
3088
- /**
3089
- * Indicates that there is an error with the input
3088
+ /**
3089
+ * Indicates that there is an error with the input
3090
3090
  */
3091
3091
  hasError?: boolean;
3092
- /**
3093
- * Provides an ID for the input
3092
+ /**
3093
+ * Provides an ID for the input
3094
3094
  */
3095
3095
  id?: string;
3096
- /**
3097
- * The label for the input
3096
+ /**
3097
+ * The label for the input
3098
3098
  */
3099
3099
  label: JSX.Element | string;
3100
- /**
3101
- * The description for the input
3100
+ /**
3101
+ * The description for the input
3102
3102
  */
3103
3103
  labelDescription?: JSX.Element | string | undefined;
3104
- /**
3105
- * Should match the ID attribute of the radio.
3106
- * Can be used to group together multiple radios
3104
+ /**
3105
+ * Should match the ID attribute of the radio.
3106
+ * Can be used to group together multiple radios
3107
3107
  */
3108
3108
  name?: string;
3109
- /**
3110
- * Callback function invoked when the value changes
3109
+ /**
3110
+ * Callback function invoked when the value changes
3111
3111
  */
3112
3112
  onChange?: (event: ChangeEvent) => unknown;
3113
- /**
3114
- * The value attribute of the input
3113
+ /**
3114
+ * The value attribute of the input
3115
3115
  */
3116
3116
  value?: string;
3117
3117
  } & _$react.RefAttributes<HTMLLabelElement>>;
3118
3118
  //#endregion
3119
3119
  //#region src/components/RadioGroup/RadioGroup.d.ts
3120
3120
  type RadioGroupProps = Omit<ComponentPropsWithoutRef<'div'>, 'onChange'> & {
3121
- /**
3122
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
3121
+ /**
3122
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
3123
3123
  */
3124
3124
  direction?: 'column' | 'row';
3125
- /**
3126
- * Whether RadioGroup is disabled
3125
+ /**
3126
+ * Whether RadioGroup is disabled
3127
3127
  */
3128
3128
  disabled?: boolean;
3129
- /**
3130
- * Error message to be displayed
3129
+ /**
3130
+ * Error message to be displayed
3131
3131
  */
3132
3132
  error?: string | undefined;
3133
- /**
3134
- * The label for the form field
3133
+ /**
3134
+ * The label for the form field
3135
3135
  */
3136
3136
  label?: JSX.Element | string | null | undefined;
3137
- /**
3138
- * The hint/helper text under the label
3137
+ /**
3138
+ * The hint/helper text under the label
3139
3139
  */
3140
3140
  labelDescription?: JSX.Element | string | undefined;
3141
- /**
3142
- * Props that are passed through to the underlying `<Label>` component
3141
+ /**
3142
+ * Props that are passed through to the underlying `<Label>` component
3143
3143
  */
3144
3144
  labelProps?: {
3145
3145
  disabled?: boolean;
3146
3146
  screenReaderOnly?: boolean;
3147
3147
  };
3148
- /**
3149
- * Should match the ID attribute of the radio. Can be used to group together multiple radios
3148
+ /**
3149
+ * Should match the ID attribute of the radio. Can be used to group together multiple radios
3150
3150
  */
3151
3151
  name: string;
3152
- /**
3153
- * Fires on checking or unchecking radios in group
3152
+ /**
3153
+ * Fires on checking or unchecking radios in group
3154
3154
  */
3155
3155
  onChange?: (event: ChangeEvent, value: RadioProps['value']) => unknown;
3156
- /**
3157
- * Array of radios attributes
3156
+ /**
3157
+ * Array of radios attributes
3158
3158
  */
3159
3159
  options: Pick<RadioProps, 'disabled' | 'label' | 'labelDescription' | 'value'>[];
3160
- /**
3161
- * Currently selected radio value
3160
+ /**
3161
+ * Currently selected radio value
3162
3162
  */
3163
3163
  value?: string | undefined;
3164
3164
  };
@@ -3195,55 +3195,55 @@ type Preset = {
3195
3195
  tooltipText?: string;
3196
3196
  };
3197
3197
  type RangeSelectorProps = {
3198
- /**
3199
- * Align the popup to the left or the right of the tigger button
3198
+ /**
3199
+ * Align the popup to the left or the right of the tigger button
3200
3200
  */
3201
3201
  align?: 'left' | 'right';
3202
- /**
3203
- * The variant to be passed to the button component
3202
+ /**
3203
+ * The variant to be passed to the button component
3204
3204
  */
3205
3205
  buttonVariant?: 'input' | 'primary' | 'secondary' | 'tertiary';
3206
- /**
3207
- * The earliest selectable date
3206
+ /**
3207
+ * The earliest selectable date
3208
3208
  */
3209
3209
  earliestDate?: Date;
3210
- /**
3211
- * The latest selectable date
3210
+ /**
3211
+ * The latest selectable date
3212
3212
  */
3213
3213
  latestDate?: Date;
3214
- /**
3215
- * Text to display in the footer
3214
+ /**
3215
+ * Text to display in the footer
3216
3216
  */
3217
3217
  footerText?: JSX.Element | string;
3218
- /**
3219
- * A function that receives a date range object and returns a string to be rendered in the
3220
- * trigger button
3218
+ /**
3219
+ * A function that receives a date range object and returns a string to be rendered in the
3220
+ * trigger button
3221
3221
  */
3222
3222
  format?: (dataRange: DateRangeType) => JSX.Element | string;
3223
- /**
3224
- * Callback fired when the date range changes
3223
+ /**
3224
+ * Callback fired when the date range changes
3225
3225
  */
3226
3226
  onChange?: (dateRange: DateRangeType) => unknown;
3227
3227
  presets?: Preset[];
3228
- /**
3229
- * The date range to be displayed in the picker
3228
+ /**
3229
+ * The date range to be displayed in the picker
3230
3230
  */
3231
3231
  range?: DateRangeType;
3232
- /**
3233
- * Prevent dates in the future from being selected
3232
+ /**
3233
+ * Prevent dates in the future from being selected
3234
3234
  */
3235
3235
  shouldPreventFuture?: boolean;
3236
- /**
3237
- * If true, the button will take up the full width of its container
3236
+ /**
3237
+ * If true, the button will take up the full width of its container
3238
3238
  */
3239
3239
  fullWidth?: boolean;
3240
- /**
3241
- * A custom width for the RangeSelector component (in px, %, or other CSS units)
3240
+ /**
3241
+ * A custom width for the RangeSelector component (in px, %, or other CSS units)
3242
3242
  */
3243
3243
  width?: number | string;
3244
- /**
3245
- * A custom React component to use as the trigger button. The component should accept onClick,
3246
- * children, and other standard button props.
3244
+ /**
3245
+ * A custom React component to use as the trigger button. The component should accept onClick,
3246
+ * children, and other standard button props.
3247
3247
  */
3248
3248
  customTriggerComponent?: ComponentType<Record<string, any>>;
3249
3249
  };
@@ -3269,44 +3269,44 @@ declare const RangeSelector: {
3269
3269
  //#endregion
3270
3270
  //#region src/components/RichTextEditor/RichTextEditor.d.ts
3271
3271
  type RichTextEditorProps = {
3272
- /**
3273
- * Optional id to set aria-labelledby
3272
+ /**
3273
+ * Optional id to set aria-labelledby
3274
3274
  */
3275
3275
  ariaLabelledBy?: string | undefined;
3276
- /**
3277
- * @ignore
3276
+ /**
3277
+ * @ignore
3278
3278
  */
3279
3279
  'data-testid'?: string;
3280
- /**
3281
- * Determines whether editor is clickable/read-only
3280
+ /**
3281
+ * Determines whether editor is clickable/read-only
3282
3282
  */
3283
3283
  disabled?: boolean;
3284
- /**
3285
- * Formats to enable in editor, restricted to rteFormatTypes
3284
+ /**
3285
+ * Formats to enable in editor, restricted to rteFormatTypes
3286
3286
  */
3287
3287
  enabledFormats?: (keyof typeof rteFormatTypes)[];
3288
- /**
3289
- * Function to be called after editor state update
3288
+ /**
3289
+ * Function to be called after editor state update
3290
3290
  */
3291
3291
  onChange?: ((value: NodeElementObject[]) => void) | undefined;
3292
- /**
3293
- * Function to be called when editor loses focus
3292
+ /**
3293
+ * Function to be called when editor loses focus
3294
3294
  */
3295
3295
  onBlur?: ((value: NodeElementObject[]) => void) | undefined;
3296
- /**
3297
- * Placeholder text
3296
+ /**
3297
+ * Placeholder text
3298
3298
  */
3299
3299
  placeholder?: string;
3300
- /**
3301
- * Value of editor based on controlled input
3300
+ /**
3301
+ * Value of editor based on controlled input
3302
3302
  */
3303
3303
  value?: Descendant[];
3304
- /**
3305
- * Whether to update the editor when the value prop changes
3304
+ /**
3305
+ * Whether to update the editor when the value prop changes
3306
3306
  */
3307
3307
  useExternalValue: boolean;
3308
- /**
3309
- * Custom height of editor
3308
+ /**
3309
+ * Custom height of editor
3310
3310
  */
3311
3311
  height?: string | undefined;
3312
3312
  };
@@ -3334,17 +3334,17 @@ declare const rteDeserializeHTML: (htmlString: string) => (Descendant | string |
3334
3334
  //#region src/components/ScreenReaderOnly/ScreenReaderOnly.d.ts
3335
3335
  declare const screenReaderOnlyStyle: _$styled_components0.RuleSet<object>;
3336
3336
  type ScreenReaderOnlyProps = ComponentPropsWithoutRef<'div'> & {
3337
- /**
3338
- * Pass an arbitrary child node
3337
+ /**
3338
+ * Pass an arbitrary child node
3339
3339
  */
3340
3340
  children?: ReactNode;
3341
- /**
3342
- * Display content _only_ when it's focused.
3341
+ /**
3342
+ * Display content _only_ when it's focused.
3343
3343
  */
3344
3344
  focusable?: boolean;
3345
- /**
3346
- * The text that will appear to screenreaders but not be displayed on screen
3347
- * (alternatively you can pass children)
3345
+ /**
3346
+ * The text that will appear to screenreaders but not be displayed on screen
3347
+ * (alternatively you can pass children)
3348
3348
  */
3349
3349
  text?: ReactNode;
3350
3350
  };
@@ -3371,54 +3371,54 @@ type OptionType = {
3371
3371
  };
3372
3372
  type OptionsType = GroupOptionType[] | OptionType[];
3373
3373
  type SelectProps = Omit<ComponentPropsWithRef<'select'>, 'placeholder'> & {
3374
- /**
3375
- * Optional accessible label for when there is no accompanying <label> element
3374
+ /**
3375
+ * Optional accessible label for when there is no accompanying <label> element
3376
3376
  */
3377
3377
  ariaLabel?: string;
3378
- /**
3379
- * Disables Select
3378
+ /**
3379
+ * Disables Select
3380
3380
  */
3381
3381
  disabled?: boolean;
3382
- /**
3383
- * @ignore
3384
- * Force a Select into a particular css state (for debugging)
3382
+ /**
3383
+ * @ignore
3384
+ * Force a Select into a particular css state (for debugging)
3385
3385
  */
3386
3386
  forceState?: 'active' | 'focus' | 'hover';
3387
- /**
3388
- * Should Select occupy 100% of available space
3387
+ /**
3388
+ * Should Select occupy 100% of available space
3389
3389
  */
3390
3390
  fullWidth?: boolean;
3391
- /**
3392
- * Indicates that there is an error with the Select
3391
+ /**
3392
+ * Indicates that there is an error with the Select
3393
3393
  */
3394
3394
  hasError?: boolean;
3395
- /**
3396
- * Change option's label name from "label"
3395
+ /**
3396
+ * Change option's label name from "label"
3397
3397
  */
3398
3398
  labelName?: string;
3399
- /**
3400
- * Allow multiple options in the list to be selected at the same time
3399
+ /**
3400
+ * Allow multiple options in the list to be selected at the same time
3401
3401
  */
3402
3402
  multiple?: boolean;
3403
- /**
3404
- * Data structure to populate option labels & values. (`{ label, value, disabled }`)
3405
- * Additionally this can be used to render option groupings. (`{ groupLabel, groupOptions, disabled }`)
3403
+ /**
3404
+ * Data structure to populate option labels & values. (`{ label, value, disabled }`)
3405
+ * Additionally this can be used to render option groupings. (`{ groupLabel, groupOptions, disabled }`)
3406
3406
  */
3407
3407
  options: OptionsType;
3408
- /**
3409
- * Value of text to appear by default as first option in Select, use `null` for none
3408
+ /**
3409
+ * Value of text to appear by default as first option in Select, use `null` for none
3410
3410
  */
3411
3411
  placeholder?: string | null | undefined;
3412
- /**
3413
- * Prevent the placeholder value from being selected
3412
+ /**
3413
+ * Prevent the placeholder value from being selected
3414
3414
  */
3415
3415
  preventPlaceholderSelection?: boolean;
3416
- /**
3417
- * Make Select a required element
3416
+ /**
3417
+ * Make Select a required element
3418
3418
  */
3419
3419
  required?: boolean;
3420
- /**
3421
- * Change option's value name from "value"
3420
+ /**
3421
+ * Change option's value name from "value"
3422
3422
  */
3423
3423
  valueName?: string;
3424
3424
  };
@@ -3427,59 +3427,59 @@ declare const Select: _$react.ForwardRefExoticComponent<Omit<SelectProps, "ref">
3427
3427
  //#region src/components/Slider/Slider.d.ts
3428
3428
  type ComponentPropsWithoutRefWithoutOnChange = Omit<ComponentPropsWithoutRef<'div'>, 'onChange'>;
3429
3429
  type SliderProps = ComponentPropsWithoutRefWithoutOnChange & {
3430
- /**
3431
- * aria-label for screen-readers to apply to the thumbs. Use an array for more than one thumb.
3432
- * The length of the array must match the number of thumbs in the value array.
3430
+ /**
3431
+ * aria-label for screen-readers to apply to the thumbs. Use an array for more than one thumb.
3432
+ * The length of the array must match the number of thumbs in the value array.
3433
3433
  */
3434
3434
  ariaLabel?: string[] | string | undefined;
3435
- /**
3436
- * aria-labelledby for screen-readers to apply to the thumbs. Used when slider rendered with separate label.
3437
- * Use an array for more than one thumb. The length of the array must match the number of thumbs in the value array.
3435
+ /**
3436
+ * aria-labelledby for screen-readers to apply to the thumbs. Used when slider rendered with separate label.
3437
+ * Use an array for more than one thumb. The length of the array must match the number of thumbs in the value array.
3438
3438
  */
3439
3439
  ariaLabelledby?: string[] | string | undefined;
3440
- /**
3441
- *
3440
+ /**
3441
+ *
3442
3442
  */
3443
3443
  ariaValuetext?: string | ((state: Record<string, unknown>) => unknown);
3444
- /**
3445
- * @ignore
3444
+ /**
3445
+ * @ignore
3446
3446
  */
3447
3447
  'data-testid'?: string;
3448
- /**
3449
- * Determines the initial position(s) of the thumb(s) and the number of thumbs.
3450
- *
3451
- * If a number is passed a slider with one thumb will be rendered.
3452
- * If an array is passed each value will determine the position of one thumb.
3453
- * The values in the array must be sorted.
3454
- *
3455
- * Don't pass a default value if the slider is controlled (i.e. if you already
3456
- * use the `value` prop).
3448
+ /**
3449
+ * Determines the initial position(s) of the thumb(s) and the number of thumbs.
3450
+ *
3451
+ * If a number is passed a slider with one thumb will be rendered.
3452
+ * If an array is passed each value will determine the position of one thumb.
3453
+ * The values in the array must be sorted.
3454
+ *
3455
+ * Don't pass a default value if the slider is controlled (i.e. if you already
3456
+ * use the `value` prop).
3457
3457
  */
3458
3458
  initialValue?: number[] | number | undefined;
3459
- /**
3460
- * If `true` the thumbs can't be moved.
3459
+ /**
3460
+ * If `true` the thumbs can't be moved.
3461
3461
  */
3462
3462
  disabled?: boolean;
3463
- /**
3464
- * The maximum value of the slider.
3463
+ /**
3464
+ * The maximum value of the slider.
3465
3465
  */
3466
3466
  max?: number;
3467
- /**
3468
- * The minimum value of the slider.
3467
+ /**
3468
+ * The minimum value of the slider.
3469
3469
  */
3470
3470
  min?: number;
3471
- /**
3472
- * Callback called on every value change. The function will be called with two arguments,
3473
- * the first being the new value(s) the second being thumb index. **It does not return an event.**
3471
+ /**
3472
+ * Callback called on every value change. The function will be called with two arguments,
3473
+ * the first being the new value(s) the second being thumb index. **It does not return an event.**
3474
3474
  */
3475
3475
  onChange?: (value: number, index?: number) => unknown;
3476
- /**
3477
- * Value to be added or subtracted on each step the slider makes. Must be greater than zero.
3478
- * max - min should be evenly divisible by the step value.
3476
+ /**
3477
+ * Value to be added or subtracted on each step the slider makes. Must be greater than zero.
3478
+ * max - min should be evenly divisible by the step value.
3479
3479
  */
3480
3480
  step?: number;
3481
- /**
3482
- * Like 'initialValue' but for controlled components.
3481
+ /**
3482
+ * Like 'initialValue' but for controlled components.
3483
3483
  */
3484
3484
  value?: number[] | number;
3485
3485
  };
@@ -3503,17 +3503,17 @@ declare const Slider: {
3503
3503
  //#endregion
3504
3504
  //#region src/components/Stack/Stack.d.ts
3505
3505
  type StackProps<T extends ElementType> = ComponentPropsWithoutRef<T> & PropsWithChildren & {
3506
- /**
3507
- * The gap between each item in the stack. Should be one of the spacing values from the theme
3506
+ /**
3507
+ * The gap between each item in the stack. Should be one of the spacing values from the theme
3508
3508
  */
3509
3509
  gap?: keyof DefaultTheme['spacing'];
3510
- /**
3511
- * Vertical is equivalent to `flex-direction: column;`, horizontal is equivalent to `flex-direction: row;`.
3512
- * The default behavior is `vertical`.
3510
+ /**
3511
+ * Vertical is equivalent to `flex-direction: column;`, horizontal is equivalent to `flex-direction: row;`.
3512
+ * The default behavior is `vertical`.
3513
3513
  */
3514
3514
  direction?: 'horizontal' | 'vertical';
3515
- /**
3516
- * The element (e.g. div, span, p) or component to render as the root element.
3515
+ /**
3516
+ * The element (e.g. div, span, p) or component to render as the root element.
3517
3517
  */
3518
3518
  renderAs?: T | 'div';
3519
3519
  };
@@ -3521,24 +3521,24 @@ declare const Stack: _$react.ForwardRefExoticComponent<Omit<StackProps<ElementTy
3521
3521
  //#endregion
3522
3522
  //#region src/components/Switch/Switch.d.ts
3523
3523
  type SwitchProps = Omit<ComponentPropsWithoutRef<'button'>, 'onChange'> & {
3524
- /**
3525
- * Allows user to override default "on" color
3524
+ /**
3525
+ * Allows user to override default "on" color
3526
3526
  */
3527
3527
  colorOverride?: string;
3528
- /**
3529
- * Controls the `aria-disabled` property of the Switch
3528
+ /**
3529
+ * Controls the `aria-disabled` property of the Switch
3530
3530
  */
3531
3531
  disabled?: boolean;
3532
- /**
3533
- * Determines if switch is checked
3532
+ /**
3533
+ * Determines if switch is checked
3534
3534
  */
3535
3535
  isChecked?: boolean;
3536
- /**
3537
- * Callback function invoked when the switch checked state changes
3536
+ /**
3537
+ * Callback function invoked when the switch checked state changes
3538
3538
  */
3539
3539
  onChange?: (isChecked: boolean) => unknown;
3540
- /**
3541
- * Controls wether or not the ON / OFF text is shown
3540
+ /**
3541
+ * Controls wether or not the ON / OFF text is shown
3542
3542
  */
3543
3543
  hideText?: boolean;
3544
3544
  };
@@ -3587,158 +3587,158 @@ declare const variantStyleMap: {
3587
3587
  monospace: _$styled_components0.RuleSet<object>;
3588
3588
  };
3589
3589
  type TextProps = ComponentPropsWithoutRef<'div'> & {
3590
- /**
3591
- * The horizontal alignment
3592
- * <br />
3593
- * _Note: this only affects block elements_
3590
+ /**
3591
+ * The horizontal alignment
3592
+ * <br />
3593
+ * _Note: this only affects block elements_
3594
3594
  */
3595
3595
  align?: keyof typeof alignMap;
3596
- /**
3597
- * Displays text as bold type
3596
+ /**
3597
+ * Displays text as bold type
3598
3598
  */
3599
3599
  bold?: boolean;
3600
- /**
3601
- * Pass an arbitrary child node
3600
+ /**
3601
+ * Pass an arbitrary child node
3602
3602
  */
3603
3603
  children?: ReactNode | undefined;
3604
- /**
3605
- * Allows user to override default button colors
3604
+ /**
3605
+ * Allows user to override default button colors
3606
3606
  */
3607
3607
  colorOverride?: string;
3608
- /**
3609
- * Used to indicate text is part of a "disabled" UI
3608
+ /**
3609
+ * Used to indicate text is part of a "disabled" UI
3610
3610
  */
3611
3611
  disabled?: boolean;
3612
- /**
3613
- * Attempt to keep the text to a single line by truncating with an ellipsis
3614
- * <br />
3615
- * _Note: this only affects block elements_
3612
+ /**
3613
+ * Attempt to keep the text to a single line by truncating with an ellipsis
3614
+ * <br />
3615
+ * _Note: this only affects block elements_
3616
3616
  */
3617
3617
  ellipsis?: boolean;
3618
- /**
3619
- * Display the text as inline content
3618
+ /**
3619
+ * Display the text as inline content
3620
3620
  */
3621
3621
  inline?: boolean;
3622
- /**
3623
- * Displays text as italic type
3622
+ /**
3623
+ * Displays text as italic type
3624
3624
  */
3625
3625
  italic?: boolean;
3626
- /**
3627
- * Prevents text from being highlighted and copied
3626
+ /**
3627
+ * Prevents text from being highlighted and copied
3628
3628
  */
3629
3629
  preventUserSelect?: boolean;
3630
- /**
3631
- * The type of html element to render as
3630
+ /**
3631
+ * The type of html element to render as
3632
3632
  */
3633
3633
  renderAs?: keyof typeof renderMap;
3634
- /**
3635
- * The text style to display
3634
+ /**
3635
+ * The text style to display
3636
3636
  */
3637
3637
  variant?: keyof typeof variantStyleMap;
3638
3638
  };
3639
3639
  declare const Text: _$react.ForwardRefExoticComponent<Omit<_$react.DetailedHTMLProps<_$react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
3640
- /**
3641
- * The horizontal alignment
3642
- * <br />
3643
- * _Note: this only affects block elements_
3640
+ /**
3641
+ * The horizontal alignment
3642
+ * <br />
3643
+ * _Note: this only affects block elements_
3644
3644
  */
3645
3645
  align?: keyof typeof alignMap;
3646
- /**
3647
- * Displays text as bold type
3646
+ /**
3647
+ * Displays text as bold type
3648
3648
  */
3649
3649
  bold?: boolean;
3650
- /**
3651
- * Pass an arbitrary child node
3650
+ /**
3651
+ * Pass an arbitrary child node
3652
3652
  */
3653
3653
  children?: ReactNode | undefined;
3654
- /**
3655
- * Allows user to override default button colors
3654
+ /**
3655
+ * Allows user to override default button colors
3656
3656
  */
3657
3657
  colorOverride?: string;
3658
- /**
3659
- * Used to indicate text is part of a "disabled" UI
3658
+ /**
3659
+ * Used to indicate text is part of a "disabled" UI
3660
3660
  */
3661
3661
  disabled?: boolean;
3662
- /**
3663
- * Attempt to keep the text to a single line by truncating with an ellipsis
3664
- * <br />
3665
- * _Note: this only affects block elements_
3662
+ /**
3663
+ * Attempt to keep the text to a single line by truncating with an ellipsis
3664
+ * <br />
3665
+ * _Note: this only affects block elements_
3666
3666
  */
3667
3667
  ellipsis?: boolean;
3668
- /**
3669
- * Display the text as inline content
3668
+ /**
3669
+ * Display the text as inline content
3670
3670
  */
3671
3671
  inline?: boolean;
3672
- /**
3673
- * Displays text as italic type
3672
+ /**
3673
+ * Displays text as italic type
3674
3674
  */
3675
3675
  italic?: boolean;
3676
- /**
3677
- * Prevents text from being highlighted and copied
3676
+ /**
3677
+ * Prevents text from being highlighted and copied
3678
3678
  */
3679
3679
  preventUserSelect?: boolean;
3680
- /**
3681
- * The type of html element to render as
3680
+ /**
3681
+ * The type of html element to render as
3682
3682
  */
3683
3683
  renderAs?: keyof typeof renderMap;
3684
- /**
3685
- * The text style to display
3684
+ /**
3685
+ * The text style to display
3686
3686
  */
3687
3687
  variant?: keyof typeof variantStyleMap;
3688
3688
  } & _$react.RefAttributes<HTMLElement>>;
3689
3689
  //#endregion
3690
3690
  //#region src/components/Thumbnail/Thumbnail.d.ts
3691
3691
  type IconThumbnailProps = {
3692
- /**
3693
- * The desired display of the thumbnail, either wide or square
3692
+ /**
3693
+ * The desired display of the thumbnail, either wide or square
3694
3694
  */
3695
3695
  thumbnailImageType?: never;
3696
- /**
3697
- * The URL of the thumbnail image to display
3696
+ /**
3697
+ * The URL of the thumbnail image to display
3698
3698
  */
3699
3699
  thumbnailUrl?: never;
3700
- /**
3701
- * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
3700
+ /**
3701
+ * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
3702
3702
  */
3703
3703
  icon: IconNameType;
3704
- /**
3705
- * The color of the icon
3704
+ /**
3705
+ * The color of the icon
3706
3706
  */
3707
3707
  iconColor?: string;
3708
3708
  };
3709
3709
  type ImageThumbnailProps = {
3710
- /**
3711
- * The desired display of the thumbnail, either wide or square
3710
+ /**
3711
+ * The desired display of the thumbnail, either wide or square
3712
3712
  */
3713
3713
  thumbnailImageType?: 'square' | 'wide' | undefined;
3714
- /**
3715
- * The URL of the thumbnail image to display
3714
+ /**
3715
+ * The URL of the thumbnail image to display
3716
3716
  */
3717
3717
  thumbnailUrl: string[] | string | null;
3718
- /**
3719
- * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
3718
+ /**
3719
+ * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
3720
3720
  */
3721
3721
  icon?: never;
3722
- /**
3723
- * The color of the icon
3722
+ /**
3723
+ * The color of the icon
3724
3724
  */
3725
3725
  iconColor?: never;
3726
3726
  };
3727
3727
  type ThumbnailProps = ComponentPropsWithoutRef<'div'> & {
3728
- /**
3729
- * Text that displays in the bottom right hand corner of the thumbnail, usually the media duration
3728
+ /**
3729
+ * Text that displays in the bottom right hand corner of the thumbnail, usually the media duration
3730
3730
  */
3731
3731
  bottomRightText?: string;
3732
- /**
3733
- * Icon to display in bottom right corner of the thumbnail
3732
+ /**
3733
+ * Icon to display in bottom right corner of the thumbnail
3734
3734
  */
3735
3735
  bottomRightIcon?: IconNameType;
3736
- /**
3737
- * The type of gradient to show either behind the icon or when there is no thumbnail image
3736
+ /**
3737
+ * The type of gradient to show either behind the icon or when there is no thumbnail image
3738
3738
  */
3739
3739
  gradientBackground?: GradientNameType;
3740
- /**
3741
- * Width of the thumbnail. By default, the thumbnail will grow to fit its container.
3740
+ /**
3741
+ * Width of the thumbnail. By default, the thumbnail will grow to fit its container.
3742
3742
  */
3743
3743
  width?: string;
3744
3744
  } & (IconThumbnailProps | ImageThumbnailProps);
@@ -3759,12 +3759,12 @@ declare const Thumbnail: {
3759
3759
  //#endregion
3760
3760
  //#region src/components/ThumbnailCollage/ThumbnailCollage.d.ts
3761
3761
  type ThumbnailCollageProps = {
3762
- /**
3763
- * An array of image urls to show in the thumbnail. Supports up to 3 images
3762
+ /**
3763
+ * An array of image urls to show in the thumbnail. Supports up to 3 images
3764
3764
  */
3765
3765
  thumbnailUrls: string[];
3766
- /**
3767
- * The type of gradient to show when there are no thumbnail urls
3766
+ /**
3767
+ * The type of gradient to show when there are no thumbnail urls
3768
3768
  */
3769
3769
  gradientBackground?: GradientNameType;
3770
3770
  };
@@ -3777,41 +3777,41 @@ declare const ThumbnailCollage: ({
3777
3777
  //#region src/components/Toast/Toast.d.ts
3778
3778
  type ToastVariants = 'dangerous' | 'error' | 'success' | 'warning';
3779
3779
  type ToastProps = ComponentPropsWithoutRef<'div'> & {
3780
- /**
3781
- * A function that will be invoked when the action button is clicked instead of the internal handler
3780
+ /**
3781
+ * A function that will be invoked when the action button is clicked instead of the internal handler
3782
3782
  */
3783
3783
  actionInterceptor?: (() => void) | undefined;
3784
- /**
3785
- * The text of the "action" button on the right
3784
+ /**
3785
+ * The text of the "action" button on the right
3786
3786
  */
3787
3787
  actionLabel?: string | undefined;
3788
- /**
3789
- * A hex value that will override the color values defined by `variant`
3788
+ /**
3789
+ * A hex value that will override the color values defined by `variant`
3790
3790
  */
3791
3791
  colorOverride?: string | undefined;
3792
- /**
3793
- * @ignore
3794
- * Avoids animation and positions Toast in normal flow for documentation/testing purposes
3792
+ /**
3793
+ * @ignore
3794
+ * Avoids animation and positions Toast in normal flow for documentation/testing purposes
3795
3795
  */
3796
3796
  renderInPlace?: boolean;
3797
- /**
3798
- * Determines whether Toast is displayed
3797
+ /**
3798
+ * Determines whether Toast is displayed
3799
3799
  */
3800
3800
  isOpen?: boolean;
3801
- /**
3802
- * The message displayed in the toast
3801
+ /**
3802
+ * The message displayed in the toast
3803
3803
  */
3804
3804
  message: string;
3805
- /**
3806
- * Callback that is invoked when toasts closes (via timeout or close button)
3805
+ /**
3806
+ * Callback that is invoked when toasts closes (via timeout or close button)
3807
3807
  */
3808
3808
  onClose: () => void;
3809
- /**
3810
- * The time in ms before the Toast calls the onClose function
3809
+ /**
3810
+ * The time in ms before the Toast calls the onClose function
3811
3811
  */
3812
3812
  timeout?: number | undefined;
3813
- /**
3814
- * The kind of Toast to display
3813
+ /**
3814
+ * The kind of Toast to display
3815
3815
  */
3816
3816
  variant?: ToastVariants | undefined;
3817
3817
  };
@@ -3851,49 +3851,49 @@ declare const ToastProvider: ({
3851
3851
  //#endregion
3852
3852
  //#region src/components/Tooltip/Tooltip.d.ts
3853
3853
  type TooltipProps = Omit<ComponentPropsWithoutRef<'div'>, 'id'> & {
3854
- /**
3855
- * The node that will be wrapped by the Tooltip
3854
+ /**
3855
+ * The node that will be wrapped by the Tooltip
3856
3856
  */
3857
3857
  children: ReactNode;
3858
- /**
3859
- * Where the tooltip should appear in relation to wrapped component
3858
+ /**
3859
+ * Where the tooltip should appear in relation to wrapped component
3860
3860
  */
3861
3861
  direction?: 'bottom' | 'left' | 'right' | 'top';
3862
- /**
3863
- * Length of time to wait before dismissing Tooltip for click eventType
3862
+ /**
3863
+ * Length of time to wait before dismissing Tooltip for click eventType
3864
3864
  */
3865
3865
  duration?: boolean | number | string;
3866
- /**
3867
- * The type of event that triggers display of Tooltip
3866
+ /**
3867
+ * The type of event that triggers display of Tooltip
3868
3868
  */
3869
3869
  eventType?: 'click' | 'hover';
3870
- /**
3871
- * @ignore
3872
- * Force a Tooltip to display it's content without user interaction (for debugging)
3870
+ /**
3871
+ * @ignore
3872
+ * Force a Tooltip to display it's content without user interaction (for debugging)
3873
3873
  */
3874
3874
  forceState?: 'open' | undefined;
3875
- /**
3876
- * ID for tooltip (automatically created if omitted)
3875
+ /**
3876
+ * ID for tooltip (automatically created if omitted)
3877
3877
  */
3878
3878
  id?: string | null | undefined;
3879
- /**
3880
- * The content that will appear in the Tooltip popup
3879
+ /**
3880
+ * The content that will appear in the Tooltip popup
3881
3881
  */
3882
3882
  label: ReactNode;
3883
- /**
3884
- * The maximum number of characters to display inside the Tooltip
3883
+ /**
3884
+ * The maximum number of characters to display inside the Tooltip
3885
3885
  */
3886
3886
  maxChars?: number | null;
3887
- /**
3888
- * Whether content within the label should wrap
3887
+ /**
3888
+ * Whether content within the label should wrap
3889
3889
  */
3890
3890
  shouldWrap?: boolean;
3891
- /**
3892
- * Color to override background of the tooltip.
3891
+ /**
3892
+ * Color to override background of the tooltip.
3893
3893
  */
3894
3894
  backgroundColorOverride?: string;
3895
- /**
3896
- * Color to override font color of the tooltip.
3895
+ /**
3896
+ * Color to override font color of the tooltip.
3897
3897
  */
3898
3898
  fontColorOverride?: string;
3899
3899
  };
@@ -3917,20 +3917,20 @@ declare const Tooltip: {
3917
3917
  //#endregion
3918
3918
  //#region src/components/Truncate/Truncate.d.ts
3919
3919
  type TruncateProps = {
3920
- /**
3921
- * Prevent ellipsis from truncating mid-word
3920
+ /**
3921
+ * Prevent ellipsis from truncating mid-word
3922
3922
  */
3923
3923
  breakOnWords?: boolean;
3924
- /**
3925
- * The string to be truncated
3924
+ /**
3925
+ * The string to be truncated
3926
3926
  */
3927
3927
  children: string | null | undefined;
3928
- /**
3929
- * The maximum number of characters to display inside the Tooltip
3928
+ /**
3929
+ * The maximum number of characters to display inside the Tooltip
3930
3930
  */
3931
3931
  maxChars: number;
3932
- /**
3933
- * A string to append to the truncated string
3932
+ /**
3933
+ * A string to append to the truncated string
3934
3934
  */
3935
3935
  terminator?: string;
3936
3936
  };
@@ -3946,35 +3946,35 @@ declare const Truncate: {
3946
3946
  //#endregion
3947
3947
  //#region src/components/WistiaLogo/WistiaLogo.d.ts
3948
3948
  type WistiaLogoProps = Omit<ComponentPropsWithoutRef<'svg'>, 'href'> & {
3949
- /**
3950
- * An optional accessible description for the logo
3949
+ /**
3950
+ * An optional accessible description for the logo
3951
3951
  */
3952
3952
  description?: string;
3953
- /**
3954
- * Height, in pixels, of the logo
3953
+ /**
3954
+ * Height, in pixels, of the logo
3955
3955
  */
3956
3956
  height?: number;
3957
- /**
3958
- * @ignore
3959
- * Change the color when hovering over the logo
3957
+ /**
3958
+ * @ignore
3959
+ * Change the color when hovering over the logo
3960
3960
  */
3961
3961
  hoverColor?: string;
3962
- /**
3963
- * Display just the icon portion of the logo (ie. hide `Wistia` text)
3964
- * note: there is no analogue to this because by brand guidelines, the
3965
- * `Wistia` text must not be displayed without the "flags" iconography
3962
+ /**
3963
+ * Display just the icon portion of the logo (ie. hide `Wistia` text)
3964
+ * note: there is no analogue to this because by brand guidelines, the
3965
+ * `Wistia` text must not be displayed without the "flags" iconography
3966
3966
  */
3967
3967
  iconOnly?: boolean;
3968
- /**
3969
- * If provided, will wrap the logo in a link
3968
+ /**
3969
+ * If provided, will wrap the logo in a link
3970
3970
  */
3971
3971
  href?: string;
3972
- /**
3973
- * An accessible title for the logo (defaults to "Wistia Logo")
3972
+ /**
3973
+ * An accessible title for the logo (defaults to "Wistia Logo")
3974
3974
  */
3975
3975
  title?: string;
3976
- /**
3977
- * Style of the logo
3976
+ /**
3977
+ * Style of the logo
3978
3978
  */
3979
3979
  variant?: 'dark' | 'light' | 'standard';
3980
3980
  };