@wistia/vhs 6.0.1 → 6.0.2-beta.d28be0f4.1171db2

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
@@ -3,9 +3,9 @@ import { ChangeEvent, ComponentClass, ComponentProps, ComponentPropsWithRef, Com
3
3
  import { DefaultTheme, IStyledComponent, RuleSet, css } from "styled-components";
4
4
  import { Field, FormikErrors, FormikHelpers, FormikProps, useFormikContext } from "formik";
5
5
  import { Editor } from "slate";
6
+ import "slate-history";
6
7
  import { ReactEditor } from "slate-react";
7
8
  import { DropdownMenuCheckboxItemProps, DropdownMenuContentProps, DropdownMenuItemProps, DropdownMenuProps, DropdownMenuRadioGroup as MenuRadioGroup, DropdownMenuRadioItemProps } from "@radix-ui/react-dropdown-menu";
8
-
9
9
  //#region src/@types/vhs-theme.d.ts
10
10
  interface VHSTheme {
11
11
  readonly breakpoint: {
@@ -229,55 +229,55 @@ type DefaultLinkWrapperProps = {
229
229
  };
230
230
  type LinkProps = ComponentPropsWithoutRef<"a"> & {
231
231
  /**
232
- * A Promise to invoke before navigating to location.
233
- * _Caution: if used with `external` type prop a new window will **not** be opened_
234
- */
232
+ * A Promise to invoke before navigating to location.
233
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
234
+ */
235
235
  beforeAction?: (() => Promise<void>) | (() => void);
236
236
  /**
237
- * The content that will be rendered inside the link
238
- */
237
+ * The content that will be rendered inside the link
238
+ */
239
239
  children: ReactNode;
240
240
  /**
241
- * Disables Link
242
- */
241
+ * Disables Link
242
+ */
243
243
  disabled?: boolean;
244
244
  /**
245
- * @ignore
246
- * Force a Link into a particular css state (for debugging)
247
- */
245
+ * @ignore
246
+ * Force a Link into a particular css state (for debugging)
247
+ */
248
248
  forceState?: "active" | "focus" | "hover";
249
249
  /**
250
- * The entity to link to (url, email address, telephone number)
251
- */
250
+ * The entity to link to (url, email address, telephone number)
251
+ */
252
252
  href: string;
253
253
  /**
254
- * Use this if your link is "nested" inside another link
255
- */
254
+ * Use this if your link is "nested" inside another link
255
+ */
256
256
  nested?: boolean;
257
257
  /**
258
- * An object that will be converted into a search parameter string and appended to
259
- * the `to` prop value
260
- */
258
+ * An object that will be converted into a search parameter string and appended to
259
+ * the `to` prop value
260
+ */
261
261
  params?: LinkURLParameters;
262
262
  /**
263
- * Type of link to display
264
- *
265
- * * `email` creates a mailto
266
- * * `phone` creates a telephone number
267
- * * `external` will open links in a new window
268
- */
263
+ * Type of link to display
264
+ *
265
+ * * `email` creates a mailto
266
+ * * `phone` creates a telephone number
267
+ * * `external` will open links in a new window
268
+ */
269
269
  type?: LinkTypes;
270
270
  /**
271
- * Will only display an underline when the Link is in a hover state
272
- */
271
+ * Will only display an underline when the Link is in a hover state
272
+ */
273
273
  underlineOnHover?: boolean;
274
274
  /**
275
- * Renders a link without any of the default styling applied
276
- */
275
+ * Renders a link without any of the default styling applied
276
+ */
277
277
  unstyled?: boolean;
278
278
  /**
279
- * The visual type of Link to display
280
- */
279
+ * The visual type of Link to display
280
+ */
281
281
  variant?: "dangerous" | "primary" | "secondary";
282
282
  };
283
283
  declare const Link$1: ForwardRefExoticComponent<LinkProps & RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
@@ -293,13 +293,7 @@ type VHSProviderProps = {
293
293
  skipAnimations?: boolean;
294
294
  theme?: Record<string, unknown>;
295
295
  };
296
- declare const VHSProvider: ({
297
- children,
298
- theme,
299
- globalStylesIncluded,
300
- skipAnimations,
301
- Link
302
- }: VHSProviderProps) => ReactNode;
296
+ declare const VHSProvider: ({ children, theme, globalStylesIncluded, skipAnimations, Link }: VHSProviderProps) => ReactNode;
303
297
  //#endregion
304
298
  //#region src/hooks/useTheme/useTheme.d.ts
305
299
  declare const useTheme: <T extends DefaultTheme = DefaultTheme>() => T;
@@ -309,7 +303,7 @@ type ColorKeysFromTheme<Theme extends DefaultTheme = DefaultTheme> = keyof Theme
309
303
  type UseThemeColor = {
310
304
  (): DefaultTheme["color"];
311
305
  <T extends DefaultTheme, K extends ColorKeysFromTheme<T>>(param: K): T["color"][K];
312
- <T extends DefaultTheme, K extends ColorKeysFromTheme<T>[]>(param: [...K]): { [Index in keyof K]: T["color"][K[Index] & keyof T["color"]] };
306
+ <T extends DefaultTheme, K extends ColorKeysFromTheme<T>[]>(param: [...K]): { [Index in keyof K]: T["color"][K[Index] & keyof T["color"]]; };
313
307
  };
314
308
  declare const useThemeColor: UseThemeColor;
315
309
  //#endregion
@@ -320,37 +314,37 @@ type OnBeforeHideInterface = {
320
314
  };
321
315
  type ModalBaseContentProps = {
322
316
  /**
323
- * Class name applied to the modal root
324
- */
317
+ * Class name applied to the modal root
318
+ */
325
319
  className?: string | undefined;
326
320
  /**
327
- * Render the modal initially in shown state
328
- */
321
+ * Render the modal initially in shown state
322
+ */
329
323
  initialShownState?: boolean;
330
324
  /**
331
- * The modal can be dismissed via esc button
332
- */
325
+ * The modal can be dismissed via esc button
326
+ */
333
327
  isDismissible?: boolean;
334
328
  /**
335
- * Callback invoked before the modal is hidden
336
- */
329
+ * Callback invoked before the modal is hidden
330
+ */
337
331
  onBeforeHide?: (() => OnBeforeHideInterface) | undefined;
338
332
  /**
339
- * Callback invoked when the modal is dismissed
340
- */
333
+ * Callback invoked when the modal is dismissed
334
+ */
341
335
  onHide?: ((...args: unknown[]) => unknown) | undefined;
342
336
  /**
343
- * Callback invoked when the modal is shown
344
- */
337
+ * Callback invoked when the modal is shown
338
+ */
345
339
  onShow?: ((...args: unknown[]) => unknown) | undefined;
346
340
  /**
347
- * Optional function that exposes the `hide` function at the call site allowing
348
- * the option to call the `hide` function from outside of this component
349
- */
341
+ * Optional function that exposes the `hide` function at the call site allowing
342
+ * the option to call the `hide` function from outside of this component
343
+ */
350
344
  render?: (attemptHide: () => unknown) => ReactNode;
351
345
  /**
352
- * function(show, ref) that returns a node to open the modal
353
- */
346
+ * function(show, ref) that returns a node to open the modal
347
+ */
354
348
  toggle?: ((show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode) | undefined;
355
349
  };
356
350
  declare const ModalBase: FC<ModalBaseContentProps>;
@@ -358,122 +352,122 @@ declare const ModalBase: FC<ModalBaseContentProps>;
358
352
  //#region src/components/ActionModal/ActionModal.d.ts
359
353
  type ActionModalProps = ComponentPropsWithoutRef<"div"> & {
360
354
  /**
361
- * Horizontally align modal to the left, center, or right of the container
362
- */
355
+ * Horizontally align modal to the left, center, or right of the container
356
+ */
363
357
  alignHorizontal?: "center" | "left" | "normal" | "right";
364
358
  /**
365
- * Vertically align modal to the top, center, or bottom of the container
366
- */
359
+ * Vertically align modal to the top, center, or bottom of the container
360
+ */
367
361
  alignVertical?: "bottom" | "center" | "normal" | "top";
368
362
  /**
369
- * Buttons to be shown at the bottom of the modal
370
- */
363
+ * Buttons to be shown at the bottom of the modal
364
+ */
371
365
  buttons?: ReactNode | ((hide: () => void) => ReactNode);
372
366
  /**
373
- * Contents of the modal
374
- */
367
+ * Contents of the modal
368
+ */
375
369
  children?: ReactNode;
376
370
  /**
377
- * Class to be applied to the base element of the modal
378
- */
371
+ * Class to be applied to the base element of the modal
372
+ */
379
373
  className?: string;
380
374
  /**
381
- * A prop that determines whether the modal will span the entirety of the screen vertically
382
- */
375
+ * A prop that determines whether the modal will span the entirety of the screen vertically
376
+ */
383
377
  fullHeight?: boolean;
384
378
  /**
385
- * Allows user to override default icon color
386
- */
379
+ * Allows user to override default icon color
380
+ */
387
381
  closeIconColorOverride?: string;
388
382
  /**
389
- * Increase the zIndex of the Modal, this should be used when calling ActionModal from a Menu
390
- * this will prevent the Menu from staying above the ActionModal
391
- */
383
+ * Increase the zIndex of the Modal, this should be used when calling ActionModal from a Menu
384
+ * this will prevent the Menu from staying above the ActionModal
385
+ */
392
386
  elevated?: boolean;
393
387
  /**
394
- * Optional illustration to display alongside the modal
395
- */
388
+ * Optional illustration to display alongside the modal
389
+ */
396
390
  illustration?: ReactNode;
397
391
  /**
398
- * Background color that appears behind the optional illustration
399
- * Can be any css background color or "blue", "brandBlue", "green",
400
- * "pink", "purple", or "yellow" for theme colors
401
- */
392
+ * Background color that appears behind the optional illustration
393
+ * Can be any css background color or "blue", "brandBlue", "green",
394
+ * "pink", "purple", or "yellow" for theme colors
395
+ */
402
396
  illustrationBackgroundColor?: string;
403
397
  /**
404
- * Render the modal initially in shown state
405
- */
398
+ * Render the modal initially in shown state
399
+ */
406
400
  initialShownState?: boolean;
407
401
  /**
408
- * Allow the user to close the modal via x button or backdrop click
409
- */
402
+ * Allow the user to close the modal via x button or backdrop click
403
+ */
410
404
  isDismissible?: boolean;
411
405
  /**
412
- * Callback invoked before the modal is hidden
413
- */
406
+ * Callback invoked before the modal is hidden
407
+ */
414
408
  onBeforeHide?: () => OnBeforeHideInterface;
415
409
  /**
416
- * Callback invoked when the modal is dismissed
417
- */
410
+ * Callback invoked when the modal is dismissed
411
+ */
418
412
  onHide?: () => void;
419
413
  /**
420
- * Callback invoked when the modal is shown
421
- */
414
+ * Callback invoked when the modal is shown
415
+ */
422
416
  onShow?: () => void;
423
417
  /**
424
- * Optional function that exposes the `hide` function at the call site allowing
425
- * the option to call the `hide` function from outside of this component
426
- */
418
+ * Optional function that exposes the `hide` function at the call site allowing
419
+ * the option to call the `hide` function from outside of this component
420
+ */
427
421
  render?: (hide: (event?: MouseEvent) => void) => ReactNode;
428
422
  /**
429
- * Title to display in the modal
430
- */
423
+ * Title to display in the modal
424
+ */
431
425
  title: string;
432
426
  /**
433
- * function(show, ref) that returns a node to open the modal
434
- */
427
+ * function(show, ref) that returns a node to open the modal
428
+ */
435
429
  toggle?: (show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode;
436
430
  /**
437
- * The css width property of the modal. Ex - 'max-content', '532px', '100%', etc
438
- */
431
+ * The css width property of the modal. Ex - 'max-content', '532px', '100%', etc
432
+ */
439
433
  width?: string;
440
434
  };
441
435
  /**
442
- * @deprecated Please use Modal component, see [documentation](?path=/docs/components-modal--docs).
443
- *
444
- * #### Why ActionModal is being deprecated
445
- * ActionModal's API tightly couples the modal itself with the button or element that toggles it. This makes it difficult to
446
- * implement in several scenarios (such as within a Menu) or if it needs to be programatically opened by an external action.
447
- *
448
- * [Modal](?path=/docs/components-modal--docs) allows for a separate state control to toggle its visibility and is also more composable
449
- * allowing for more variation.
450
- */
436
+ * @deprecated Please use Modal component, see [documentation](?path=/docs/components-modal--docs).
437
+ *
438
+ * #### Why ActionModal is being deprecated
439
+ * ActionModal's API tightly couples the modal itself with the button or element that toggles it. This makes it difficult to
440
+ * implement in several scenarios (such as within a Menu) or if it needs to be programatically opened by an external action.
441
+ *
442
+ * [Modal](?path=/docs/components-modal--docs) allows for a separate state control to toggle its visibility and is also more composable
443
+ * allowing for more variation.
444
+ */
451
445
  declare const ActionModal: FC<ActionModalProps>;
452
446
  //#endregion
453
447
  //#region src/components/Avatar/Avatar.d.ts
454
448
  type AvatarInstanceType = "image" | "initials";
455
449
  type AvatarProps = ComponentPropsWithoutRef<"div"> & {
456
450
  /**
457
- * The height and width of the avatar
458
- */
451
+ * The height and width of the avatar
452
+ */
459
453
  heightAndWidth?: number;
460
454
  /**
461
- * The URL of the image to display
462
- */
455
+ * The URL of the image to display
456
+ */
463
457
  imageUrl?: string | null;
464
458
  /**
465
- * Initials to display if no image is provided
466
- *
467
- * _note: only first initial shown regardless of characters provided_
468
- */
459
+ * Initials to display if no image is provided
460
+ *
461
+ * _note: only first initial shown regardless of characters provided_
462
+ */
469
463
  initials?: string | null;
470
464
  /**
471
- * A string that will deterministicly set the background color of the avatar
472
- */
465
+ * A string that will deterministicly set the background color of the avatar
466
+ */
473
467
  name?: string | null;
474
468
  /**
475
- * A callback that is invoked after the image has loaded or failed to load
476
- */
469
+ * A callback that is invoked after the image has loaded or failed to load
470
+ */
477
471
  onImageLoad?: (avatarType: AvatarInstanceType) => void;
478
472
  };
479
473
  declare const Avatar: FC<AvatarProps>;
@@ -493,24 +487,24 @@ declare const alignHorizontalMap: {
493
487
  };
494
488
  type BackdropProps = ComponentPropsWithoutRef<"div"> & {
495
489
  /**
496
- * Optional prop to align the child content along the horizontal axis
497
- */
490
+ * Optional prop to align the child content along the horizontal axis
491
+ */
498
492
  alignHorizontal?: keyof typeof alignHorizontalMap;
499
493
  /**
500
- * Optional prop to align the child content along the vertical axis
501
- */
494
+ * Optional prop to align the child content along the vertical axis
495
+ */
502
496
  alignVertical?: keyof typeof alignVerticalMap;
503
497
  /**
504
- * Color of the backdrop
505
- */
498
+ * Color of the backdrop
499
+ */
506
500
  backgroundColor?: string;
507
501
  /**
508
- * Pass an arbitrary child node
509
- */
502
+ * Pass an arbitrary child node
503
+ */
510
504
  children?: ReactNode;
511
505
  /**
512
- * increase the z-index (workaround for ActionModals called within Menu)
513
- */
506
+ * increase the z-index (workaround for ActionModals called within Menu)
507
+ */
514
508
  elevated?: boolean;
515
509
  };
516
510
  declare const Backdrop: FC<BackdropProps>;
@@ -522,61 +516,61 @@ type OverflowObject = {
522
516
  };
523
517
  type BackgroundImageProps = Omit<ComponentPropsWithoutRef<"img">, "src"> & {
524
518
  /**
525
- * The content that will be rendered inside
526
- */
519
+ * The content that will be rendered inside
520
+ */
527
521
  children?: ReactNode;
528
522
  /**
529
- * Sets whether a background image's position is fixed within the viewport,
530
- * or scrolls with its containing block. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-attachment).
531
- */
523
+ * Sets whether a background image's position is fixed within the viewport,
524
+ * or scrolls with its containing block. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-attachment).
525
+ */
532
526
  attachment?: string;
533
527
  /**
534
- * Sets whether an element's background extends underneath its border box,
535
- * padding box, or content box. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip).
536
- */
528
+ * Sets whether an element's background extends underneath its border box,
529
+ * padding box, or content box. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip).
530
+ */
537
531
  clip?: string;
538
532
  /**
539
- * Color (as hex) of the component
540
- */
533
+ * Color (as hex) of the component
534
+ */
541
535
  color?: string | undefined;
542
536
  /**
543
- * Height of the component
544
- */
537
+ * Height of the component
538
+ */
545
539
  height?: string;
546
540
  /**
547
- * Sets the background's origin: from the border start, inside the border, or inside the padding.
548
- * _Note: origin is ignored when attachment is `fixed`._
549
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-origin).
550
- */
541
+ * Sets the background's origin: from the border start, inside the border, or inside the padding.
542
+ * _Note: origin is ignored when attachment is `fixed`._
543
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-origin).
544
+ */
551
545
  origin?: string;
552
546
  /**
553
- * Sets the desired behavior for an element's overflow (i.e. when an element's content is
554
- * too big to fit in its block formatting context).
555
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
556
- */
547
+ * Sets the desired behavior for an element's overflow (i.e. when an element's content is
548
+ * too big to fit in its block formatting context).
549
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
550
+ */
557
551
  overflow?: OverflowObject | string;
558
552
  /**
559
- * Sets the initial position for each image; relative to the position layer
560
- * set by origin. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position).
561
- */
553
+ * Sets the initial position for each image; relative to the position layer
554
+ * set by origin. [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position).
555
+ */
562
556
  position?: string;
563
557
  /**
564
- * Sets how background images are repeated.
565
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat).
566
- */
558
+ * Sets how background images are repeated.
559
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat).
560
+ */
567
561
  repeat?: string;
568
562
  /**
569
- * Sets the size of the element's background image.
570
- * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size).
571
- */
563
+ * Sets the size of the element's background image.
564
+ * [Read more](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size).
565
+ */
572
566
  size?: string;
573
567
  /**
574
- * URL(s) to image file
575
- */
568
+ * URL(s) to image file
569
+ */
576
570
  src?: string[] | string;
577
571
  /**
578
- * Width of the component
579
- */
572
+ * Width of the component
573
+ */
580
574
  width?: string;
581
575
  };
