@wistia/ui 0.20.22 → 0.21.0-beta.301c9582.86213f8

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { ReactNode, LegacyRef, MutableRefObject, RefCallback, Dispatch, SetStateAction, RefObject, ComponentPropsWithoutRef, JSX, ComponentPropsWithRef, AnchorHTMLAttributes, MouseEvent, ReactElement, ElementType, ChangeEvent, PropsWithChildren, InputHTMLAttributes, Ref, SyntheticEvent, ComponentProps, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, TdHTMLAttributes, ThHTMLAttributes } from 'react';
+import { ComponentType, AnchorHTMLAttributes, ReactNode, LegacyRef, MutableRefObject, RefCallback, Dispatch, SetStateAction, RefObject, ComponentPropsWithoutRef, JSX, ComponentPropsWithRef, MouseEvent, ReactElement, ElementType, ChangeEvent, PropsWithChildren, InputHTMLAttributes, Ref, SyntheticEvent, ComponentProps, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, TdHTMLAttributes, ThHTMLAttributes } from 'react';
 import { UseFilePickerConfig, FilePickerReturnTypes, ExtractContentTypeFromConfig, useImperativeFilePickerConfig, ImperativeFilePickerReturnTypes } from 'use-file-picker/types';
 export * from 'use-file-picker/types';
 import { CollapsibleContentProps as CollapsibleContentProps$1 } from '@radix-ui/react-collapsible';
@@ -15,10 +15,24 @@ import { ToggleGroupSingleProps } from '@radix-ui/react-toggle-group';
 import { TabsProps as TabsProps$1, TabsContentProps as TabsContentProps$1, TabsListProps as TabsListProps$1, TabsTriggerProps as TabsTriggerProps$1 } from '@radix-ui/react-tabs';
 export { FileAmountLimitValidator, FileSizeValidator, FileTypeValidator, ImageDimensionsValidator, PersistentFileAmountLimitValidator } from 'use-file-picker/validators';
 
+type RouterLinkProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & {
+    reloadDocument?: boolean;
+    replace?: boolean;
+    state?: unknown;
+    preventScrollReset?: boolean;
+    viewTransition?: boolean;
+    to: string;
+};
+type RouterAdapter = {
+    Link: ComponentType<RouterLinkProps>;
+    useInRouterContext: () => boolean;
+};
+
 type UIProviderProps = {
     children: ReactNode;
+    router?: RouterAdapter;
 };
-declare const UIProvider: ({ children }: UIProviderProps) => react_jsx_runtime.JSX.Element;
+declare const UIProvider: ({ children, router }: UIProviderProps) => react_jsx_runtime.JSX.Element;
 
 /**
  * Converts a boolean string value `value` into a boolean. If passed
@@ -216,10 +230,10 @@ declare const ColorSchemeWrapper: {
 type ButtonVariants = 'ghost' | 'outline' | 'soft' | 'solid';
 
 type LinkTypes = 'default' | 'email' | 'external' | 'phone';
-type ReactRouterLinkProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & {
+type RouterSpecificProps = {
     reloadDocument?: boolean;
     replace?: boolean;
-    state?: any;
+    state?: unknown;
     preventScrollReset?: boolean;
     viewTransition?: boolean;
 };
@@ -272,7 +286,7 @@ type BaseProps$2 = {
      */
     underline?: 'always' | 'hover' | 'none';
 };
