@wistia/ui 0.8.27 → 0.8.28-beta.a699b2af.d8fac3a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -209,9 +209,13 @@ type BaseProps$2 = {
209
209
  */
210
210
  type?: LinkTypes | undefined;
211
211
  /**
212
- * Whether the link should be underlined
212
+ * Controls the underline behavior of the link
213
+ *
214
+ * * `none` - no underline (default)
215
+ * * `always` - always show underline
216
+ * * `hover` - show underline only on hover
213
217
  */
214
- underline?: boolean;
218
+ underline?: 'always' | 'hover' | 'none';
215
219
  };
216
220
  type LinkAsLinkProps = BaseProps$2 & ComponentPropsWithRef<'a'> & Omit<LinkProps$1, 'to'> & {
217
221
  href: string | undefined;
@@ -337,7 +341,7 @@ declare const Button: react.ForwardRefExoticComponent<(Omit<BaseButtonProps & Om
337
341
  leftIcon?: JSX.Element | undefined;
338
342
  rightIcon?: JSX.Element | undefined;
339
343
  type?: LinkTypes | undefined;
340
- underline?: boolean;
344
+ underline?: "always" | "hover" | "none";
341
345
  } & Omit<react_router.LinkProps, "to"> & {
342
346
  href: string | undefined;
343
347
  type?: LinkTypes;
@@ -364,7 +368,7 @@ declare const Button: react.ForwardRefExoticComponent<(Omit<BaseButtonProps & Om
364
368
  leftIcon?: JSX.Element | undefined;
365
369
  rightIcon?: JSX.Element | undefined;
366
370
  type?: LinkTypes | undefined;
367
- underline?: boolean;
371
+ underline?: "always" | "hover" | "none";
368
372
  } & Omit<react.DetailedHTMLProps<react.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
369
373
  ref?: ((instance: HTMLButtonElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLButtonElement> | null | undefined;
370
374
  } & {
@@ -709,11 +713,6 @@ type BoxProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT$1> & {
709
713
  * *Note: only works for nested `<Box />`*
710
714
  */
711
715
  grow?: number | string;
712
- /**
713
- * @ignore
714
- * Used internally to track if a Box is a child of another Box component
715
- */
716
- hasBoxParent?: boolean;
717
716
  /**
718
717
  * Specifies the height of the box.
719
718
  *
@@ -2067,7 +2066,7 @@ declare const MenuItem: react.ForwardRefExoticComponent<(Omit<DropdownMenuItemPr
2067
2066
  leftIcon?: react.JSX.Element | undefined;
2068
2067
  rightIcon?: react.JSX.Element | undefined;
2069
2068
  type?: LinkTypes | undefined;
2070
- underline?: boolean;
2069
+ underline?: "always" | "hover" | "none";
2071
2070
  } & Omit<react_router.LinkProps, "to"> & {
2072
2071
  href: string | undefined;
2073
2072
  type?: LinkTypes;
@@ -2104,7 +2103,7 @@ declare const MenuItem: react.ForwardRefExoticComponent<(Omit<DropdownMenuItemPr
2104
2103
  leftIcon?: react.JSX.Element | undefined;
2105
2104
  rightIcon?: react.JSX.Element | undefined;
2106
2105
  type?: LinkTypes | undefined;
2107
- underline?: boolean;
2106
+ underline?: "always" | "hover" | "none";
2108
2107
  } & Omit<react.DetailedHTMLProps<react.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
2109
2108
  ref?: ((instance: HTMLButtonElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLButtonElement> | null | undefined;
2110
2109
  } & {
@@ -3275,4 +3274,26 @@ declare const WistiaLogo: {
3275
3274
  displayName: string;
3276
3275
  };
3277
3276
 
3278
- export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, 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, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, DataCard, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, Divider, EditableHeading, type EditableHeadingProps, Ellipsis, type EllipsisProps, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Stack, SubMenu, Switch, type SwitchProps, Tab, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UseToastProps, WistiaLogo, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useFocusTrap, useForceUpdate, useFormState, useIsHovered, useKey, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize };
3277
+ type VariantType = 'breadcrumbs' | 'bullets' | 'commas' | 'ordered' | 'slashes' | 'spaces' | 'unbulleted';
3278
+ type ItemType = ItemType[] | string[] | string;
3279
+ type ListProps = ComponentPropsWithoutRef<'ul'> & {
3280
+ /**
3281
+ * Children should be wrapped in `<ListItem>`
3282
+ */
3283
+ children?: ReactNode;
3284
+ /**
3285
+ * As an alternative to passing children you can supply an array of strings that
3286
+ * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
3287
+ */
3288
+ items?: ItemType[];
3289
+ /**
3290
+ * The kind of list to render
3291
+ */
3292
+ variant?: VariantType;
3293
+ };
3294
+ declare const List: {
3295
+ ({ children, items, variant, ...otherProps }: ListProps): JSX.Element | null;
3296
+ displayName: string;
3297
+ };
3298
+
3299
+ export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, 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, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, DataCard, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, Divider, EditableHeading, type EditableHeadingProps, Ellipsis, type EllipsisProps, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, List, type ListProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Stack, SubMenu, Switch, type SwitchProps, Tab, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UseToastProps, WistiaLogo, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useFocusTrap, useForceUpdate, useFormState, useIsHovered, useKey, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize };
package/dist/index.d.ts CHANGED
@@ -209,9 +209,13 @@ type BaseProps$2 = {
209
209
  */
210
210
  type?: LinkTypes | undefined;
211
211
  /**
212
- * Whether the link should be underlined
212
+ * Controls the underline behavior of the link
213
+ *
214
+ * * `none` - no underline (default)
215
+ * * `always` - always show underline
216
+ * * `hover` - show underline only on hover
213
217
  */
214
- underline?: boolean;
218
+ underline?: 'always' | 'hover' | 'none';
215
219
  };
216
220
  type LinkAsLinkProps = BaseProps$2 & ComponentPropsWithRef<'a'> & Omit<LinkProps$1, 'to'> & {
217
221
  href: string | undefined;
@@ -337,7 +341,7 @@ declare const Button: react.ForwardRefExoticComponent<(Omit<BaseButtonProps & Om
337
341
  leftIcon?: JSX.Element | undefined;
338
342
  rightIcon?: JSX.Element | undefined;
339
343
  type?: LinkTypes | undefined;
340
- underline?: boolean;
344
+ underline?: "always" | "hover" | "none";
341
345
  } & Omit<react_router.LinkProps, "to"> & {
342
346
  href: string | undefined;
343
347
  type?: LinkTypes;
@@ -364,7 +368,7 @@ declare const Button: react.ForwardRefExoticComponent<(Omit<BaseButtonProps & Om
364
368
  leftIcon?: JSX.Element | undefined;
365
369
  rightIcon?: JSX.Element | undefined;
366
370
  type?: LinkTypes | undefined;
367
- underline?: boolean;
371
+ underline?: "always" | "hover" | "none";
368
372
  } & Omit<react.DetailedHTMLProps<react.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
369
373
  ref?: ((instance: HTMLButtonElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLButtonElement> | null | undefined;
370
374
  } & {
@@ -709,11 +713,6 @@ type BoxProps = ComponentPropsWithoutRef<typeof DEFAULT_ELEMENT$1> & {
709
713
  * *Note: only works for nested `<Box />`*
710
714
  */
711
715
  grow?: number | string;
712
- /**
713
- * @ignore
714
- * Used internally to track if a Box is a child of another Box component
715
- */
716
- hasBoxParent?: boolean;
717
716
  /**
718
717
  * Specifies the height of the box.
719
718
  *
@@ -2067,7 +2066,7 @@ declare const MenuItem: react.ForwardRefExoticComponent<(Omit<DropdownMenuItemPr
2067
2066
  leftIcon?: react.JSX.Element | undefined;
2068
2067
  rightIcon?: react.JSX.Element | undefined;
2069
2068
  type?: LinkTypes | undefined;
2070
- underline?: boolean;
2069
+ underline?: "always" | "hover" | "none";
2071
2070
  } & Omit<react_router.LinkProps, "to"> & {
2072
2071
  href: string | undefined;
2073
2072
  type?: LinkTypes;
@@ -2104,7 +2103,7 @@ declare const MenuItem: react.ForwardRefExoticComponent<(Omit<DropdownMenuItemPr
2104
2103
  leftIcon?: react.JSX.Element | undefined;
2105
2104
  rightIcon?: react.JSX.Element | undefined;
2106
2105
  type?: LinkTypes | undefined;
2107
- underline?: boolean;
2106
+ underline?: "always" | "hover" | "none";
2108
2107
  } & Omit<react.DetailedHTMLProps<react.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
2109
2108
  ref?: ((instance: HTMLButtonElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLButtonElement> | null | undefined;
2110
2109
  } & {
@@ -3275,4 +3274,26 @@ declare const WistiaLogo: {
3275
3274
  displayName: string;
3276
3275
  };
3277
3276
 
3278
- export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, 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, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, DataCard, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, Divider, EditableHeading, type EditableHeadingProps, Ellipsis, type EllipsisProps, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Stack, SubMenu, Switch, type SwitchProps, Tab, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UseToastProps, WistiaLogo, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useFocusTrap, useForceUpdate, useFormState, useIsHovered, useKey, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize };
3277
+ type VariantType = 'breadcrumbs' | 'bullets' | 'commas' | 'ordered' | 'slashes' | 'spaces' | 'unbulleted';
3278
+ type ItemType = ItemType[] | string[] | string;
3279
+ type ListProps = ComponentPropsWithoutRef<'ul'> & {
3280
+ /**
3281
+ * Children should be wrapped in `<ListItem>`
3282
+ */
3283
+ children?: ReactNode;
3284
+ /**
3285
+ * As an alternative to passing children you can supply an array of strings that
3286
+ * will be rendered as child `<ListItems>`s. Note that all items will be of the same variant.
3287
+ */
3288
+ items?: ItemType[];
3289
+ /**
3290
+ * The kind of list to render
3291
+ */
3292
+ variant?: VariantType;
3293
+ };
3294
+ declare const List: {
3295
+ ({ children, items, variant, ...otherProps }: ListProps): JSX.Element | null;
3296
+ displayName: string;
3297
+ };
3298
+
3299
+ export { ActionButton, type ActionButtonProps, Avatar, type AvatarProps, type AvatarStatus, Badge, type BadgeProps, 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, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, DataCard, type DataCardProps, DataCardTrend, type DataCardTrendProps, DataCards, type DataCardsProps, Divider, EditableHeading, type EditableHeadingProps, Ellipsis, type EllipsisProps, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Image, type ImageProps, Input, InputClickToCopy, type InputClickToCopyProps, type InputProps, type KeyboardKeys, KeyboardShortcut, Label, type LabelProps, Link, type LinkProps, List, type ListProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Popover, type PopoverProps, ProgressBar, type ProgressBarProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, SegmentedControl, SegmentedControlItem, type SegmentedControlItemProps, type SegmentedControlProps, Select, SelectOption, SelectOptionGroup, type SelectOptionGroupProps, type SelectOptionProps, type SelectProps, Stack, SubMenu, Switch, type SwitchProps, Tab, type TabProps, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableFoot, type TableFootProps, TableHead, type TableHeadProps, type TableProps, TableRow, type TableRowProps, Tabs, type TabsProps, Tag, type TagProps, Text, type TextProps, Thumbnail, ThumbnailBadge, type ThumbnailBadgeProps, ThumbnailCollage, type ThumbnailCollageProps, type ThumbnailProps, Tooltip, type TooltipProps, UIProvider, type UseToastProps, WistiaLogo, colorSchemeOptions, copyToClipboard, dateTime, iconSizeMap, mergeRefs, mq, useActiveMq, useAriaLive, useBoolean, useClipboard, useFocusTrap, useForceUpdate, useFormState, useIsHovered, useKey, useLocalStorage, useLockBodyScroll, useMq, useOnClickOutside, usePreviousValue, useToast, useWindowSize };