582
576
  declare const BackgroundImage: FC<BackgroundImageProps>;
@@ -704,16 +698,16 @@ type IconNameType = keyof typeof iconMap;
704
698
  type BadgeColorScheme = "brandBlue" | "error" | "green" | "grey" | "orange" | "pink" | "purple" | "red" | "success" | "warning" | "yellow";
705
699
  type BadgeProps = ComponentPropsWithoutRef<"div"> & {
706
700
  /**
707
- * The color scheme to use for the badge
708
- */
701
+ * The color scheme to use for the badge
702
+ */
709
703
  colorScheme?: BadgeColorScheme;
710
704
  /**
711
- * The icon to display in the badge
712
- */
705
+ * The icon to display in the badge
706
+ */
713
707
  icon?: IconNameType;
714
708
  /**
715
- * The text to display in the badge
716
- */
709
+ * The text to display in the badge
710
+ */
717
711
  label: string;
718
712
  };
719
713
  declare const Badge: FC<BadgeProps>;
@@ -722,37 +716,30 @@ declare const Badge: FC<BadgeProps>;
722
716
  type BodyProps = {
723
717
  children?: ReactNode;
724
718
  };
725
- declare const Body: ({
726
- children
727
- }: BodyProps) => JSX.Element;
719
+ declare const Body: ({ children }: BodyProps) => JSX.Element;
728
720
  type TitleProps = {
729
721
  children?: ReactNode;
730
722
  };
731
- declare const Title: ({
732
- children
733
- }: TitleProps) => JSX.Element;
723
+ declare const Title: ({ children }: TitleProps) => JSX.Element;
734
724
  type RightGutterProps = {
735
725
  children?: ReactNode;
736
726
  verticalAlign?: string;
737
727
  };
738
- declare const RightGutter: ({
739
- verticalAlign,
740
- children
741
- }: RightGutterProps) => JSX.Element;
728
+ declare const RightGutter: ({ verticalAlign, children }: RightGutterProps) => JSX.Element;
742
729
  //#endregion
743
730
  //#region src/components/Banner/Banner.d.ts
744
731
  type BannerProps = ComponentPropsWithoutRef<"div"> & {
745
732
  /**
746
- * color string
747
- */
733
+ * color string
734
+ */
748
735
  backgroundColor?: string;
749
736
  /**
750
- * Pass an arbitrary child node
751
- */
737
+ * Pass an arbitrary child node
738
+ */
752
739
  children?: ReactNode;
753
740
  /**
754
- * icon name from the icon library to be displayed on left side of banner
755
- */
741
+ * icon name from the icon library to be displayed on left side of banner
742
+ */
756
743
  icon?: ReactNode;
757
744
  };