-type LinkAsLinkProps = BaseProps$2 & ComponentPropsWithRef<'a'> & ReactRouterLinkProps & {
+type LinkAsLinkProps = BaseProps$2 & ComponentPropsWithRef<'a'> & RouterSpecificProps & {
     href: string | undefined;
     type?: LinkTypes;
 };
@@ -283,11 +297,12 @@ type LinkAsButtonProps = BaseProps$2 & ComponentPropsWithRef<'button'> & {
 type LinkProps = LinkAsButtonProps | LinkAsLinkProps;
 /**
  * Links are used for navigation. If no `href` is supplied, a button that is visually styled to appear as a link
- * is rendered. If used in a `react-router` context, their [Link](https://reactrouter.com/en/main/components/link).
- * component is used, otherwise a native `a` element.
+ * is rendered. If a router adapter is provided via `UIProvider`, the adapter's `Link` component is used for
+ * client-side navigation, otherwise a native `a` element is rendered.
  *
- * This means in addition to its own props, `Link` can use props from `react-router`'s `Link` component. View their documentation [here](https://reactrouter.com/en/main/components/link).
- * The one prop we ignore from react-router is `to`. We use `href` instead and map it under the hood.
+ * To enable client-side routing, pass a `router` prop to `UIProvider` with a `Link` component and
+ * `useInRouterContext` hook from your router library. The `href` prop is mapped to the router's `to` prop
+ * under the hood.
  */
 declare const Link: react.ForwardRefExoticComponent<(Omit<LinkAsLinkProps, "ref"> | Omit<LinkAsButtonProps, "ref">) & react.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
 
@@ -396,10 +411,10 @@ declare const Button: react.ForwardRefExoticComponent<(Omit<BaseButtonProps & re
     rightIcon?: ReactNode | undefined;
     type?: LinkTypes | undefined;
     underline?: "always" | "hover" | "none";
-} & Omit<react.AnchorHTMLAttributes<HTMLAnchorElement>, "href"> & {
+} & {
     reloadDocument?: boolean;
     replace?: boolean;
-    state?: any;
+    state?: unknown;
     preventScrollReset?: boolean;
     viewTransition?: boolean;
 } & {
@@ -664,19 +679,7 @@ type BannerProps = ComponentPropsWithoutRef<'div'> & {
      * Optional `Icon` component to use. Must be an instance of [Icon](../?path=/docs/components-icon--docs)
      */
     icon?: JSX.Element;
-    /**
-     * Controls the visual prominence of the banner
-     */
-    prominence?: 'primary' | 'secondary';
     colorScheme?: ColorSchemeTypes;
-    /**
-     * Optional image element to display in the banner
-     */
-    image?: JSX.Element | undefined;
-    /**
-     * Controls the layout direction. If set to 'auto', the banner will switch between horizontal and vertical based on the container width.
-     */
-    orientation?: 'auto' | 'horizontal' | 'vertical';
     /**
      * Primary call-to-action element (typically a [Button]() of the `solid` variant)
      */
@@ -694,26 +697,10 @@ type BannerProps = ComponentPropsWithoutRef<'div'> & {
  * The `Banner` component is for displaying contextual information to the user such as alerts or feature announcements.
  */
 declare const Banner: {
-    ({ bodyText, colorScheme, headingText, icon, image, onClose, orientation, primaryAction, prominence, secondaryAction, ...props }: BannerProps): JSX.Element;
+    ({ bodyText, colorScheme, headingText, icon, onClose, primaryAction, secondaryAction, ...props }: BannerProps): JSX.Element;
     displayName: string;
 };
 
-type BannerImageProps = ComponentPropsWithoutRef<'div'> & {
-    /**
-     * The URL of the image to display in the banner
-     */
-    src: string;
-    /**
-     * Alternative text description of the image for accessibility
-     */
-    alt?: string;
-    /**
-     * Position of the image within the banner layout. Only applies in horizontal orientation.
-     */
-    alignment?: 'left' | 'right';
-};
-declare const BannerImage: ({ alignment, alt, src, ...props }: BannerImageProps) => react_jsx_runtime.JSX.Element;
-
 type UnknownRecord = Record<string, unknown>;
 type PropsOf<Component extends ElementType> = ComponentPropsWithoutRef<Component>;
 type ExtendedProps<Props = UnknownRecord, OverrideProps = UnknownRecord> = Omit<Props, keyof OverrideProps> & OverrideProps;
@@ -3038,10 +3025,10 @@ declare const MenuItem: react.ForwardRefExoticComponent<(Omit<DropdownMenuItemPr
     rightIcon?: react.ReactNode | undefined;
     type?: LinkTypes | undefined;
     underline?: "always" | "hover" | "none";
-} & Omit<react.AnchorHTMLAttributes<HTMLAnchorElement>, "href"> & {
+} & {
     reloadDocument?: boolean;
     replace?: boolean;
-    state?: any;
+    state?: unknown;
     preventScrollReset?: boolean;
     viewTransition?: boolean;
 } & {
@@ -4595,4 +4582,4 @@ declare const WistiaLogo: {
     displayName: string;
 };
 
-export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, Banner, BannerImage, type BannerProps, Box, type BoxProps, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Center, type CenterProps, Checkbox, CheckboxGroup, CheckboxMenuItem, ClickRegion, type ClickRegionProps, Collapsible, CollapsibleContent, type CollapsibleProps, CollapsibleTrigger, CollapsibleTriggerIcon, ColorGrid, ColorGridOption, type ColorGridOptionProps, type ColorGridProps, ColorList, ColorListGroup, type ColorListGroupProps, ColorListOption, type ColorListOptionProps, type ColorListProps, ColorPicker, ColorPickerPopoverContent, type ColorPickerPopoverContentProps, type ColorPickerProps, ColorPickerSection, type ColorPickerSectionProps, ColorPickerTrigger, type ColorPickerTriggerProps, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Combobox, ComboboxOption, type ComboboxOptionProps, type ComboboxProps, ContextMenu, type ContextMenuProps, ContrastControls, CustomizableThemeWrapper, type CustomizableThemeWrapperProps, DataCard, DataCardHoverArrow, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, DataList, DataListItem, DataListItemLabel, DataListItemValue, type DataListProps, Divider, EditableHeading, type EditableHeadingProps, EditableText, EditableTextCancelButton, EditableTextContext, EditableTextDisplay, EditableTextInput, EditableTextLabel, type EditableTextProps, EditableTextRoot, type EditableTextRootProps, EditableTextSubmitButton, EditableTextTrigger, Ellipsis, type EllipsisProps, FeatureCard, FeatureCardImage, type FeatureCardProps, FilterMenu, FilterMenuItem, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Grid, type GridProps, Heading, type HeadingProps, HexColorInput, type HexColorInputProps, HueSlider, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, InputPassword, type InputPasswordProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, List, ListItem, type ListItemProps, type ListProps, Mark, type MarkProps, Markdown, type MarkdownProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Meter, type MeterProps, type MeterSegment, Modal, ModalCallout, ModalCallouts, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioCard, RadioCardImage, type RadioCardImageProps, type RadioCardProps, RadioGroup, RadioMenuItem, type RadioProps, SaturationAndValuePicker, ScreenReaderOnly, ScrollArea, type ScrollAreaProps, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Slider, type SliderProps, SplitButton, type SplitButtonProps, Stack, SubMenu, Switch, type SwitchProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, TabsContent, TabsList, TabsTrigger, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UseActiveMqReturnType, type UseIsHoveredReturnType, type UseMqReturnType, type UseToastProps, ValueNameOrHexCode, ValueSwatch, WistiaLogo, calculateContrast, coerceToBoolean, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useElementObserver, useFilePicker, useFocusTrap, useForceUpdate, useFormState, useImperativeFilePicker, useIsHovered, useKey, useKeyPress, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize, validateWithYup };
+export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, Banner, type BannerProps, Box, type BoxProps, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Center, type CenterProps, Checkbox, CheckboxGroup, CheckboxMenuItem, ClickRegion, type ClickRegionProps, Collapsible, CollapsibleContent, type CollapsibleProps, CollapsibleTrigger, CollapsibleTriggerIcon, ColorGrid, ColorGridOption, type ColorGridOptionProps, type ColorGridProps, ColorList, ColorListGroup, type ColorListGroupProps, ColorListOption, type ColorListOptionProps, type ColorListProps, ColorPicker, ColorPickerPopoverContent, type ColorPickerPopoverContentProps, type ColorPickerProps, ColorPickerSection, type ColorPickerSectionProps, ColorPickerTrigger, type ColorPickerTriggerProps, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Combobox, ComboboxOption, type ComboboxOptionProps, type ComboboxProps, ContextMenu, type ContextMenuProps, ContrastControls, CustomizableThemeWrapper, type CustomizableThemeWrapperProps, DataCard, DataCardHoverArrow, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, DataList, DataListItem, DataListItemLabel, DataListItemValue, type DataListProps, Divider, EditableHeading, type EditableHeadingProps, EditableText, EditableTextCancelButton, EditableTextContext, EditableTextDisplay, EditableTextInput, EditableTextLabel, type EditableTextProps, EditableTextRoot, type EditableTextRootProps, EditableTextSubmitButton, EditableTextTrigger, Ellipsis, type EllipsisProps, FeatureCard, FeatureCardImage, type FeatureCardProps, FilterMenu, FilterMenuItem, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Grid, type GridProps, Heading, type HeadingProps, HexColorInput, type HexColorInputProps, HueSlider, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, InputPassword, type InputPasswordProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, List, ListItem, type ListItemProps, type ListProps, Mark, type MarkProps, Markdown, type MarkdownProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Meter, type MeterProps, type MeterSegment, Modal, ModalCallout, ModalCallouts, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioCard, RadioCardImage, type RadioCardImageProps, type RadioCardProps, RadioGroup, RadioMenuItem, type RadioProps, type RouterAdapter, type RouterLinkProps, SaturationAndValuePicker, ScreenReaderOnly, ScrollArea, type ScrollAreaProps, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Slider, type SliderProps, SplitButton, type SplitButtonProps, Stack, SubMenu, Switch, type SwitchProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, TabsContent, TabsList, TabsTrigger, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UIProviderProps, type UseActiveMqReturnType, type UseIsHoveredReturnType, type UseMqReturnType, type UseToastProps, ValueNameOrHexCode, ValueSwatch, WistiaLogo, calculateContrast, coerceToBoolean, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useElementObserver, useFilePicker, useFocusTrap, useForceUpdate, useFormState, useImperativeFilePicker, useIsHovered, useKey, useKeyPress, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize, validateWithYup };