758
745
  declare const Banner: FC<BannerProps> & {
@@ -768,90 +755,90 @@ type Gap = {
768
755
  };
769
756
  type BoxProps = ComponentPropsWithoutRef<"div"> & {
770
757
  /**
771
- * Specifies how the browser distributes space between and around
772
- * items along the cross-axis of their container; has no effect on
773
- * single line flexible boxes
774
- */
758
+ * Specifies how the browser distributes space between and around
759
+ * items along the cross-axis of their container; has no effect on
760
+ * single line flexible boxes
761
+ */
775
762
  alignContent?: "around" | "between" | "center" | "end" | "start" | "stretch";
776
763
  /**
777
- * Specifies how the browser distributes space between and around
778
- * items along the cross-axis of their container; the difference
779
- * to the alignContent prop is that alignItems specifies the
780
- * alignment of the items within the current container's line,
781
- * whereas alignContent specifies the alignment of the lines themselves
782
- */
764
+ * Specifies how the browser distributes space between and around
765
+ * items along the cross-axis of their container; the difference
766
+ * to the alignContent prop is that alignItems specifies the
767
+ * alignment of the items within the current container's line,
768
+ * whereas alignContent specifies the alignment of the lines themselves
769
+ */
783
770
  alignItems?: "baseline" | "center" | "end" | "start" | "stretch";
784
771
  /**
785
- * Specifies how the browser aligns items of the current line, overriding the
786
- * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
787
- * then alignSelf is ignored
788
- *
789
- * *Note: only works for nested `<Box />`*
790
- */
772
+ * Specifies how the browser aligns items of the current line, overriding the
773
+ * alignItems value of parent; if any of the item's cross-axis margin is set to auto,
774
+ * then alignSelf is ignored
775
+ *
776
+ * *Note: only works for nested `<Box />`*
777
+ */
791
778
  alignSelf?: "auto" | "baseline" | "center" | "end" | "start" | "stretch";
792
779
  /**
793
- * Specifies the initial main size of an item
794
- *
795
- * *Note: only works for nested `<Box />`*
796
- */
780
+ * Specifies the initial main size of an item
781
+ *
782
+ * *Note: only works for nested `<Box />`*
783
+ */
797
784
  basis?: number | string;
798
785
  /**
799
- * Pass an arbitrary child node
800
- */
786
+ * Pass an arbitrary child node
787
+ */
801
788
  children?: ReactNode;
802
789
  /**
803
- * Specifies the main axis of the container
804
- */
790
+ * Specifies the main axis of the container
791
+ */
805
792
  direction?: "column-reverse" | "column" | "row-reverse" | "row";
806
793
  /**
807
- * Specifies whether the width and/or height should fill the container
808
- */
794
+ * Specifies whether the width and/or height should fill the container
795
+ */
809
796
  fill?: boolean | "horizontal" | "vertical";
810
797
  /**
811
- * Specifies whether the width and/or height should fill the viewport
812
- */
798
+ * Specifies whether the width and/or height should fill the viewport
799
+ */
813
800
  fillViewport?: boolean | "horizontal" | "vertical";
814
801
  /**
815
- * Specifies the gaps (gutters) between rows and columns
816
- */
802
+ * Specifies the gaps (gutters) between rows and columns
803
+ */
817
804
  gap?: Gap | number | string;
818
805
  /**
819
- * Specifies what amount of space inside the flex container the item should take up
820
- *
821
- * *Note: only works for nested `<Box />`*
822
- */
806
+ * Specifies what amount of space inside the flex container the item should take up
807
+ *
808
+ * *Note: only works for nested `<Box />`*
809
+ */
823
810
  grow?: number;
824
811
  /**
825
- * Make Layout behave like an inline element but still lay out its content according to flexbox model
826
- */
812
+ * Make Layout behave like an inline element but still lay out its content according to flexbox model
813
+ */
827
814
  inline?: boolean;
828
815
  /**
829
- * Specifies how the browser distributes space between and around
830
- * items along the main axis of their container
831
- */
816
+ * Specifies how the browser distributes space between and around
817
+ * items along the main axis of their container
818
+ */
832
819
  justifyContent?: "around" | "between" | "center" | "end" | "evenly" | "start";
833
820
  /**
834
- * Specifies the order used to lay out an item in its container. Items within the same
835
- * container are rendered in ascending order according to their order values.
836
- * Elements with the _same_ order value are rendered in the order in which they appear in code
837
- *
838
- * *Note: only works for nested `<Box />`*
839
- */
821
+ * Specifies the order used to lay out an item in its container. Items within the same
822
+ * container are rendered in ascending order according to their order values.
823
+ * Elements with the _same_ order value are rendered in the order in which they appear in code
824
+ *
825
+ * *Note: only works for nested `<Box />`*
826
+ */
840
827
  order?: number | "inherit" | "initial" | "unset";
841
828
  /**
842
- * The DOM tag to use for the element
843
- */
829
+ * The DOM tag to use for the element
830
+ */
844
831
  renderAs?: keyof JSX.IntrinsicElements;
845
832
  /**
846
- * Specifies how items will shrink inside the container when the default size of
847
- * items is larger than their container
848
- *
849
- * *Note: only works for nested `<Box />`*
850
- */
833
+ * Specifies how items will shrink inside the container when the default size of
834
+ * items is larger than their container
835
+ *
836
+ * *Note: only works for nested `<Box />`*
837
+ */
851
838
  shrink?: number;
852
839
  /**
853
- * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
854
- */
840
+ * Specifies whether items are forced into a single line or can be wrapped onto multiple lines
841
+ */
855
842
  wrapItems?: boolean;
856
843
  };
857
844
  declare const Box: ForwardRefExoticComponent<BoxProps & RefAttributes<HTMLDivElement>>;
@@ -860,78 +847,78 @@ declare const Box: ForwardRefExoticComponent<BoxProps & RefAttributes<HTMLDivEle
860
847
  type TextAlignValues = "center" | "left" | "right";
861
848
  type ButtonProps = ComponentPropsWithRef<"button"> & {
862
849
  /**
863
- * Text that appears inside of the button *THIS WILL OVERRIDE THE LABEL PROP*
864
- */
850
+ * Text that appears inside of the button *THIS WILL OVERRIDE THE LABEL PROP*
851
+ */
865
852
  children?: ReactNode;
866
853
  /**
867
- * Allows user to override default button colors
868
- */
854
+ * Allows user to override default button colors
855
+ */
869
856
  colorOverride?: string;
870
857
  /**
871
- * Disables button
872
- */
858
+ * Disables button
859
+ */
873
860
  disabled?: boolean;
874
861
  /**
875
- * @ignore
876
- * Force a button into a particular css state (for debugging)
877
- */
862
+ * @ignore
863
+ * Force a button into a particular css state (for debugging)
864
+ */
878
865
  forceState?: "active" | "focus" | "hover" | undefined;
879
866
  /**
880
- * Is the button full-width?
881
- */
867
+ * Is the button full-width?
868
+ */
882
869
  fullWidth?: boolean;
883
870
  /**
884
- * An SVG component
885
- */
871
+ * An SVG component
872
+ */
886
873
  icon?: ReactNode;
887
874
  /**
888
- * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
889
- */
875
+ * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
876
+ */
890
877
  iconName?: keyof typeof iconMap;
891
878
  /**
892
- * Should the icon appear at the start of the button or the end?
893
- */
879
+ * Should the icon appear at the start of the button or the end?
880
+ */
894
881
  iconPosition?: "end" | "start";
895
882
  /**
896
- * Show a spinner when the button is in a loading state
897
- */
883
+ * Show a spinner when the button is in a loading state
884
+ */
898
885
  isLoading?: boolean;
899
886
  /**
900
- * Text that appears inside the button
901
- */
887
+ * Text that appears inside the button
888
+ */
902
889
  label?: string;
903
890
  /**
904
- * Should the label wrap if the button container is too narrow to fit the label text on one line
905
- * @deprecated Apply white-space styling as needed
906
- */
891
+ * Should the label wrap if the button container is too narrow to fit the label text on one line
892
+ * @deprecated Apply white-space styling as needed
893
+ */
907
894
  labelWrap?: boolean;
908
895
  /**
909
- * Provides a button without any styling (useful for wrapping another element)
910
- */
896
+ * Provides a button without any styling (useful for wrapping another element)
897
+ */
911
898
  noStyle?: boolean;
912
899
  /**
913
- * Callback function invoked when the button is clicked
914
- */
900
+ * Callback function invoked when the button is clicked
901
+ */
915
902
  onClick?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
916
903
  /**
917
- * The size of button to display
918
- */
904
+ * The size of button to display
905
+ */
919
906
  size?: "lg" | "md" | "sm";
920
907
  /**
921
- * If true then rounded corners will be squared
922
- */
908
+ * If true then rounded corners will be squared
909
+ */
923
910
  square?: boolean;
924
911
  /**
925
- * Alignment of the button label
926
- */
912
+ * Alignment of the button label
913
+ */
927
914
  textAlign?: TextAlignValues;
928
915
  /**
929
- * The type of button element that should be rendered
930
- */
916
+ * The type of button element that should be rendered
917
+ */
931
918
  type?: "button" | "reset" | "submit";
932
919
  /**
933
- * The visual type of button to display
934
- */
920
+ * The visual type of button to display
921
+ */
935
922
  variant?: "dangerous" | "primary" | "secondary" | "tertiary";
936
923
  };
937
924
  declare const Button: ForwardRefExoticComponent<ButtonProps & RefAttributes<HTMLButtonElement>>;
@@ -939,16 +926,16 @@ declare const Button: ForwardRefExoticComponent<ButtonProps & RefAttributes<HTML
939
926
  //#region src/components/ButtonGroup/ButtonGroup.d.ts
940
927
  type ButtonGroupProps = ComponentPropsWithoutRef<"div"> & {
941
928
  /**
942
- * Align buttons to the left or right of their container
943
- */
929
+ * Align buttons to the left or right of their container
930
+ */
944
931
  align?: "center" | "left" | "right";
945
932
  /**
946
- * Buttons that will be rendered in grouping
947
- */
933
+ * Buttons that will be rendered in grouping
934
+ */
948
935
  children?: ReactNode;
949
936
  /**
950
- * Force ButtonGroup to fill the width of it's container
951
- */
937
+ * Force ButtonGroup to fill the width of it's container
938
+ */
952
939
  fullWidth?: boolean;
953
940
  };
954
941
  declare const ButtonGroup: FC<ButtonGroupProps>;
@@ -956,148 +943,148 @@ declare const ButtonGroup: FC<ButtonGroupProps>;
956
943
  //#region src/components/ButtonLink/ButtonLink.d.ts
957
944
  type ButtonLinkProps = ComponentPropsWithRef<"a"> & {
958
945
  /**
959
- * A Promise to invoke before navigating to location.
960
- * _Caution: if used with `external` type prop a new window will **not** be opened_
961
- */
946
+ * A Promise to invoke before navigating to location.
947
+ * _Caution: if used with `external` type prop a new window will **not** be opened_
948
+ */
962
949
  beforeAction?: (() => Promise<void>) | (() => void);
963
950
  /**
964
- * The content that will be rendered inside the button
965
- */
951
+ * The content that will be rendered inside the button
952
+ */
966
953
  children?: ReactNode;
967
954
  /**
968
- * Option CSS color string
969
- */
955
+ * Option CSS color string
956
+ */
970
957
  colorOverride?: string;
971
958
  /**
972
- * Disables Link
973
- */
959
+ * Disables Link
960
+ */
974
961
  disabled?: boolean;
975
962
  /**
976
- * @ignore
977
- * Force a Link into a particular css state (for debugging)
978
- */
963
+ * @ignore
964
+ * Force a Link into a particular css state (for debugging)
965
+ */
979
966
  forceState?: "active" | "focus" | "hover";
980
967
  /**
981
- * Is the button full-width?
982
- */
968
+ * Is the button full-width?
969
+ */
983
970
  fullWidth?: boolean;
984
971
  /**
985
- * The entity to link to (url, email address, telephone number)
986
- */
972
+ * The entity to link to (url, email address, telephone number)
973
+ */
987
974
  href: string;
988
975
  /**
989
- * An SVG component
990
- */
976
+ * An SVG component
977
+ */
991
978
  icon?: ReactNode;
992
979
  /**
993
- * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
994
- */
980
+ * The "type" name of a VHS icon. *THIS WILL OVERRIDE ANY ICON PROP PASSED*
981
+ */
995
982
  iconName?: keyof typeof iconMap;
996
983
  /**
997
- * Should the icon appear at the start of the button or the end?
998
- */
984
+ * Should the icon appear at the start of the button or the end?
985
+ */
999
986
  iconPosition?: "end" | "start";
1000
987
  /**
1001
- * Text that appears inside the button
1002
- */
988
+ * Text that appears inside the button
989
+ */
1003
990
  label?: string;
1004
991
  /**
1005
- * Should the label wrap if the button container is too narrow to fit the label text on one line
1006
- */
992
+ * Should the label wrap if the button container is too narrow to fit the label text on one line
993
+ */
1007
994
  labelWrap?: boolean;
1008
995
  /**
1009
- * An object that will be converted into a search parameter string and appended to
1010
- * the `to` prop value
1011
- */
996
+ * An object that will be converted into a search parameter string and appended to
997
+ * the `to` prop value
998
+ */
1012
999
  params?: Record<string, string>;
1013
1000
  /**
1014
- * The size of button to display
1015
- */
1001
+ * The size of button to display
1002
+ */
1016
1003
  size?: "lg" | "md" | "sm";
1017
1004
  /**
1018
- * If true, rounded corners are disabled
1019
- */
1005
+ * If true, rounded corners are disabled
1006
+ */
1020
1007
  square?: boolean;
1021
1008
  /**
1022
- * Alignment of the button label
1023
- */
1009
+ * Alignment of the button label
1010
+ */
1024
1011
  textAlign?: TextAlignValues;
1025
1012
  /**
1026
- * Type of link to display
1027
- *
1028
- * * `email` creates a mailto
1029
- * * `phone` creates a telephone number
1030
- * * `external` will open links in a new window
1031
- */
1013
+ * Type of link to display
1014
+ *
1015
+ * * `email` creates a mailto
1016
+ * * `phone` creates a telephone number
1017
+ * * `external` will open links in a new window
1018
+ */
1032
1019
  type?: "default" | "email" | "external" | "phone";
1033
1020
  /**
1034
- * The visual type of button to display
1035
- */
1021
+ * The visual type of button to display
1022
+ */
1036
1023
  variant?: "dangerous" | "primary" | "secondary" | "tertiary";
1037
1024
  };
1038
1025
  /**
1039
- * The `ButtonLink` component is useful for getting the functionality of a
1040
- * `Link` with the styling of a `Button`.
1041
- *
1042
- * A useful heuristic for using this component: Do you have an `href`? Some of the advantages are having a right-click
1043
- * context menu available opening a new tab, and copying the URL.
1044
- *
1045
- * **Note:** the props table below is incomplete; please
1046
- * refer to [Link](?path=/docs/link--link-stories) for additional props.
1047
- */
1026
+ * The `ButtonLink` component is useful for getting the functionality of a
1027
+ * `Link` with the styling of a `Button`.
1028
+ *
1029
+ * A useful heuristic for using this component: Do you have an `href`? Some of the advantages are having a right-click
1030
+ * context menu available opening a new tab, and copying the URL.
1031
+ *
1032
+ * **Note:** the props table below is incomplete; please
1033
+ * refer to [Link](?path=/docs/link--link-stories) for additional props.
1034
+ */
1048
1035
  declare const ButtonLink: ForwardRefExoticComponent<ButtonLinkProps & RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
1049
1036
  //#endregion
1050
1037
  //#region src/components/Checkbox/Checkbox.d.ts
1051
1038
  type CheckboxProps = Omit<ComponentPropsWithRef<"label">, "onChange"> & {
1052
1039
  /**
1053
- * Indicates the state of the checkbox
1054
- */
1040
+ * Indicates the state of the checkbox
1041
+ */
1055
1042
  checked?: boolean;
1056
1043
  /**
1057
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
1058
- */
1044
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
1045
+ */
1059
1046
  direction?: "column" | "row";
1060
1047
  /**
1061
- * Disables checkbox
1062
- */
1048
+ * Disables checkbox
1049
+ */
1063
1050
  disabled?: boolean;
1064
1051
  /**
1065
- * @ignore
1066
- * Force a Checkbox into a particular css state (for debugging)
1067
- */
1052
+ * @ignore
1053
+ * Force a Checkbox into a particular css state (for debugging)
1054
+ */
1068
1055
  forceState?: "focus" | "hover";
1069
1056
  /**
1070
- * Indicates that there is an error with the input
1071
- */
1057
+ * Indicates that there is an error with the input
1058
+ */
1072
1059
  hasError?: boolean;
1073
1060
  /**
1074
- * Provides an ID for the checkbox
1075
- */
1061
+ * Provides an ID for the checkbox
1062
+ */
1076
1063
  id?: string;
1077
1064
  /**
1078
- * The label for the checkbox
1079
- */
1065
+ * The label for the checkbox
1066
+ */
1080
1067
  label?: JSX.Element | string | undefined;
1081
1068
  /**
1082
- * The description for the checkbox
1083
- */
1069
+ * The description for the checkbox
1070
+ */
1084
1071
  labelDescription?: JSX.Element | string | undefined;
1085
1072
  /**
1086
- * Should match the ID attribute of the checkbox.
1087
- * Can be used to group together multiple checkboxes
1088
- */
1073
+ * Should match the ID attribute of the checkbox.
1074
+ * Can be used to group together multiple checkboxes
1075
+ */
1089
1076
  name?: string;
1090
1077
  /**
1091
- * Callback function invoked when the checkbox value changes
1092
- */
1078
+ * Callback function invoked when the checkbox value changes
1079
+ */
1093
1080
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
1094
1081
  /**
1095
- * Make Input a required element
1096
- */
1082
+ * Make Input a required element
1083
+ */
1097
1084
  required?: boolean;
1098
1085
  /**
1099
- * The value attribute of the checkbox
1100
- */
1086
+ * The value attribute of the checkbox
1087
+ */
1101
1088
  value?: string;
1102
1089
  };
1103
1090
  declare const Checkbox: ForwardRefExoticComponent<CheckboxProps & RefAttributes<HTMLLabelElement>>;
@@ -1108,47 +1095,47 @@ type CheckboxPropsWithName = Omit<CheckboxProps, "name"> & {
1108
1095
  };
1109
1096
  type CheckboxGroupProps = Omit<ComponentPropsWithoutRef<"div">, "onChange"> & {
1110
1097
  /**
1111
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
1112
- */
1098
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
1099
+ */
1113
1100
  direction?: "column" | "row";
1114
1101
  /**
1115
- * Whether CheckboxGroup is disabled
1116
- */
1102
+ * Whether CheckboxGroup is disabled
1103
+ */
1117
1104
  disabled?: boolean;
1118
1105
  /**
1119
- * Error message to be displayed
1120
- */
1106
+ * Error message to be displayed
1107
+ */
1121
1108
  error?: string | undefined;
1122
1109
  /**
1123
- * The label for the form field
1124
- */
1110
+ * The label for the form field
1111
+ */
1125
1112
  label?: JSX.Element | string | undefined;
1126
1113
  /**
1127
- * The hint/helper text under the label
1128
- */
1114
+ * The hint/helper text under the label
1115
+ */
1129
1116
  labelDescription?: JSX.Element | string | undefined;
1130
1117
  /**
1131
- * Props that are passed through to the underlying `<Label>` component
1132
- */
1118
+ * Props that are passed through to the underlying `<Label>` component
1119
+ */
1133
1120
  labelProps?: {
1134
1121
  disabled?: boolean;
1135
1122
  screenReaderOnly?: boolean;
1136
1123
  };
1137
1124
  /**
1138
- * Name of the form element
1139
- */
1125
+ * Name of the form element
1126
+ */
1140
1127
  name: string;
1141
1128
  /**
1142
- * Callback function invoked when the value changes
1143
- */
1129
+ * Callback function invoked when the value changes
1130
+ */
1144
1131
  onChange?: (event: ChangeEvent<HTMLInputElement>, name: string) => unknown;
1145
1132
  /**
1146
- * Array of checkbox attributes
1147
- */
1133
+ * Array of checkbox attributes
1134
+ */
1148
1135
  options: CheckboxPropsWithName[];
1149
1136
  /**
1150
- * Currently selected checkbox value
1151
- */
1137
+ * Currently selected checkbox value
1138
+ */
1152
1139
  value?: string[] | boolean | undefined;
1153
1140
  };
1154
1141
  declare const CheckboxGroup: FC<CheckboxGroupProps>;
@@ -1156,43 +1143,43 @@ declare const CheckboxGroup: FC<CheckboxGroupProps>;
1156
1143
  //#region src/components/ClickArea/ClickArea.d.ts
1157
1144
  type ClickAreaProps = ComponentPropsWithRef<"div"> & {
1158
1145
  /**
1159
- * Supply an element or Component to render as the root compoennt (default is div)
1160
- */
1146
+ * Supply an element or Component to render as the root compoennt (default is div)
1147
+ */
1161
1148
  renderAs?: ElementType;
1162
1149
  /**
1163
- * The content within the clickarea
1164
- */
1150
+ * The content within the clickarea
1151
+ */
1165
1152
  children: ReactNode;
1166
1153
  /**
1167
- * If provided, this click event happens instead of the target ref's click event
1168
- */
1154
+ * If provided, this click event happens instead of the target ref's click event
1155
+ */
1169
1156
  onClick?: (event: Event) => void;
1170
1157
  /**
1171
- * A ref to the element within chldren that will be used as the target of the click event
1172
- * Should typically be a button or link
1173
- */
1158
+ * A ref to the element within chldren that will be used as the target of the click event
1159
+ * Should typically be a button or link
1160
+ */
1174
1161
  targetRef: RefObject<HTMLElement | null>;
1175
1162
  };
1176
1163
  /**
1177
- * ClickArea is useful when you want an entire element to be clickable, such as a card or an item in a list. Making the
1178
- * entire element clickable provides a better click target for users, especially on mobile devices. The problem with this is
1179
- * clickable divs are not accessible or tabbable. Using a `button` or `a` tag causes both styling and screenreader problems.
1180
- *
1181
- * To solve these issues, `ClickArea` maps a click event on the container element to a click event on a button or link within
1182
- * it, via a ref. Assistive devices can utilize the target element and ignore the container element's click property.
1183
- *
1184
- * ClickArea also makes having interactive elements within the clickable container easier. For example, if you have a card element
1185
- * that is clickable but with a "close" button in the top right, include `event.preventDefault()` in the close button's click handler
1186
- * to prevent the container's click handler from firing.
1187
- *
1188
- */
1164
+ * ClickArea is useful when you want an entire element to be clickable, such as a card or an item in a list. Making the
1165
+ * entire element clickable provides a better click target for users, especially on mobile devices. The problem with this is
1166
+ * clickable divs are not accessible or tabbable. Using a `button` or `a` tag causes both styling and screenreader problems.
1167
+ *
1168
+ * To solve these issues, `ClickArea` maps a click event on the container element to a click event on a button or link within
1169
+ * it, via a ref. Assistive devices can utilize the target element and ignore the container element's click property.
1170
+ *
1171
+ * ClickArea also makes having interactive elements within the clickable container easier. For example, if you have a card element
1172
+ * that is clickable but with a "close" button in the top right, include `event.preventDefault()` in the close button's click handler
1173
+ * to prevent the container's click handler from firing.
1174
+ *
1175
+ */
1189
1176
  declare const ClickArea: ForwardRefExoticComponent<ClickAreaProps & RefAttributes<HTMLElement>>;
1190
1177
  //#endregion
1191
1178
  //#region src/components/CloseButton/CloseButton.d.ts
1192
1179
  type CloseButtonProps = ComponentPropsWithoutRef<"button"> & {
1193
1180
  /**
1194
- * Callback function invoked when the button is clicked
1195
- */
1181
+ * Callback function invoked when the button is clicked
1182
+ */
1196
1183
  onClick?: () => void;
1197
1184
  };
1198
1185
  declare const CloseButton: FC<CloseButtonProps>;
@@ -1205,74 +1192,71 @@ declare const CARET_DIRECTION_LEFT = "left";
1205
1192
  declare const CARET_DIRECTION_RIGHT = "right";
1206
1193
  type CollapsibleGroupProps = {
1207
1194
  /**
1208
- * Slot for adjacent options
1209
- */
1195
+ * Slot for adjacent options
1196
+ */
1210
1197
  actions?: ReactNode;
1211
1198
  /**
1212
- * Custom background color
1213
- */
1199
+ * Custom background color
1200
+ */
1214
1201
  backgroundColor?: string;
1215
1202
  /**
1216
- * Custom direction of the caret when open or closed
1217
- */
1203
+ * Custom direction of the caret when open or closed
1204
+ */
1218
1205
  caretDirection?: {
1219
1206
  closed: typeof CARET_DIRECTION_DOWN | typeof CARET_DIRECTION_LEFT | typeof CARET_DIRECTION_RIGHT | typeof CARET_DIRECTION_UP;
1220
1207
  open: typeof CARET_DIRECTION_DOWN | typeof CARET_DIRECTION_LEFT | typeof CARET_DIRECTION_RIGHT | typeof CARET_DIRECTION_UP;
1221
1208
  };
1222
1209
  /**
1223
- * Toggleable contents
1224
- */
1210
+ * Toggleable contents
1211
+ */
1225
1212
  children?: ReactNode;
1226
1213
  /**
1227
- * Optional CSS padding to be applied to the content container
1228
- */
1214
+ * Optional CSS padding to be applied to the content container
1215
+ */
1229
1216
  contentPadding?: string | null;
1230
1217
  /**
1231
- * The control has a caret by default. Set this to true to suppress the caret
1232
- */
1218
+ * The control has a caret by default. Set this to true to suppress the caret
1219
+ */
1233
1220
  hideCaret?: boolean;
1234
1221
  /**
1235
- * Optional ID attribute
1236
- */
1222
+ * Optional ID attribute
1223
+ */
1237
1224
  id?: string;
1238
1225
  /**
1239
- * Control the initial open state. If not provided, the default is to start closed.
1240
- */
1226
+ * Control the initial open state. If not provided, the default is to start closed.
1227
+ */
1241
1228
  isOpen?: boolean;
1242
1229
  /**
1243
- * Clickable text label for the control, or perhaps an inline editable
1244
- * control? Whatever suits you */
1245
- label?: ReactNode | (({
1246
- open,
1247
- caret
1248
- }: {
1230
+ * Clickable text label for the control, or perhaps an inline editable
1231
+ * control? Whatever suits you */
1232
+ label?: ReactNode | (({ open, caret }: {
1249
1233
  open: boolean;
1250
1234
  caret: JSX.Element;
1251
1235
  }) => ReactNode);
1252
1236
  /**
1253
- * Choose on which side the caret shows
1254
- */
1237
+ * Choose on which side the caret shows
1238
+ */
1255
1239
  layout?: "leading" | "trailing";
1256
1240
  /**
1257
- * Callback function invoked when the button is clicked
1258
- */
1241
+ * Callback function invoked when the button is clicked
1242
+ */
1259
1243
  onClick?: () => unknown;
1260
1244
  /**
1261
- * Callback function invoked when the open state changes
1262
- */
1245
+ * Callback function invoked when the open state changes
1246
+ */
1263
1247
  onOpenChange?: (newOpen: boolean) => unknown;
1264
1248
  /**
1265
- * Extra actions are hidden by default and shown on hover. Set this to false
1266
- * to make always visible
1267
- */
1249
+ * Extra actions are hidden by default and shown on hover. Set this to false
1250
+ * to make always visible
1251
+ */
1268
1252
  showActionsOnHover?: boolean;
1269
1253
  /**
1270
- * Display the open / close transition animation
1271
- */
1254
+ * Display the open / close transition animation
1255
+ */
1272
1256
  showTransition?: boolean;
1273
1257
  /**
1274
- * Changes the styling of the collapsible group banner when active
1275
- */
1258
+ * Changes the styling of the collapsible group banner when active
1259
+ */
1276
1260
  variant?: typeof VARIANT_BRAND_BLUE;
1277
1261
  };
1278
1262
  declare const CollapsibleGroup: FC<CollapsibleGroupProps>;
@@ -1280,16 +1264,16 @@ declare const CollapsibleGroup: FC<CollapsibleGroupProps>;
1280
1264
  //#region src/components/Divider/Divider.d.ts
1281
1265
  type DividerProps = ComponentPropsWithoutRef<"hr"> & {
1282
1266
  /**
1283
- * Allows user to override default divider color
1284
- */
1267
+ * Allows user to override default divider color
1268
+ */
1285
1269
  colorOverride?: string;
1286
1270
  /**
1287
- * Height (in pixels) of divider
1288
- */
1271
+ * Height (in pixels) of divider
1272
+ */
1289
1273
  height?: number;
1290
1274
  /**
1291
- * The visual type of divider to display
1292
- */
1275
+ * The visual type of divider to display
1276
+ */
1293
1277
  variant?: "dashed" | "solid";
1294
1278
  };
1295
1279
  declare const Divider: FC<DividerProps>;
@@ -1299,12 +1283,12 @@ declare const ellipsisStyle: RuleSet<object>;
1299
1283
  declare const ellipsisFlexParentStyle: RuleSet<object>;
1300
1284
  type EllipsisProps = ComponentPropsWithoutRef<"div"> & {
1301
1285
  /**
1302
- * The text that will be truncated with an ellipsis
1303
- */
1286
+ * The text that will be truncated with an ellipsis
1287
+ */
1304
1288
  children?: ReactNode;
1305
1289
  /**
1306
- * The number that will be truncated with an ellipsis
1307
- */
1290
+ * The number that will be truncated with an ellipsis
1291
+ */
1308
1292
  lines?: number;
1309
1293
  };
1310
1294
  declare const Ellipsis: FC<EllipsisProps>;
@@ -1312,45 +1296,45 @@ declare const Ellipsis: FC<EllipsisProps>;
1312
1296
  //#region src/components/FileSelect/FileSelect.d.ts
1313
1297
  type FileSelectProps = {
1314
1298
  /**
1315
- * Allowlist of file types that the server will accept
1316
- * (see: <a href="https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-accept">file input docs</a>)
1317
- */
1299
+ * Allowlist of file types that the server will accept
1300
+ * (see: <a href="https://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-accept">file input docs</a>)
1301
+ */
1318
1302
  accept: string;
1319
1303
  /**
1320
- * Pass an arbitrary child node
1321
- */
1304
+ * Pass an arbitrary child node
1305
+ */
1322
1306
  children: ReactNode;
1323
1307
  /**
1324
- * Disable the input. <em>Note: Does not "disable" the child component, only the hidden input</em>
1325
- */
1308
+ * Disable the input. <em>Note: Does not "disable" the child component, only the hidden input</em>
1309
+ */
1326
1310
  disabled?: boolean;
1327
1311
  /**
1328
- * ID of the input
1329
- */
1312
+ * ID of the input
1313
+ */
1330
1314
  id: string;
1331
1315
  /**
1332
- * File size limit specified in MB
1333
- */
1316
+ * File size limit specified in MB
1317
+ */
1334
1318
  maxSize?: number;
1335
1319
  /**
1336
- * Allow multiple files to be selected
1337
- */
1320
+ * Allow multiple files to be selected
1321
+ */
1338
1322
  multiple?: boolean;
1339
1323
  /**
1340
- * Name of the input
1341
- */
1324
+ * Name of the input
1325
+ */
1342
1326
  name?: string;
1343
1327
  /**
1344
- * Callback invoked when file has been selected
1345
- */
1328
+ * Callback invoked when file has been selected
1329
+ */
1346
1330
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
1347
1331
  /**
1348
- * Callback invoked when the file input is clicked (before the file has been selected)
1349
- */
1332
+ * Callback invoked when the file input is clicked (before the file has been selected)
1333
+ */
1350
1334
  onClick?: (...args: unknown[]) => unknown;
1351
1335
  /**
1352
- * Callback invoked when there is an error selecting file(s)
1353
- */
1336
+ * Callback invoked when there is an error selecting file(s)
1337
+ */
1354
1338
  onError?: (error: Error) => void;
1355
1339
  };
1356
1340
  declare const FileSelect: ForwardRefExoticComponent<FileSelectProps & RefAttributes<HTMLInputElement>>;
@@ -1361,68 +1345,68 @@ type Values = Record<string, unknown>;
1361
1345
  type FormState = FormikProps<Values>;
1362
1346
  type FormProps = {
1363
1347
  /**
1364
- * Pass an arbitrary child node
1365
- */
1348
+ * Pass an arbitrary child node
1349
+ */
1366
1350
  children?: ReactNode;
1367
1351
  /**
1368
- * Class(es) to be applied to formik container
1369
- */
1352
+ * Class(es) to be applied to formik container
1353
+ */
1370
1354
  className?: string;
1371
1355
  /**
1372
- * Unique ID for Form, used for React Testing Library
1373
- */
1356
+ * Unique ID for Form, used for React Testing Library
1357
+ */
1374
1358
  formId: string;
1375
1359
  /**
1376
- * Ref required to be ref of FormGlobalError. Simply assign `const globalErrorRef = useRef(null)`. Either a function or the instance of a DOM native element.
1377
- */
1360
+ * Ref required to be ref of FormGlobalError. Simply assign `const globalErrorRef = useRef(null)`. Either a function or the instance of a DOM native element.
1361
+ */
1378
1362
  globalErrorRef: RefObject<HTMLElement | null | undefined>;
1379
1363
  /**
1380
- * Form input values on initial load, often populated from server
1381
- */
1364
+ * Form input values on initial load, often populated from server
1365
+ */
1382
1366
  initialValues: ValuesType;
1383
1367
  /**
1384
- * Ref to access the form's state and API
1385
- */
1368
+ * Ref to access the form's state and API
1369
+ */
1386
1370
  innerRef?: Ref<FormState>;
1387
1371
  /**
1388
- * On-submit callback
1389
- */
1372
+ * On-submit callback
1373
+ */
1390
1374
  onSubmit: (values: Record<string, unknown>, ref: FormikHelpers<Values>) => unknown;
1391
1375
  /**
1392
- * On form submission with errors (isValid=false), scroll to GlobalError section
1393
- */
1376
+ * On form submission with errors (isValid=false), scroll to GlobalError section
1377
+ */
1394
1378
  scrollToFormErrorsOnSubmit?: boolean;
1395
1379
  /**
1396
- * 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)
1397
- */
1380
+ * 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)
1381
+ */
1398
1382
  shareFormContext?: (props: FormikProps<Values>) => unknown;
1399
1383
  /**
1400
- * Show a top-level rundown of all the errors in the form
1401
- */
1384
+ * Show a top-level rundown of all the errors in the form
1385
+ */
1402
1386
  showGlobalError?: boolean;
1403
1387
  /**
1404
- * Style object applied to Form component
1405
- */
1388
+ * Style object applied to Form component
1389
+ */
1406
1390
  style?: Record<string, string>;
1407
1391
  /**
1408
- * Should form submit when an input's onChange is invoked?
1409
- */
1392
+ * Should form submit when an input's onChange is invoked?
1393
+ */
1410
1394
  submitOnChange?: boolean;
1411
1395
  /**
1412
- * Validate function passed to formik
1413
- */
1396
+ * Validate function passed to formik
1397
+ */
1414
1398
  validate?: (values: Values) => Promise<FormikErrors<Values>> | object | void;
1415
1399
  /**
1416
- * Should form run validate function on form blur?
1417
- */
1400
+ * Should form run validate function on form blur?
1401
+ */
1418
1402
  validateOnBlur?: boolean;
1419
1403
  /**
1420
- * Should form run validate function on form change?
1421
- */
1404
+ * Should form run validate function on form change?
1405
+ */
1422
1406
  validateOnChange?: boolean;
1423
1407
  /**
1424
- * __[`yup` schema](https://github.com/jquense/yup#yup)__
1425
- */
1408
+ * __[`yup` schema](https://github.com/jquense/yup#yup)__
1409
+ */
1426
1410
  validationSchema?: ValidationSchemaType;
1427
1411
  };
1428
1412
  type ValidationSchemaType = {
@@ -1438,12 +1422,12 @@ type ButtonsType = {
1438
1422
  };
1439
1423
  type FormButtonsProps = {
1440
1424
  /**
1441
- * Align button left (typically on a page) or right (typically on a modal).
1442
- */
1425
+ * Align button left (typically on a page) or right (typically on a modal).
1426
+ */
1443
1427
  align?: "left" | "right";
1444
1428
  /**
1445
- * Each button object must have a name, but can also be passed any props that apply to a Button component.
1446
- */
1429
+ * Each button object must have a name, but can also be passed any props that apply to a Button component.
1430
+ */
1447
1431
  buttons: ButtonsType[];
1448
1432
  };
1449
1433
  declare const FormButtons: FC<FormButtonsProps>;
@@ -1501,59 +1485,59 @@ declare const rteFormatTypes: {
1501
1485
  //#region src/components/FormField/FormField.d.ts
1502
1486
  type FormFieldProps = Omit<ComponentPropsWithRef<"input">, "placeholder"> & {
1503
1487
  /**
1504
- * A custom component that acts as a field and that needs access to Formik fields
1505
- */
1488
+ * A custom component that acts as a field and that needs access to Formik fields
1489
+ */
1506
1490
  customComponent?: ComponentClass<CustomComponentClass> | ((arg?: ComponentProps<typeof Field>) => ReactNode) | ((arg?: Record<string, unknown>) => ReactNode) | undefined;
1507
1491
  /**
1508
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
1509
- */
1492
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
1493
+ */
1510
1494
  direction?: "column" | "row";
1511
1495
  /**
1512
- * Disables form field
1513
- */
1496
+ * Disables form field
1497
+ */
1514
1498
  disabled?: boolean;
1515
1499
  /**
1516
- * Only takes effect if type is richTextEditor. An array of formats that should be enabled in the toolbar.
1517
- */
1500
+ * Only takes effect if type is richTextEditor. An array of formats that should be enabled in the toolbar.
1501
+ */
1518
1502
  enabledFormats?: (keyof typeof rteFormatTypes)[];
1519
1503
  /**
1520
- * Visual label above the input
1521
- */
1504
+ * Visual label above the input
1505
+ */
1522
1506
  label?: JSX.Element | string | undefined;
1523
1507
  /**
1524
- * The hint/helper text under the label
1525
- */
1508
+ * The hint/helper text under the label
1509
+ */
1526
1510
  labelDescription?: ReactNode;
1527
1511
  /**
1528
- * Props that are passed through to the underlying `<Label>` component
1529
- */
1512
+ * Props that are passed through to the underlying `<Label>` component
1513
+ */
1530
1514
  labelProps?: {
1531
1515
  disabled?: boolean;
1532
1516
  screenReaderOnly?: boolean;
1533
1517
  };
1534
1518
  /**
1535
- * HTML "name" attribute. Also needs to be unique in the form
1536
- */
1519
+ * HTML "name" attribute. Also needs to be unique in the form
1520
+ */
1537
1521
  name?: string;
1538
1522
  /**
1539
- * Custom onChange callback add-on. args: "value"
1540
- */
1523
+ * Custom onChange callback add-on. args: "value"
1524
+ */
1541
1525
  onChangeCustom?: (value: string) => unknown;
1542
1526
  /**
1543
- * Options passed down to the `<Field>` component
1544
- */
1527
+ * Options passed down to the `<Field>` component
1528
+ */
1545
1529
  options?: Record<string, unknown>[];
1546
1530
  /**
1547
- * Input's visual placeholder text
1548
- */
1531
+ * Input's visual placeholder text
1532
+ */
1549
1533
  placeholder?: string | null | undefined;
1550
1534
  /**
1551
- * Allows user to vertically or horizontally resize the form field, or to disable resizing altogether
1552
- */
1535
+ * Allows user to vertically or horizontally resize the form field, or to disable resizing altogether
1536
+ */
1553
1537
  resize?: "horizontal" | "none" | "vertical";
1554
1538
  /**
1555
- * The type of the field sets the type of input or select, texarea, radio, checkbox, etc.
1556
- */
1539
+ * The type of the field sets the type of input or select, texarea, radio, checkbox, etc.
1540
+ */
1557
1541
  type: "checkbox" | "custom" | "email" | "hidden" | "multiline" | "number" | "password" | "radio" | "richTextEditor" | "select" | "text" | "url";
1558
1542
  };
1559
1543
  declare const FormField: ForwardRefExoticComponent<FormFieldProps & RefAttributes<HTMLElement>>;
@@ -1570,28 +1554,28 @@ declare const FormGlobalError: ForwardRefExoticComponent<RefAttributes<HTMLDivEl
1570
1554
  //#region src/components/FullScreenModal/FullScreenModal.d.ts
1571
1555
  type FullScreenModalProps = {
1572
1556
  /**
1573
- * Color of the modal background
1574
- */
1557
+ * Color of the modal background
1558
+ */
1575
1559
  backgroundColor?: string;
1576
1560
  /**
1577
- * Contents of the modal
1578
- */
1561
+ * Contents of the modal
1562
+ */
1579
1563
  content: (hide: () => unknown) => ReactNode;
1580
1564
  /**
1581
- * Render the modal initially in shown state
1582
- */
1565
+ * Render the modal initially in shown state
1566
+ */
1583
1567
  initialShownState?: boolean;
1584
1568
  /**
1585
- * Callback invoked before the modal is hidden
1586
- */
1569
+ * Callback invoked before the modal is hidden
1570
+ */
1587
1571
  onBeforeHide?: (() => OnBeforeHideInterface) | undefined;
1588
1572
  /**
1589
- * Callback invoked when the modal is shown
1590
- */
1573
+ * Callback invoked when the modal is shown
1574
+ */
1591
1575
  onHide?: () => unknown;
1592
1576
  /**
1593
- * function(show, ref) that returns a node to open the modal
1594
- */
1577
+ * function(show, ref) that returns a node to open the modal
1578
+ */
1595
1579
  toggle?: ((show: () => unknown, toggleButtonRef?: RefObject<HTMLElement | null | undefined>) => ReactNode) | undefined;
1596
1580
  };
1597
1581
  declare const FullScreenModal: FC<FullScreenModalProps>;
@@ -1606,20 +1590,20 @@ declare const iconSizeMap: {
1606
1590
  };
1607
1591
  type IconProps = ComponentPropsWithoutRef<"svg"> & {
1608
1592
  /**
1609
- * Color (as hex) of the Icon
1610
- */
1593
+ * Color (as hex) of the Icon
1594
+ */
1611
1595
  color?: string;
1612
1596
  /**
1613
- * The size of the icon to display
1614
- */
1597
+ * The size of the icon to display
1598
+ */
1615
1599
  size?: keyof typeof iconSizeMap;
1616
1600
  /**
1617
- * @ignore
1618
- */
1601
+ * @ignore
1602
+ */
1619
1603
  style?: Record<string, unknown>;
1620
1604
  /**
1621
- * Determines which icon to display
1622
- */
1605
+ * Determines which icon to display
1606
+ */
1623
1607
  type: IconNameType;
1624
1608
  };
1625
1609
  declare const Icon: FC<IconProps>;
@@ -1638,40 +1622,40 @@ type sizeType = keyof typeof sizeMap;
1638
1622
  type componentStyleType = keyof typeof componentStyleMap;
1639
1623
  type IconButtonProps = ComponentPropsWithRef<"button"> & {
1640
1624
  /**
1641
- * Allows user to override default button colors
1642
- */
1625
+ * Allows user to override default button colors
1626
+ */
1643
1627
  colorOverride?: string | undefined;
1644
1628
  /**
1645
- * Choose light styles if this component appears on a dark background
1646
- */
1629
+ * Choose light styles if this component appears on a dark background
1630
+ */
1647
1631
  componentStyle?: componentStyleType;
1648
1632
  /**
1649
- * Disables button
1650
- */
1633
+ * Disables button
1634
+ */
1651
1635
  disabled?: boolean;
1652
1636
  /**
1653
- * An SVG component
1654
- */
1637
+ * An SVG component
1638
+ */
1655
1639
  icon?: ReactNode;
1656
1640
  /**
1657
- * Text that appears as a tooltip when the user hovers over the button
1658
- */
1641
+ * Text that appears as a tooltip when the user hovers over the button
1642
+ */
1659
1643
  label?: string;
1660
1644
  /**
1661
- * Callback function invoked when the button is clicked
1662
- */
1645
+ * Callback function invoked when the button is clicked
1646
+ */
1663
1647
  onClick?: ((event: MouseEvent) => void) | undefined;
1664
1648
  /**
1665
- * Prevent a Tooltip from appearing on hover
1666
- */
1649
+ * Prevent a Tooltip from appearing on hover
1650
+ */
1667
1651
  preventTooltip?: boolean;
1668
1652
  /**
1669
- * The size of the button
1670
- */
1653
+ * The size of the button
1654
+ */
1671
1655
  size?: sizeType;
1672
1656
  /**
1673
- * The direction of the tooltip
1674
- */
1657
+ * The direction of the tooltip
1658
+ */
1675
1659
  tooltipDirection?: "bottom" | "left" | "right" | "top";
1676
1660
  };
1677
1661
  declare const IconButton: ForwardRefExoticComponent<IconButtonProps & RefAttributes<HTMLButtonElement>>;
@@ -1679,33 +1663,33 @@ declare const IconButton: ForwardRefExoticComponent<IconButtonProps & RefAttribu
1679
1663
  //#region src/components/Image/Image.d.ts
1680
1664
  type ImageProps = ComponentPropsWithoutRef<"img"> & {
1681
1665
  /**
1682
- * Accessible text to apply to the image
1683
- */
1666
+ * Accessible text to apply to the image
1667
+ */
1684
1668
  alt: string;
1685
1669
  /**
1686
- * Specifies whether the width and/or height should fill the container
1687
- *
1688
- * *Note: this will override height/width attributes*
1689
- */
1670
+ * Specifies whether the width and/or height should fill the container
1671
+ *
1672
+ * *Note: this will override height/width attributes*
1673
+ */
1690
1674
  fill?: boolean | "horizontal" | "vertical";
1691
1675
  /**
1692
- * Specifies how the image's intrinsic size (ie. its natural size) should
1693
- * be adjusted to fit within its container
1694
- */
1676
+ * Specifies how the image's intrinsic size (ie. its natural size) should
1677
+ * be adjusted to fit within its container
1678
+ */
1695
1679
  fit?: "contain" | "cover" | "fill" | "none" | "scale-down";
1696
1680
  /**
1697
- * Indicates how the browser should load the image; `eager`loads the image immediately,
1698
- * `lazy` defers loading the image until it reaches a calculated distance from the viewport.
1699
- * See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading
1700
- */
1681
+ * Indicates how the browser should load the image; `eager`loads the image immediately,
1682
+ * `lazy` defers loading the image until it reaches a calculated distance from the viewport.
1683
+ * See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading
1684
+ */
1701
1685
  loading?: "eager" | "lazy";
1702
1686
  /**
1703
- * Specifies how the image will align itself in its container
1704
- */
1687
+ * Specifies how the image will align itself in its container
1688
+ */
1705
1689
  position?: string;
1706
1690
  /**
1707
- * URL to image file
1708
- */
1691
+ * URL to image file
1692
+ */
1709
1693
  src: string;
1710
1694
  };
1711
1695
  declare const Image: FC<ImageProps>;
@@ -1715,85 +1699,85 @@ type IconPositionStrings = "end" | "start";
1715
1699
  type ForcedStateStrings = "active" | "focus" | "hover";
1716
1700
  type InputProps = ComponentPropsWithRef<"input"> & {
1717
1701
  /**
1718
- * Copy-to-clipboard-on-click of input's value with copy icon
1719
- */
1702
+ * Copy-to-clipboard-on-click of input's value with copy icon
1703
+ */
1720
1704
  clickToCopy?: boolean;
1721
1705
  /**
1722
- * Disables Input
1723
- */
1706
+ * Disables Input
1707
+ */
1724
1708
  disabled?: boolean | undefined;
1725
1709
  /**
1726
- * @ignore
1727
- * Force an Input into a particular css state (for debugging)
1728
- */
1710
+ * @ignore
1711
+ * Force an Input into a particular css state (for debugging)
1712
+ */
1729
1713
  forceState?: ForcedStateStrings;
1730
1714
  /**
1731
- * Should Input occupy 100% of available space
1732
- */
1715
+ * Should Input occupy 100% of available space
1716
+ */
1733
1717
  fullWidth?: boolean;
1734
1718
  /**
1735
- * Indicates that there is an error with the input
1736
- */
1719
+ * Indicates that there is an error with the input
1720
+ */
1737
1721
  hasError?: boolean;
1738
1722
  /**
1739
- * An SVG component that will appear on the right-hand side of the input
1740
- * _Note:_ some input types will apply a icon by default
1741
- */
1723
+ * An SVG component that will appear on the right-hand side of the input
1724
+ * _Note:_ some input types will apply a icon by default
1725
+ */
1742
1726
  icon?: ReactNode;
1743
1727
  /**
1744
- * Indicates on which side of the input the icon should render. Will default to `end` unless the `type` prop is `search`.
1745
- */
1728
+ * Indicates on which side of the input the icon should render. Will default to `end` unless the `type` prop is `search`.
1729
+ */
1746
1730
  iconPosition?: IconPositionStrings;
1747
1731
  /**
1748
- * @ignore
1749
- * This is a prop that is here for use by FormField. Otherwise,
1750
- * the ref prop should just be used
1751
- */
1732
+ * @ignore
1733
+ * This is a prop that is here for use by FormField. Otherwise,
1734
+ * the ref prop should just be used
1735
+ */
1752
1736
  innerRef?: RefObject<HTMLInputElement | null>;
1753
1737
  /**
1754
- * Displays text in monospace font
1755
- */
1738
+ * Displays text in monospace font
1739
+ */
1756
1740
  monospace?: boolean;
1757
1741
  /**
1758
- * Callback function invoked when the input focus blurs
1759
- */
1742
+ * Callback function invoked when the input focus blurs
1743
+ */
1760
1744
  onBlur?: (event: FocusEvent<HTMLInputElement>) => void;
1761
1745
  /**
1762
- * Callback function invoked when the input value changes
1763
- */
1746
+ * Callback function invoked when the input value changes
1747
+ */
1764
1748
  onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
1765
1749
  /**
1766
- * Callback function invoked when the input value is copied
1767
- */
1750
+ * Callback function invoked when the input value is copied
1751
+ */
1768
1752
  onClickToCopy?: () => void;
1769
1753
  /**
1770
- * Callback function invoked when the input is focused
1771
- */
1754
+ * Callback function invoked when the input is focused
1755
+ */
1772
1756
  onFocus?: (event: FocusEvent<HTMLInputElement>) => void;
1773
1757
  /**
1774
- * Callback function that will select input text when input is focused;
1775
- * receives event object but if that is not needed just pass a no-op function
1776
- */
1758
+ * Callback function that will select input text when input is focused;
1759
+ * receives event object but if that is not needed just pass a no-op function
1760
+ */
1777
1761
  onFocusToSelect?: ((event: ChangeEvent<HTMLInputElement>) => void) | undefined;
1778
1762
  /**
1779
- * A short hint for the user about what value the Input expects
1780
- */
1763
+ * A short hint for the user about what value the Input expects
1764
+ */
1781
1765
  placeholder?: string | undefined;
1782
1766
  /**
1783
- * Prevent the Input from being writable (different styling from disabled)
1784
- */
1767
+ * Prevent the Input from being writable (different styling from disabled)
1768
+ */
1785
1769
  readOnly?: boolean;
1786
1770
  /**
1787
- * Make Input a required element
1788
- */
1771
+ * Make Input a required element
1772
+ */
1789
1773
  required?: boolean;
1790
1774
  /**
1791
- * The type of Input to render
1792
- */
1775
+ * The type of Input to render
1776
+ */
1793
1777
  type?: HTMLInputTypeAttribute;
1794
1778
  /**
1795
- * The content of Input
1796
- */
1779
+ * The content of Input
1780
+ */
1797
1781
  value?: number | string | undefined;
1798
1782
  };
1799
1783
  declare const Input: ForwardRefExoticComponent<InputProps & RefAttributes<HTMLInputElement>>;
@@ -1808,20 +1792,20 @@ type KeyboardKeys = AlphanumericKeyboardKeys | ArrowKeys | ModifierKeys | Whites
1808
1792
  //#region src/components/KeyboardShortcut/KeyboardShortcut.d.ts
1809
1793
  type KeyboardShortcutProps = ComponentPropsWithoutRef<"div"> & {
1810
1794
  /**
1811
- * @description The visual style of the keyboard shortcut. Choose light if the background is dark and dark if the background is light.
1812
- */
1795
+ * @description The visual style of the keyboard shortcut. Choose light if the background is dark and dark if the background is light.
1796
+ */
1813
1797
  componentStyle?: "dark" | "light";
1814
1798
  /**
1815
- * @description If set to true, the keyboard shortcut will stretch the full width of its container.
1816
- */
1799
+ * @description If set to true, the keyboard shortcut will stretch the full width of its container.
1800
+ */
1817
1801
  fullWidth?: boolean;
1818
1802
  /**
1819
- * @description The keys displayed.
1820
- */
1803
+ * @description The keys displayed.
1804
+ */
1821
1805
  keyboardKeys: KeyboardKeys | KeyboardKeys[];
1822
1806
  /**
1823
- * @description A visual label for the keyboard shortcut.
1824
- */
1807
+ * @description A visual label for the keyboard shortcut.
1808
+ */
1825
1809
  label?: string;
1826
1810
  };
1827
1811
  declare const KeyboardShortcut: FC<KeyboardShortcutProps>;
@@ -1829,29 +1813,29 @@ declare const KeyboardShortcut: FC<KeyboardShortcutProps>;
1829
1813
  //#region src/components/Label/Label.d.ts
1830
1814
  type LabelProps = ComponentPropsWithoutRef<"label"> & {
1831
1815
  /**
1832
- * Pass an arbitrary child node
1833
- */
1816
+ * Pass an arbitrary child node
1817
+ */
1834
1818
  children?: ReactNode;
1835
1819
  /**
1836
- * To indicate that the label is for a disabled form component
1837
- */
1820
+ * To indicate that the label is for a disabled form component
1821
+ */
1838
1822
  disabled?: boolean;
1839
1823
  /**
1840
- * ID of the form component that the label should be associated with
1841
- */
1824
+ * ID of the form component that the label should be associated with
1825
+ */
1842
1826
  htmlFor?: string | undefined;
1843
1827
  /**
1844
- * To use 'legend', 'p', 'span', or other instead of 'label'
1845
- */
1828
+ * To use 'legend', 'p', 'span', or other instead of 'label'
1829
+ */
1846
1830
  renderAs?: "div" | "label" | "legend" | "p" | "span" | undefined;
1847
1831
  /**
1848
- * Use if label describes a required form component
1849
- */
1832
+ * Use if label describes a required form component
1833
+ */
1850
1834
  required?: boolean;
1851
1835
  /**
1852
- * For label text that needs to be available to assistive technology (e.g. screen readers)
1853
- * but otherwise hidden on screen.
1854
- */
1836
+ * For label text that needs to be available to assistive technology (e.g. screen readers)
1837
+ * but otherwise hidden on screen.
1838
+ */
1855
1839
  screenReaderOnly?: boolean;
1856
1840
  };
1857
1841
  declare const Label: FC<LabelProps>;
@@ -1866,37 +1850,37 @@ declare const LabelDescription: FC<LabelDescriptionProps>;
1866
1850
  //#region src/components/LinkButton/LinkButton.d.ts
1867
1851
  type LinkButtonProps = ComponentPropsWithoutRef<"button"> & {
1868
1852
  /**
1869
- * Pass an arbitrary child node
1870
- */
1853
+ * Pass an arbitrary child node
1854
+ */
1871
1855
  children?: ReactNode;
1872
1856
  /**
1873
- * Disables Button
1874
- */
1857
+ * Disables Button
1858
+ */
1875
1859
  disabled?: boolean;
1876
1860
  /**
1877
- * @ignore
1878
- * Force a Button into a particular css state (for debugging)
1879
- */
1861
+ * @ignore
1862
+ * Force a Button into a particular css state (for debugging)
1863
+ */
1880
1864
  forceState?: "active" | "focus" | "hover";
1881
1865
  /**
1882
- * Text that appears inside the button
1883
- */
1866
+ * Text that appears inside the button
1867
+ */
1884
1868
  label?: string;
1885
1869
  /**
1886
- * Provides a button without any styling (useful for wrapping another element)
1887
- */
1870
+ * Provides a button without any styling (useful for wrapping another element)
1871
+ */
1888
1872
  noStyle?: boolean;
1889
1873
  /**
1890
- * Callback function invoked when the button is clicked
1891
- */
1874
+ * Callback function invoked when the button is clicked
1875
+ */
1892
1876
  onClick?: (event: KeyboardEvent | MouseEvent) => void;
1893
1877
  /**
1894
- * Will only display an underline when the Link is in a hover state
1895
- */
1878
+ * Will only display an underline when the Link is in a hover state
1879
+ */
1896
1880
  underlineOnHover?: boolean;
1897
1881
  /**
1898
- * The visual type of Button to display
1899
- */
1882
+ * The visual type of Button to display
1883
+ */
1900
1884
  variant?: "primary" | "secondary";
1901
1885
  };
1902
1886
  declare const LinkButton: ForwardRefExoticComponent<LinkButtonProps & RefAttributes<HTMLSpanElement>>;
@@ -1906,17 +1890,17 @@ type VariantType = "breadcrumbs" | "bullets" | "commas" | "ordered" | "slashes"
1906
1890
  type ItemType = ItemType[] | string[] | string;
1907
1891
  type ListProps = ComponentPropsWithoutRef<"ul"> & {
1908
1892
  /**
1909
- * Children should be wrapped in `<ListItem>`
1910
- */
1893
+ * Children should be wrapped in `<ListItem>`
1894
+ */
1911
1895
  children?: ReactNode;
1912
1896
  /**
1913
- * As an alternative to passing children you can supply an array of strings that
1914
- * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
1915
- */
1897
+ * As an alternative to passing children you can supply an array of strings that
1898
+ * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
1899
+ */
1916
1900
  items?: ItemType[];
1917
1901
  /**
1918
- * The kind of list to render
1919
- */
1902
+ * The kind of list to render
1903
+ */
1920
1904
  variant?: VariantType;
1921
1905
  };
1922
1906
  declare const List: FC<ListProps>;
@@ -1924,18 +1908,19 @@ declare const List: FC<ListProps>;
1924
1908
  //#region src/components/List/ListItem.d.ts
1925
1909
  type ListItemProps = {
1926
1910
  /**
1927
- * Pass an arbitrary child node
1928
- */
1911
+ * Pass an arbitrary child node
1912
+ */
1929
1913
  children?: ReactNode;
1930
1914
  };
1931
1915
  declare const ListItem: FC<ListItemProps>;
1932
1916
  //#endregion
1933
1917
  //#region src/components/Menu/Menu.d.ts
1934
1918
  type ControlledMenuProps = {
1935
- /** Is the menu open. Must be used with `onOpenChange`. */isOpen: boolean;
1919
+ /** Is the menu open. Must be used with `onOpenChange`. */
1920
+ isOpen: boolean;
1936
1921
  /** When an attempt to toggle the menu is triggered,
1937
- * must be used with `isOpen`.
1938
- */
1922
+ * must be used with `isOpen`.
1923
+ */
1939
1924
  onOpenChange: (isOpen: boolean) => void;
1940
1925
  };
1941
1926
  type UncontrolledMenuProps = {
@@ -1944,17 +1929,22 @@ type UncontrolledMenuProps = {
1944
1929
  };
1945
1930
  type MenuControlProps = ControlledMenuProps | UncontrolledMenuProps;
1946
1931
  type DefaultMenuProps = DropdownMenuProps & MenuControlProps & {
1947
- /** The position of the Menu */align?: "center" | "end" | "start";
1948
- children: ReactNode; /** Callback for when the user clicks or focuses outside of the menu */
1949
- onInteractOutside?: DropdownMenuContentProps["onInteractOutside"]; /** Props to pass to the trigger component, the default trigger is Button */
1932
+ /** The position of the Menu */
1933
+ align?: "center" | "end" | "start";
1934
+ children: ReactNode;
1935
+ /** Callback for when the user clicks or focuses outside of the menu */
1936
+ onInteractOutside?: DropdownMenuContentProps["onInteractOutside"];
1937
+ /** Props to pass to the trigger component, the default trigger is Button */
1950
1938
  triggerProps?: ButtonProps;
1951
1939
  };
1952
1940
  type MenuPropsWithLabel = DefaultMenuProps & {
1953
- /** The label for the trigger element */label: string;
1941
+ /** The label for the trigger element */
1942
+ label: string;
1954
1943
  trigger?: never;
1955
1944
  };
1956
1945
  type MenuPropsWithCustomTrigger = DefaultMenuProps & {
1957
- label?: never; /** Replace the default trigger */
1946
+ label?: never;
1947
+ /** Replace the default trigger */
1958
1948
  trigger: JSX.Element;
1959
1949
  };
1960
1950
  type MenuProps = MenuPropsWithCustomTrigger | MenuPropsWithLabel;
@@ -1988,45 +1978,15 @@ type MenuItemPropsWithChildren = {
1988
1978
  type MenuItemProps = DropdownMenuItemProps & (MenuItemPropsWithChildren | MenuItemPropsWithLabelDescription);
1989
1979
  type CheckboxMenuItemProps = DropdownMenuCheckboxItemProps & (MenuItemPropsWithChildren | MenuItemPropsWithLabelDescription);
1990
1980
  type RadioMenuItemProps = DropdownMenuRadioItemProps & (MenuItemPropsWithChildren | MenuItemPropsWithLabelDescription);
1991
- declare const MenuItem: ({
1992
- children,
1993
- label,
1994
- description,
1995
- badge,
1996
- icon,
1997
- renderAs,
1998
- href,
1999
- target,
2000
- variant,
2001
- ...props
2002
- }: MenuItemProps) => JSX.Element;
2003
- declare const CheckboxMenuItem: ({
2004
- children,
2005
- label,
2006
- description,
2007
- badge,
2008
- icon,
2009
- indicator,
2010
- ...props
2011
- }: CheckboxMenuItemProps) => JSX.Element;
2012
- declare const RadioMenuItem: ({
2013
- children,
2014
- label,
2015
- badge,
2016
- description,
2017
- icon,
2018
- indicator,
2019
- ...props
2020
- }: RadioMenuItemProps) => JSX.Element;
1981
+ declare const MenuItem: ({ children, label, description, badge, icon, renderAs, href, target, variant, ...props }: MenuItemProps) => JSX.Element;
1982
+ declare const CheckboxMenuItem: ({ children, label, description, badge, icon, indicator, ...props }: CheckboxMenuItemProps) => JSX.Element;
1983
+ declare const RadioMenuItem: ({ children, label, badge, description, icon, indicator, ...props }: RadioMenuItemProps) => JSX.Element;
2021
1984
  //#endregion
2022
1985
  //#region src/components/Menu/MenuLabel.d.ts
2023
1986
  type MenuLabelProps = {
2024
1987
  children: ReactNode | string;
2025
1988
  };
2026
- declare const MenuLabel: ({
2027
- children,
2028
- ...props
2029
- }: MenuLabelProps) => JSX.Element;
1989
+ declare const MenuLabel: ({ children, ...props }: MenuLabelProps) => JSX.Element;
2030
1990
  //#endregion
2031
1991
  //#region src/components/Menu/SubMenu.d.ts
2032
1992
  type SubMenuProps = {
@@ -2035,128 +1995,124 @@ type SubMenuProps = {
2035
1995
  icon?: ReactNode;
2036
1996
  description?: ReactNode;
2037
1997
  };
2038
- declare const SubMenu: ({
2039
- label,
2040
- icon,
2041
- description,
2042
- children
2043
- }: SubMenuProps) => JSX.Element;
1998
+ declare const SubMenu: ({ label, icon, description, children }: SubMenuProps) => JSX.Element;
2044
1999
  //#endregion
2045
2000
  //#region src/components/MenuButton/MenuButton.d.ts
2046
2001
  type MenuButtonProps = ButtonProps & {
2047
2002
  /**
2048
- * Disables button
2049
- */
2003
+ * Disables button
2004
+ */
2050
2005
  disabled?: boolean;
2051
2006
  /**
2052
- * Use this prop to pass an IconButton as the "trigger" instead of a standard Button
2053
- */
2007
+ * Use this prop to pass an IconButton as the "trigger" instead of a standard Button
2008
+ */
2054
2009
  iconButtonComponent?: JSX.Element | ReactElement;
2055
2010
  /**
2056
- * Text that appears inside the button
2057
- */
2011
+ * Text that appears inside the button
2012
+ */
2058
2013
  label: string;
2059
2014
  /**
2060
- * Which side of the button should the menu be aligned
2061
- */
2015
+ * Which side of the button should the menu be aligned
2016
+ */
2062
2017
  menuAlignment?: "left" | "right";
2063
2018
  /**
2064
- * An array of Button/Link components
2065
- */
2019
+ * An array of Button/Link components
2020
+ */
2066
2021
  menuItems?: JSX.Element[];
2067
2022
  /**
2068
- * Where should the menu appear relative to the button
2069
- */
2023
+ * Where should the menu appear relative to the button
2024
+ */
2070
2025
  menuPosition?: "above" | "below";
2071
2026
  /**
2072
- * Can be a CSS width value string, 'fullWidth' or 'maxItem' (sized to the largest item width)
2073
- */
2027
+ * Can be a CSS width value string, 'fullWidth' or 'maxItem' (sized to the largest item width)
2028
+ */
2074
2029
  menuWidth?: string;
2075
2030
  /**
2076
- * Function that is called after the menu is closed
2077
- */
2031
+ * Function that is called after the menu is closed
2032
+ */
2078
2033
  onMenuClosed?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
2079
2034
  /**
2080
- * Function that is called when the menu button is clicked
2081
- */
2035
+ * Function that is called when the menu button is clicked
2036
+ */
2082
2037
  onMenuClick?: ((event: MouseEvent) => ReactNode) | ((event: MouseEvent) => void) | undefined;
2083
2038
  /**
2084
- * A custom node to be displayed in the menu on extra small screens.
2085
- */
2039
+ * A custom node to be displayed in the menu on extra small screens.
2040
+ */
2086
2041
  overrideMenuHeader?: ReactNode;
2087
2042
  /**
2088
- * The size of button to display
2089
- */
2043
+ * The size of button to display
2044
+ */
2090
2045
  size?: "lg" | "md" | "sm";
2091
2046
  };
2092
2047
  /**
2093
- * @deprecated Please use Menu with a Button trigger, see [documentation](https://wistia.github.io/vhs/?path=/docs-components-menu--docs).
2094
- *
2095
- * #### Why MenuButton is being deprecated
2096
- *
2097
- * The [Menu](https://wistia.github.io/vhs/?path=/docs-components-menu--docs) component is preferred over MenuButton for several reasons:
2098
- * 1. Menu has better alignment and collision detection.
2099
- * 2. Menu supports submenus.
2100
- * 3. Menu is properly portalled.
2101
- */
2048
+ * @deprecated Please use Menu with a Button trigger, see [documentation](https://wistia.github.io/vhs/?path=/docs-components-menu--docs).
2049
+ *
2050
+ * #### Why MenuButton is being deprecated
2051
+ *
2052
+ * The [Menu](https://wistia.github.io/vhs/?path=/docs-components-menu--docs) component is preferred over MenuButton for several reasons:
2053
+ * 1. Menu has better alignment and collision detection.
2054
+ * 2. Menu supports submenus.
2055
+ * 3. Menu is properly portalled.
2056
+ */
2102
2057
  declare const MenuButton: FC<MenuButtonProps>;
2103
2058
  //#endregion
2104
2059
  //#region src/components/Modal/Modal.d.ts
2105
2060
  type ModalProps = ComponentPropsWithoutRef<"div"> & {
2106
2061
  /**
2107
- * Horizontally align modal to the left, center, or right of the container
2108
- */
2062
+ * Horizontally align modal to the left, center, or right of the container
2063
+ */
2109
2064
  alignHorizontal?: "center" | "left" | "normal" | "right";
2110
2065
  /**
2111
- * Vertically align modal to the top, center, or bottom of the container
2112
- */
2066
+ * Vertically align modal to the top, center, or bottom of the container
2067
+ */
2113
2068
  alignVertical?: "bottom" | "center" | "normal" | "top";
2114
2069
  /**
2115
- * Whether or not the modal should be allowed to exceed the viewport bounds.
2116
- * If it exceeds the bounds, the entire backdrop will be scrollable.
2117
- */
2070
+ * Whether or not the modal should be allowed to exceed the viewport bounds.
2071
+ * If it exceeds the bounds, the entire backdrop will be scrollable.
2072
+ */
2118
2073
  allowModalToExceedViewportBounds?: boolean;
2119
2074
  /**
2120
- * Contents of the modal
2121
- */
2075
+ * Contents of the modal
2076
+ */
2122
2077
  children?: ReactNode;
2123
2078
  /**
2124
- * Class to be applied to the base element of the modal
2125
- */
2079
+ * Class to be applied to the base element of the modal
2080
+ */
2126
2081
  className?: string;
2127
2082
  /**
2128
- * Whether or not the modal should take up the full height of the viewport
2129
- */
2083
+ * Whether or not the modal should take up the full height of the viewport
2084
+ */
2130
2085
  fullHeight?: boolean;
2131
2086
  /**
2132
- * Ref to the element that should receive focus when the modal opens
2133
- */
2087
+ * Ref to the element that should receive focus when the modal opens
2088
+ */
2134
2089
  initialFocusRef?: RefObject<HTMLElement | null>;
2135
2090
  /**
2136
- * Whether or not the modal is open, and should be rendered
2137
- */
2091
+ * Whether or not the modal is open, and should be rendered
2092
+ */
2138
2093
  isOpen: boolean;
2139
2094
  /**
2140
- * When the Modal is dismissed, this function will be called. You'll typically want to set the
2141
- * state of `isOpen` to false here
2142
- * @returns
2143
- */
2095
+ * When the Modal is dismissed, this function will be called. You'll typically want to set the
2096
+ * state of `isOpen` to false here
2097
+ * @returns
2098
+ */
2144
2099
  onRequestClose?: () => void;
2145
2100
  /**
2146
- * Whether or not the modal should be closed when the user clicks outside of it
2147
- * @default true
2148
- */
2101
+ * Whether or not the modal should be closed when the user clicks outside of it
2102
+ * @default true
2103
+ */
2149
2104
  shouldCloseOnClickOutside?: boolean;
2150
2105
  /**
2151
- * Whether or not the modal should trap focus within itself
2152
- *
2153
- */
2154
- shouldTrapFocus?: boolean; /** The base width to apply to the Modal */
2106
+ * Whether or not the modal should trap focus within itself
2107
+ *
2108
+ */
2109
+ shouldTrapFocus?: boolean;
2110
+ /** The base width to apply to the Modal */
2155
2111
  width?: string;
2156
2112
  /**
2157
- * The overflow behavior to apply to the modal
2158
- * @default 'auto'
2159
- */
2113
+ * The overflow behavior to apply to the modal
2114
+ * @default 'auto'
2115
+ */
2160
2116
  overflow?: "auto" | "clip" | "hidden" | "scroll" | "visible";
2161
2117
  };
2162
2118
  declare const Modal: FC<ModalProps>;
@@ -2168,24 +2124,21 @@ declare const ModalBody: IStyledComponent<"web", DivProps>;
2168
2124
  declare const ModalFooter: IStyledComponent<"web", DivProps>;
2169
2125
  type ModalCloseButtonProps = {
2170
2126
  /**
2171
- * Callback invoked when the button is clicked
2172
- */
2127
+ * Callback invoked when the button is clicked
2128
+ */
2173
2129
  onClick?: (event: MouseEvent) => void;
2174
2130
  };
2175
- declare const ModalCloseButton: ({
2176
- onClick,
2177
- ...props
2178
- }: ModalCloseButtonProps) => JSX.Element;
2131
+ declare const ModalCloseButton: ({ onClick, ...props }: ModalCloseButtonProps) => JSX.Element;
2179
2132
  //#endregion
2180
2133
  //#region src/components/Paper/Paper.d.ts
2181
2134
  type PaperProps = ComponentPropsWithoutRef<"div"> & {
2182
2135
  /**
2183
- * The content within Paper component
2184
- */
2136
+ * The content within Paper component
2137
+ */
2185
2138
  children: ReactNode;
2186
2139
  /**
2187
- * The "elevation" level of the Paper component
2188
- */
2140
+ * The "elevation" level of the Paper component
2141
+ */
2189
2142
  elevation?: 0 | 1 | 2 | undefined;
2190
2143
  };
2191
2144
  declare const Paper: FC<PaperProps>;
@@ -2193,24 +2146,24 @@ declare const Paper: FC<PaperProps>;
2193
2146
  //#region src/components/ProgressBar/ProgressBar.d.ts
2194
2147
  type ProgressBarProps = ComponentPropsWithoutRef<"div"> & {
2195
2148
  /**
2196
- * Whether the progress bar has a label
2197
- */
2149
+ * Whether the progress bar has a label
2150
+ */
2198
2151
  hasLabel?: boolean;
2199
2152
  /**
2200
- * Current numeric level of the progress (0 -> 1)
2201
- */
2153
+ * Current numeric level of the progress (0 -> 1)
2154
+ */
2202
2155
  progress?: number;
2203
2156
  /**
2204
- * Allows user to override default progress bar label colors
2205
- */
2157
+ * Allows user to override default progress bar label colors
2158
+ */
2206
2159
  labelColorOverride?: string;
2207
2160
  /**
2208
- * Allows user to override default progress bar meter background colors
2209
- */
2161
+ * Allows user to override default progress bar meter background colors
2162
+ */
2210
2163
  meterBgColorOverride?: string;
2211
2164
  /**
2212
- * Allows user to override default colors
2213
- */
2165
+ * Allows user to override default colors
2166
+ */
2214
2167
  colorOverride?: string;
2215
2168
  };
2216
2169
  declare const ProgressBar: FC<ProgressBarProps>;
@@ -2218,50 +2171,50 @@ declare const ProgressBar: FC<ProgressBarProps>;
2218
2171
  //#region src/components/Radio/Radio.d.ts
2219
2172
  type RadioProps = Omit<ComponentPropsWithoutRef<"input">, "value"> & {
2220
2173
  /**
2221
- * Indicates the state of the radio
2222
- */
2174
+ * Indicates the state of the radio
2175
+ */
2223
2176
  checked?: boolean;
2224
2177
  /**
2225
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
2226
- */
2178
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
2179
+ */
2227
2180
  direction?: "column" | "row";
2228
2181
  /**
2229
- * Disables input
2230
- */
2182
+ * Disables input
2183
+ */
2231
2184
  disabled?: boolean;
2232
2185
  /**
2233
- * @ignore // I don't know what to do with this
2234
- * Force a Radio into a particular css state (for debugging)
2235
- */
2186
+ * @ignore // I don't know what to do with this
2187
+ * Force a Radio into a particular css state (for debugging)
2188
+ */
2236
2189
  forceState?: "focus" | "hover";
2237
2190
  /**
2238
- * Indicates that there is an error with the input
2239
- */
2191
+ * Indicates that there is an error with the input
2192
+ */
2240
2193
  hasError?: boolean;
2241
2194
  /**
2242
- * Provides an ID for the input
2243
- */
2195
+ * Provides an ID for the input
2196
+ */
2244
2197
  id?: string;
2245
2198
  /**
2246
- * The label for the input
2247
- */
2199
+ * The label for the input
2200
+ */
2248
2201
  label: JSX.Element | string;
2249
2202
  /**
2250
- * The description for the input
2251
- */
2203
+ * The description for the input
2204
+ */
2252
2205
  labelDescription?: JSX.Element | string | undefined;
2253
2206
  /**
2254
- * Should match the ID attribute of the radio.
2255
- * Can be used to group together multiple radios
2256
- */
2207
+ * Should match the ID attribute of the radio.
2208
+ * Can be used to group together multiple radios
2209
+ */
2257
2210
  name?: string;
2258
2211
  /**
2259
- * Callback function invoked when the value changes
2260
- */
2212
+ * Callback function invoked when the value changes
2213
+ */
2261
2214
  onChange?: (event: ChangeEvent) => unknown;
2262
2215
  /**
2263
- * The value attribute of the input
2264
- */
2216
+ * The value attribute of the input
2217
+ */
2265
2218
  value?: string;
2266
2219
  };
2267
2220
  declare const Radio: ForwardRefExoticComponent<RadioProps & RefAttributes<HTMLLabelElement>>;
@@ -2269,47 +2222,47 @@ declare const Radio: ForwardRefExoticComponent<RadioProps & RefAttributes<HTMLLa
2269
2222
  //#region src/components/RadioGroup/RadioGroup.d.ts
2270
2223
  type RadioGroupProps = Omit<ComponentPropsWithoutRef<"div">, "onChange"> & {
2271
2224
  /**
2272
- * Should the radio buttons be displayed vertically as a column or horizontally as a row
2273
- */
2225
+ * Should the radio buttons be displayed vertically as a column or horizontally as a row
2226
+ */
2274
2227
  direction?: "column" | "row";
2275
2228
  /**
2276
- * Whether RadioGroup is disabled
2277
- */
2229
+ * Whether RadioGroup is disabled
2230
+ */
2278
2231
  disabled?: boolean;
2279
2232
  /**
2280
- * Error message to be displayed
2281
- */
2233
+ * Error message to be displayed
2234
+ */
2282
2235
  error?: string | undefined;
2283
2236
  /**
2284
- * The label for the form field
2285
- */
2237
+ * The label for the form field
2238
+ */
2286
2239
  label?: JSX.Element | string | null | undefined;
2287
2240
  /**
2288
- * The hint/helper text under the label
2289
- */
2241
+ * The hint/helper text under the label
2242
+ */
2290
2243
  labelDescription?: JSX.Element | string | undefined;
2291
2244
  /**
2292
- * Props that are passed through to the underlying `<Label>` component
2293
- */
2245
+ * Props that are passed through to the underlying `<Label>` component
2246
+ */
2294
2247
  labelProps?: {
2295
2248
  disabled?: boolean;
2296
2249
  screenReaderOnly?: boolean;
2297
2250
  };
2298
2251
  /**
2299
- * Should match the ID attribute of the radio. Can be used to group together multiple radios
2300
- */
2252
+ * Should match the ID attribute of the radio. Can be used to group together multiple radios
2253
+ */
2301
2254
  name: string;
2302
2255
  /**
2303
- * Fires on checking or unchecking radios in group
2304
- */
2256
+ * Fires on checking or unchecking radios in group
2257
+ */
2305
2258
  onChange?: (event: ChangeEvent, value: RadioProps["value"]) => unknown;
2306
2259
  /**
2307
- * Array of radios attributes
2308
- */
2260
+ * Array of radios attributes
2261
+ */
2309
2262
  options: Pick<RadioProps, "disabled" | "label" | "labelDescription" | "value">[];
2310
2263
  /**
2311
- * Currently selected radio value
2312
- */
2264
+ * Currently selected radio value
2265
+ */
2313
2266
  value?: string | undefined;
2314
2267
  };
2315
2268
  declare const RadioGroup: FC<RadioGroupProps>;
@@ -2331,55 +2284,55 @@ type Preset = {
2331
2284
  };
2332
2285
  type RangeSelectorProps = {
2333
2286
  /**
2334
- * Align the popup to the left or the right of the tigger button
2335
- */
2287
+ * Align the popup to the left or the right of the tigger button
2288
+ */
2336
2289
  align?: "left" | "right";
2337
2290
  /**
2338
- * The variant to be passed to the button component
2339
- */
2291
+ * The variant to be passed to the button component
2292
+ */
2340
2293
  buttonVariant?: "input" | "primary" | "secondary" | "tertiary";
2341
2294
  /**
2342
- * The earliest selectable date
2343
- */
2295
+ * The earliest selectable date
2296
+ */
2344
2297
  earliestDate?: Date;
2345
2298
  /**
2346
- * The latest selectable date
2347
- */
2299
+ * The latest selectable date
2300
+ */
2348
2301
  latestDate?: Date;
2349
2302
  /**
2350
- * Text to display in the footer
2351
- */
2303
+ * Text to display in the footer
2304
+ */
2352
2305
  footerText?: JSX.Element | string;
2353
2306
  /**
2354
- * A function that receives a date range object and returns a string to be rendered in the
2355
- * trigger button
2356
- */
2307
+ * A function that receives a date range object and returns a string to be rendered in the
2308
+ * trigger button
2309
+ */
2357
2310
  format?: (dataRange: DateRangeType) => JSX.Element | string;
2358
2311
  /**
2359
- * Callback fired when the date range changes
2360
- */
2312
+ * Callback fired when the date range changes
2313
+ */
2361
2314
  onChange?: (dateRange: DateRangeType) => unknown;
2362
2315
  presets?: Preset[];
2363
2316
  /**
2364
- * The date range to be displayed in the picker
2365
- */
2317
+ * The date range to be displayed in the picker
2318
+ */
2366
2319
  range?: DateRangeType;
2367
2320
  /**
2368
- * Prevent dates in the future from being selected
2369
- */
2321
+ * Prevent dates in the future from being selected
2322
+ */
2370
2323
  shouldPreventFuture?: boolean;
2371
2324
  /**
2372
- * If true, the button will take up the full width of its container
2373
- */
2325
+ * If true, the button will take up the full width of its container
2326
+ */
2374
2327
  fullWidth?: boolean;
2375
2328
  /**
2376
- * A custom width for the RangeSelector component (in px, %, or other CSS units)
2377
- */
2329
+ * A custom width for the RangeSelector component (in px, %, or other CSS units)
2330
+ */
2378
2331
  width?: number | string;
2379
2332
  /**
2380
- * A custom React component to use as the trigger button. The component should accept onClick,
2381
- * children, and other standard button props.
2382
- */
2333
+ * A custom React component to use as the trigger button. The component should accept onClick,
2334
+ * children, and other standard button props.
2335
+ */
2383
2336
  customTriggerComponent?: ComponentType<Record<string, any>>;
2384
2337
  };
2385
2338
  declare const RangeSelector: FC<RangeSelectorProps>;
@@ -2387,44 +2340,44 @@ declare const RangeSelector: FC<RangeSelectorProps>;
2387
2340
  //#region src/components/RichTextEditor/RichTextEditor.d.ts
2388
2341
  type RichTextEditorProps = {
2389
2342
  /**
2390
- * Optional id to set aria-labelledby
2391
- */
2343
+ * Optional id to set aria-labelledby
2344
+ */
2392
2345
  ariaLabelledBy?: string | undefined;
2393
2346
  /**
2394
- * @ignore
2395
- */
2347
+ * @ignore
2348
+ */
2396
2349
  "data-testid"?: string;
2397
2350
  /**
2398
- * Determines whether editor is clickable/read-only
2399
- */
2351
+ * Determines whether editor is clickable/read-only
2352
+ */
2400
2353
  disabled?: boolean;
2401
2354
  /**
2402
- * Formats to enable in editor, restricted to rteFormatTypes
2403
- */
2355
+ * Formats to enable in editor, restricted to rteFormatTypes
2356
+ */
2404
2357
  enabledFormats?: (keyof typeof rteFormatTypes)[];
2405
2358
  /**
2406
- * Function to be called after editor state update
2407
- */
2359
+ * Function to be called after editor state update
2360
+ */
2408
2361
  onChange?: ((value: NodeElementObject[]) => void) | undefined;
2409
2362
  /**
2410
- * Function to be called when editor loses focus
2411
- */
2363
+ * Function to be called when editor loses focus
2364
+ */
2412
2365
  onBlur?: ((value: NodeElementObject[]) => void) | undefined;
2413
2366
  /**
2414
- * Placeholder text
2415
- */
2367
+ * Placeholder text
2368
+ */
2416
2369
  placeholder?: string;
2417
2370
  /**
2418
- * Value of editor based on controlled input
2419
- */
2371
+ * Value of editor based on controlled input
2372
+ */
2420
2373
  value?: NodeObject[];
2421
2374
  /**
2422
- * Whether to update the editor when the value prop changes
2423
- */
2375
+ * Whether to update the editor when the value prop changes
2376
+ */
2424
2377
  useExternalValue: boolean;
2425
2378
  /**
2426
- * Custom height of editor
2427
- */
2379
+ * Custom height of editor
2380
+ */
2428
2381
  height?: string | undefined;
2429
2382
  };
2430
2383
  declare const RichTextEditor: FC<RichTextEditorProps>;
@@ -2437,17 +2390,17 @@ declare const rteDeserializeHTML: (htmlString: string) => (NodeObject | string |
2437
2390
  declare const screenReaderOnlyStyle: RuleSet<object>;
2438
2391
  type ScreenReaderOnlyProps = ComponentPropsWithoutRef<"div"> & {
2439
2392
  /**
2440
- * Pass an arbitrary child node
2441
- */
2393
+ * Pass an arbitrary child node
2394
+ */
2442
2395
  children?: ReactNode;
2443
2396
  /**
2444
- * Display content _only_ when it's focused.
2445
- */
2397
+ * Display content _only_ when it's focused.
2398
+ */
2446
2399
  focusable?: boolean;
2447
2400
  /**
2448
- * The text that will appear to screenreaders but not be displayed on screen
2449
- * (alternatively you can pass children)
2450
- */
2401
+ * The text that will appear to screenreaders but not be displayed on screen
2402
+ * (alternatively you can pass children)
2403
+ */
2451
2404
  text?: ReactNode;
2452
2405
  };
2453
2406
  declare const ScreenReaderOnly: FC<ScreenReaderOnlyProps>;
@@ -2466,54 +2419,54 @@ type OptionType = {
2466
2419
  type OptionsType = GroupOptionType[] | OptionType[];
2467
2420
  type SelectProps = Omit<ComponentPropsWithRef<"select">, "placeholder"> & {
2468
2421
  /**
2469
- * Optional accessible label for when there is no accompanying <label> element
2470
- */
2422
+ * Optional accessible label for when there is no accompanying <label> element
2423
+ */
2471
2424
  ariaLabel?: string;
2472
2425
  /**
2473
- * Disables Select
2474
- */
2426
+ * Disables Select
2427
+ */
2475
2428
  disabled?: boolean;
2476
2429
  /**
2477
- * @ignore
2478
- * Force a Select into a particular css state (for debugging)
2479
- */
2430
+ * @ignore
2431
+ * Force a Select into a particular css state (for debugging)
2432
+ */
2480
2433
  forceState?: "active" | "focus" | "hover";
2481
2434
  /**
2482
- * Should Select occupy 100% of available space
2483
- */
2435
+ * Should Select occupy 100% of available space
2436
+ */
2484
2437
  fullWidth?: boolean;
2485
2438
  /**
2486
- * Indicates that there is an error with the Select
2487
- */
2439
+ * Indicates that there is an error with the Select
2440
+ */
2488
2441
  hasError?: boolean;
2489
2442
  /**
2490
- * Change option's label name from "label"
2491
- */
2443
+ * Change option's label name from "label"
2444
+ */
2492
2445
  labelName?: string;
2493
2446
  /**
2494
- * Allow multiple options in the list to be selected at the same time
2495
- */
2447
+ * Allow multiple options in the list to be selected at the same time
2448
+ */
2496
2449
  multiple?: boolean;
2497
2450
  /**
2498
- * Data structure to populate option labels & values. (`{ label, value, disabled }`)
2499
- * Additionally this can be used to render option groupings. (`{ groupLabel, groupOptions, disabled }`)
2500
- */
2451
+ * Data structure to populate option labels & values. (`{ label, value, disabled }`)
2452
+ * Additionally this can be used to render option groupings. (`{ groupLabel, groupOptions, disabled }`)
2453
+ */
2501
2454
  options: OptionsType;
2502
2455
  /**
2503
- * Value of text to appear by default as first option in Select, use `null` for none
2504
- */
2456
+ * Value of text to appear by default as first option in Select, use `null` for none
2457
+ */
2505
2458
  placeholder?: string | null | undefined;
2506
2459
  /**
2507
- * Prevent the placeholder value from being selected
2508
- */
2460
+ * Prevent the placeholder value from being selected
2461
+ */
2509
2462
  preventPlaceholderSelection?: boolean;
2510
2463
  /**
2511
- * Make Select a required element
2512
- */
2464
+ * Make Select a required element
2465
+ */
2513
2466
  required?: boolean;
2514
2467
  /**
2515
- * Change option's value name from "value"
2516
- */
2468
+ * Change option's value name from "value"
2469
+ */
2517
2470
  valueName?: string;
2518
2471
  };
2519
2472
  declare const Select: ForwardRefExoticComponent<SelectProps & RefAttributes<HTMLSelectElement>>;
@@ -2522,59 +2475,59 @@ declare const Select: ForwardRefExoticComponent<SelectProps & RefAttributes<HTML
2522
2475
  type ComponentPropsWithoutRefWithoutOnChange = Omit<ComponentPropsWithoutRef<"div">, "onChange">;
2523
2476
  type SliderProps = ComponentPropsWithoutRefWithoutOnChange & {
2524
2477
  /**
2525
- * aria-label for screen-readers to apply to the thumbs. Use an array for more than one thumb.
2526
- * The length of the array must match the number of thumbs in the value array.
2527
- */
2478
+ * aria-label for screen-readers to apply to the thumbs. Use an array for more than one thumb.
2479
+ * The length of the array must match the number of thumbs in the value array.
2480
+ */
2528
2481
  ariaLabel?: string[] | string | undefined;
2529
2482
  /**
2530
- * aria-labelledby for screen-readers to apply to the thumbs. Used when slider rendered with separate label.
2531
- * Use an array for more than one thumb. The length of the array must match the number of thumbs in the value array.
2532
- */
2483
+ * aria-labelledby for screen-readers to apply to the thumbs. Used when slider rendered with separate label.
2484
+ * Use an array for more than one thumb. The length of the array must match the number of thumbs in the value array.
2485
+ */
2533
2486
  ariaLabelledby?: string[] | string | undefined;
2534
2487
  /**
2535
- *
2536
- */
2488
+ *
2489
+ */
2537
2490
  ariaValuetext?: string | ((state: Record<string, unknown>) => unknown);
2538
2491
  /**
2539
- * @ignore
2540
- */
2492
+ * @ignore
2493
+ */
2541
2494
  "data-testid"?: string;
2542
2495
  /**
2543
- * Determines the initial position(s) of the thumb(s) and the number of thumbs.
2544
- *
2545
- * If a number is passed a slider with one thumb will be rendered.
2546
- * If an array is passed each value will determine the position of one thumb.
2547
- * The values in the array must be sorted.
2548
- *
2549
- * Don't pass a default value if the slider is controlled (i.e. if you already
2550
- * use the `value` prop).
2551
- */
2496
+ * Determines the initial position(s) of the thumb(s) and the number of thumbs.
2497
+ *
2498
+ * If a number is passed a slider with one thumb will be rendered.
2499
+ * If an array is passed each value will determine the position of one thumb.
2500
+ * The values in the array must be sorted.
2501
+ *
2502
+ * Don't pass a default value if the slider is controlled (i.e. if you already
2503
+ * use the `value` prop).
2504
+ */
2552
2505
  initialValue?: number[] | number | undefined;
2553
2506
  /**
2554
- * If `true` the thumbs can't be moved.
2555
- */
2507
+ * If `true` the thumbs can't be moved.
2508
+ */
2556
2509
  disabled?: boolean;
2557
2510
  /**
2558
- * The maximum value of the slider.
2559
- */
2511
+ * The maximum value of the slider.
2512
+ */
2560
2513
  max?: number;
2561
2514
  /**
2562
- * The minimum value of the slider.
2563
- */
2515
+ * The minimum value of the slider.
2516
+ */
2564
2517
  min?: number;
2565
2518
  /**
2566
- * Callback called on every value change. The function will be called with two arguments,
2567
- * the first being the new value(s) the second being thumb index. **It does not return an event.**
2568
- */
2519
+ * Callback called on every value change. The function will be called with two arguments,
2520
+ * the first being the new value(s) the second being thumb index. **It does not return an event.**
2521
+ */
2569
2522
  onChange?: (value: number, index?: number) => unknown;
2570
2523
  /**
2571
- * Value to be added or subtracted on each step the slider makes. Must be greater than zero.
2572
- * max - min should be evenly divisible by the step value.
2573
- */
2524
+ * Value to be added or subtracted on each step the slider makes. Must be greater than zero.
2525
+ * max - min should be evenly divisible by the step value.
2526
+ */
2574
2527
  step?: number;
2575
2528
  /**
2576
- * Like 'initialValue' but for controlled components.
2577
- */
2529
+ * Like 'initialValue' but for controlled components.
2530
+ */
2578
2531
  value?: number[] | number;
2579
2532
  };
2580
2533
  declare const Slider: FC<SliderProps>;
@@ -2582,17 +2535,17 @@ declare const Slider: FC<SliderProps>;
2582
2535
  //#region src/components/Stack/Stack.d.ts
2583
2536
  type StackProps<T extends ElementType> = ComponentPropsWithoutRef<T> & PropsWithChildren & {
2584
2537
  /**
2585
- * The gap between each item in the stack. Should be one of the spacing values from the theme
2586
- */
2538
+ * The gap between each item in the stack. Should be one of the spacing values from the theme
2539
+ */
2587
2540
  gap?: keyof DefaultTheme["spacing"];
2588
2541
  /**
2589
- * Vertical is equivalent to `flex-direction: column;`, horizontal is equivalent to `flex-direction: row;`.
2590
- * The default behavior is `vertical`.
2591
- */
2542
+ * Vertical is equivalent to `flex-direction: column;`, horizontal is equivalent to `flex-direction: row;`.
2543
+ * The default behavior is `vertical`.
2544
+ */
2592
2545
  direction?: "horizontal" | "vertical";
2593
2546
  /**
2594
- * The element (e.g. div, span, p) or component to render as the root element.
2595
- */
2547
+ * The element (e.g. div, span, p) or component to render as the root element.
2548
+ */
2596
2549
  renderAs?: T | "div";
2597
2550
  };
2598
2551
  declare const Stack: ForwardRefExoticComponent<StackProps<ElementType> & RefAttributes<HTMLDivElement>>;
@@ -2600,24 +2553,24 @@ declare const Stack: ForwardRefExoticComponent<StackProps<ElementType> & RefAttr
2600
2553
  //#region src/components/Switch/Switch.d.ts
2601
2554
  type SwitchProps = Omit<ComponentPropsWithoutRef<"button">, "onChange"> & {
2602
2555
  /**
2603
- * Allows user to override default "on" color
2604
- */
2556
+ * Allows user to override default "on" color
2557
+ */
2605
2558
  colorOverride?: string;
2606
2559
  /**
2607
- * Controls the `aria-disabled` property of the Switch
2608
- */
2560
+ * Controls the `aria-disabled` property of the Switch
2561
+ */
2609
2562
  disabled?: boolean;
2610
2563
  /**
2611
- * Determines if switch is checked
2612
- */
2564
+ * Determines if switch is checked
2565
+ */
2613
2566
  isChecked?: boolean;
2614
2567
  /**
2615
- * Callback function invoked when the switch checked state changes
2616
- */
2568
+ * Callback function invoked when the switch checked state changes
2569
+ */
2617
2570
  onChange?: (isChecked: boolean) => unknown;
2618
2571
  /**
2619
- * Controls wether or not the ON / OFF text is shown
2620
- */
2572
+ * Controls wether or not the ON / OFF text is shown
2573
+ */
2621
2574
  hideText?: boolean;
2622
2575
  };
2623
2576
  declare const Switch: FC<SwitchProps>;
@@ -2656,52 +2609,52 @@ declare const variantStyleMap: {
2656
2609
  };
2657
2610
  type TextProps = ComponentPropsWithoutRef<"div"> & {
2658
2611
  /**
2659
- * The horizontal alignment
2660
- * <br />
2661
- * _Note: this only affects block elements_
2662
- */
2612
+ * The horizontal alignment
2613
+ * <br />
2614
+ * _Note: this only affects block elements_
2615
+ */
2663
2616
  align?: keyof typeof alignMap;
2664
2617
  /**
2665
- * Displays text as bold type
2666
- */
2618
+ * Displays text as bold type
2619
+ */
2667
2620
  bold?: boolean;
2668
2621
  /**
2669
- * Pass an arbitrary child node
2670
- */
2622
+ * Pass an arbitrary child node
2623
+ */
2671
2624
  children?: ReactNode | undefined;
2672
2625
  /**
2673
- * Allows user to override default button colors
2674
- */
2626
+ * Allows user to override default button colors
2627
+ */
2675
2628
  colorOverride?: string;
2676
2629
  /**
2677
- * Used to indicate text is part of a "disabled" UI
2678
- */
2630
+ * Used to indicate text is part of a "disabled" UI
2631
+ */
2679
2632
  disabled?: boolean;
2680
2633
  /**
2681
- * Attempt to keep the text to a single line by truncating with an ellipsis
2682
- * <br />
2683
- * _Note: this only affects block elements_
2684
- */
2634
+ * Attempt to keep the text to a single line by truncating with an ellipsis
2635
+ * <br />
2636
+ * _Note: this only affects block elements_
2637
+ */
2685
2638
  ellipsis?: boolean;
2686
2639
  /**
2687
- * Display the text as inline content
2688
- */
2640
+ * Display the text as inline content
2641
+ */
2689
2642
  inline?: boolean;
2690
2643
  /**
2691
- * Displays text as italic type
2692
- */
2644
+ * Displays text as italic type
2645
+ */
2693
2646
  italic?: boolean;
2694
2647
  /**
2695
- * Prevents text from being highlighted and copied
2696
- */
2648
+ * Prevents text from being highlighted and copied
2649
+ */
2697
2650
  preventUserSelect?: boolean;
2698
2651
  /**
2699
- * The type of html element to render as
2700
- */
2652
+ * The type of html element to render as
2653
+ */
2701
2654
  renderAs?: keyof typeof renderMap;
2702
2655
  /**
2703
- * The text style to display
2704
- */
2656
+ * The text style to display
2657
+ */
2705
2658
  variant?: keyof typeof variantStyleMap;
2706
2659
  };
2707
2660
  declare const Text: ForwardRefExoticComponent<TextProps & RefAttributes<HTMLElement>>;
@@ -2712,56 +2665,56 @@ type GradientNameType = "defaultDarkOne" | "defaultDarkTwo" | "defaultLightOne"
2712
2665
  //#region src/components/Thumbnail/Thumbnail.d.ts
2713
2666
  type IconThumbnailProps = {
2714
2667
  /**
2715
- * The desired display of the thumbnail, either wide or square
2716
- */
2668
+ * The desired display of the thumbnail, either wide or square
2669
+ */
2717
2670
  thumbnailImageType?: never;
2718
2671
  /**
2719
- * The URL of the thumbnail image to display
2720
- */
2672
+ * The URL of the thumbnail image to display
2673
+ */
2721
2674
  thumbnailUrl?: never;
2722
2675
  /**
2723
- * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
2724
- */
2676
+ * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
2677
+ */
2725
2678
  icon: IconNameType;
2726
2679
  /**
2727
- * The color of the icon
2728
- */
2680
+ * The color of the icon
2681
+ */
2729
2682
  iconColor?: string;
2730
2683
  };
2731
2684
  type ImageThumbnailProps = {
2732
2685
  /**
2733
- * The desired display of the thumbnail, either wide or square
2734
- */
2686
+ * The desired display of the thumbnail, either wide or square
2687
+ */
2735
2688
  thumbnailImageType?: "square" | "wide" | undefined;
2736
2689
  /**
2737
- * The URL of the thumbnail image to display
2738
- */
2690
+ * The URL of the thumbnail image to display
2691
+ */
2739
2692
  thumbnailUrl: string[] | string | null;
2740
2693
  /**
2741
- * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
2742
- */
2694
+ * The type of {@link https://wistia.github.io/vhs/?path=/docs/components-icon--docs Icon} to use in place of a thumbnail image
2695
+ */
2743
2696
  icon?: never;
2744
2697
  /**
2745
- * The color of the icon
2746
- */
2698
+ * The color of the icon
2699
+ */
2747
2700
  iconColor?: never;
2748
2701
  };
2749
2702
  type ThumbnailProps = ComponentPropsWithoutRef<"div"> & {
2750
2703
  /**
2751
- * Text that displays in the bottom right hand corner of the thumbnail, usually the media duration
2752
- */
2704
+ * Text that displays in the bottom right hand corner of the thumbnail, usually the media duration
2705
+ */
2753
2706
  bottomRightText?: string;
2754
2707
  /**
2755
- * Icon to display in bottom right corner of the thumbnail
2756
- */
2708
+ * Icon to display in bottom right corner of the thumbnail
2709
+ */
2757
2710
  bottomRightIcon?: IconNameType;
2758
2711
  /**
2759
- * The type of gradient to show either behind the icon or when there is no thumbnail image
2760
- */
2712
+ * The type of gradient to show either behind the icon or when there is no thumbnail image
2713
+ */
2761
2714
  gradientBackground?: GradientNameType;
2762
2715
  /**
2763
- * Width of the thumbnail. By default, the thumbnail will grow to fit its container.
2764
- */
2716
+ * Width of the thumbnail. By default, the thumbnail will grow to fit its container.
2717
+ */
2765
2718
  width?: string;
2766
2719
  } & (IconThumbnailProps | ImageThumbnailProps);
2767
2720
  declare const Thumbnail: FC<ThumbnailProps>;
@@ -2769,59 +2722,55 @@ declare const Thumbnail: FC<ThumbnailProps>;
2769
2722
  //#region src/components/ThumbnailCollage/ThumbnailCollage.d.ts
2770
2723
  type ThumbnailCollageProps = {
2771
2724
  /**
2772
- * An array of image urls to show in the thumbnail. Supports up to 3 images
2773
- */
2725
+ * An array of image urls to show in the thumbnail. Supports up to 3 images
2726
+ */
2774
2727
  thumbnailUrls: string[];
2775
2728
  /**
2776
- * The type of gradient to show when there are no thumbnail urls
2777
- */
2729
+ * The type of gradient to show when there are no thumbnail urls
2730
+ */
2778
2731
  gradientBackground?: GradientNameType;
2779
2732
  };
2780
- declare const ThumbnailCollage: ({
2781
- thumbnailUrls,
2782
- gradientBackground,
2783
- ...props
2784
- }: ThumbnailCollageProps) => JSX.Element;
2733
+ declare const ThumbnailCollage: ({ thumbnailUrls, gradientBackground, ...props }: ThumbnailCollageProps) => JSX.Element;
2785
2734
  //#endregion
2786
2735
  //#region src/components/Toast/Toast.d.ts
2787
2736
  type ToastVariants = "dangerous" | "error" | "success" | "warning";
2788
2737
  type ToastProps = ComponentPropsWithoutRef<"div"> & {
2789
2738
  /**
2790
- * A function that will be invoked when the action button is clicked instead of the internal handler
2791
- */
2739
+ * A function that will be invoked when the action button is clicked instead of the internal handler
2740
+ */
2792
2741
  actionInterceptor?: (() => void) | undefined;
2793
2742
  /**
2794
- * The text of the "action" button on the right
2795
- */
2743
+ * The text of the "action" button on the right
2744
+ */
2796
2745
  actionLabel?: string | undefined;
2797
2746
  /**
2798
- * A hex value that will override the color values defined by `variant`
2799
- */
2747
+ * A hex value that will override the color values defined by `variant`
2748
+ */
2800
2749
  colorOverride?: string | undefined;
2801
2750
  /**
2802
- * @ignore
2803
- * Avoids animation and positions Toast in normal flow for documentation/testing purposes
2804
- */
2751
+ * @ignore
2752
+ * Avoids animation and positions Toast in normal flow for documentation/testing purposes
2753
+ */
2805
2754
  renderInPlace?: boolean;
2806
2755
  /**
2807
- * Determines whether Toast is displayed
2808
- */
2756
+ * Determines whether Toast is displayed
2757
+ */
2809
2758
  isOpen?: boolean;
2810
2759
  /**
2811
- * The message displayed in the toast
2812
- */
2760
+ * The message displayed in the toast
2761
+ */
2813
2762
  message: string;
2814
2763
  /**
2815
- * Callback that is invoked when toasts closes (via timeout or close button)
2816
- */
2764
+ * Callback that is invoked when toasts closes (via timeout or close button)
2765
+ */
2817
2766
  onClose: () => void;
2818
2767
  /**
2819
- * The time in ms before the Toast calls the onClose function
2820
- */
2768
+ * The time in ms before the Toast calls the onClose function
2769
+ */
2821
2770
  timeout?: number | undefined;
2822
2771
  /**
2823
- * The kind of Toast to display
2824
- */
2772
+ * The kind of Toast to display
2773
+ */
2825
2774
  variant?: ToastVariants | undefined;
2826
2775
  };
2827
2776
  declare const Toast: MemoExoticComponent<(props: ToastProps) => JSX.Element>;
@@ -2841,58 +2790,56 @@ type UseToastFn = (props: UseToastProps) => void;
2841
2790
  declare const useToast: () => UseToastFn;
2842
2791
  //#endregion
2843
2792
  //#region src/components/Toast/ToastProvider.d.ts
2844
- declare const ToastProvider: ({
2845
- children
2846
- }: {
2793
+ declare const ToastProvider: ({ children }: {
2847
2794
  children: ReactNode;
2848
2795
  }) => JSX.Element;
2849
2796
  //#endregion
2850
2797
  //#region src/components/Tooltip/Tooltip.d.ts
2851
2798
  type TooltipProps = Omit<ComponentPropsWithoutRef<"div">, "id"> & {
2852
2799
  /**
2853
- * The node that will be wrapped by the Tooltip
2854
- */
2800
+ * The node that will be wrapped by the Tooltip
2801
+ */
2855
2802
  children: ReactNode;
2856
2803
  /**
2857
- * Where the tooltip should appear in relation to wrapped component
2858
- */
2804
+ * Where the tooltip should appear in relation to wrapped component
2805
+ */
2859
2806
  direction?: "bottom" | "left" | "right" | "top";
2860
2807
  /**
2861
- * Length of time to wait before dismissing Tooltip for click eventType
2862
- */
2808
+ * Length of time to wait before dismissing Tooltip for click eventType
2809
+ */
2863
2810
  duration?: boolean | number | string;
2864
2811
  /**
2865
- * The type of event that triggers display of Tooltip
2866
- */
2812
+ * The type of event that triggers display of Tooltip
2813
+ */
2867
2814
  eventType?: "click" | "hover";
2868
2815
  /**
2869
- * @ignore
2870
- * Force a Tooltip to display it's content without user interaction (for debugging)
2871
- */
2816
+ * @ignore
2817
+ * Force a Tooltip to display it's content without user interaction (for debugging)
2818
+ */
2872
2819
  forceState?: "open" | undefined;
2873
2820
  /**
2874
- * ID for tooltip (automatically created if omitted)
2875
- */
2821
+ * ID for tooltip (automatically created if omitted)
2822
+ */
2876
2823
  id?: string | null | undefined;
2877
2824
  /**
2878
- * The content that will appear in the Tooltip popup
2879
- */
2825
+ * The content that will appear in the Tooltip popup
2826
+ */
2880
2827
  label: ReactNode;
2881
2828
  /**
2882
- * The maximum number of characters to display inside the Tooltip
2883
- */
2829
+ * The maximum number of characters to display inside the Tooltip
2830
+ */
2884
2831
  maxChars?: number | null;
2885
2832
  /**
2886
- * Whether content within the label should wrap
2887
- */
2833
+ * Whether content within the label should wrap
2834
+ */
2888
2835
  shouldWrap?: boolean;
2889
2836
  /**
2890
- * Color to override background of the tooltip.
2891
- */
2837
+ * Color to override background of the tooltip.
2838
+ */
2892
2839
  backgroundColorOverride?: string;
2893
2840
  /**
2894
- * Color to override font color of the tooltip.
2895
- */
2841
+ * Color to override font color of the tooltip.
2842
+ */
2896
2843
  fontColorOverride?: string;
2897
2844
  };
2898
2845
  declare const Tooltip: FC<TooltipProps>;
@@ -2900,20 +2847,20 @@ declare const Tooltip: FC<TooltipProps>;
2900
2847
  //#region src/components/Truncate/Truncate.d.ts
2901
2848
  type TruncateProps = {
2902
2849
  /**
2903
- * Prevent ellipsis from truncating mid-word
2904
- */
2850
+ * Prevent ellipsis from truncating mid-word
2851
+ */
2905
2852
  breakOnWords?: boolean;
2906
2853
  /**
2907
- * The string to be truncated
2908
- */
2854
+ * The string to be truncated
2855
+ */
2909
2856
  children: string | null | undefined;
2910
2857
  /**
2911
- * The maximum number of characters to display inside the Tooltip
2912
- */
2858
+ * The maximum number of characters to display inside the Tooltip
2859
+ */
2913
2860
  maxChars: number;
2914
2861
  /**
2915
- * A string to append to the truncated string
2916
- */
2862
+ * A string to append to the truncated string
2863
+ */
2917
2864
  terminator?: string;
2918
2865
  };
2919
2866
  declare const Truncate: FC<TruncateProps>;
@@ -2921,35 +2868,35 @@ declare const Truncate: FC<TruncateProps>;
2921
2868
  //#region src/components/WistiaLogo/WistiaLogo.d.ts
2922
2869
  type WistiaLogoProps = Omit<ComponentPropsWithoutRef<"svg">, "href"> & {
2923
2870
  /**
2924
- * An optional accessible description for the logo
2925
- */
2871
+ * An optional accessible description for the logo
2872
+ */
2926
2873
  description?: string;
2927
2874
  /**
2928
- * Height, in pixels, of the logo
2929
- */
2875
+ * Height, in pixels, of the logo
2876
+ */
2930
2877
  height?: number;
2931
2878
  /**
2932
- * @ignore
2933
- * Change the color when hovering over the logo
2934
- */
2879
+ * @ignore
2880
+ * Change the color when hovering over the logo
2881
+ */
2935
2882
  hoverColor?: string;
2936
2883
  /**
2937
- * Display just the icon portion of the logo (ie. hide `Wistia` text)
2938
- * note: there is no analogue to this because by brand guidelines, the
2939
- * `Wistia` text must not be displayed without the "flags" iconography
2940
- */
2884
+ * Display just the icon portion of the logo (ie. hide `Wistia` text)
2885
+ * note: there is no analogue to this because by brand guidelines, the
2886
+ * `Wistia` text must not be displayed without the "flags" iconography
2887
+ */
2941
2888
  iconOnly?: boolean;
2942
2889
  /**
2943
- * If provided, will wrap the logo in a link
2944
- */
2890
+ * If provided, will wrap the logo in a link
2891
+ */
2945
2892
  href?: string;
2946
2893
  /**
2947
- * An accessible title for the logo (defaults to "Wistia Logo")
2948
- */
2894
+ * An accessible title for the logo (defaults to "Wistia Logo")
2895
+ */
2949
2896
  title?: string;
2950
2897
  /**
2951
- * Style of the logo
2952
- */
2898
+ * Style of the logo
2899
+ */
2953
2900
  variant?: "dark" | "light" | "standard";
2954
2901
  };
2955
2902
  declare const WistiaLogo: FC<WistiaLogoProps>;