@yahoo/uds 3.132.2 → 3.133.0-beta.2

package/dist/types/{dist → src}/index.d.ts

@@ -2,8 +2,7 @@
 import { ElementType, HTMLAttributes, PropsWithChildren, ReactElement, ReactNode, Ref } from "react";
 import { IntRange } from "type-fest";
 
-//#region ../types/dist/index.d.ts
-//#region src/index.d.ts
+//#region ../types/src/index.d.ts
 /**
  * Icon pixel sizes
  */
@@ -17,11 +16,24 @@ type IconSize = 'xs' | 'sm' | 'md' | 'lg';
  */
 type IconVariant = 'fill' | 'outline' | 'multicolor';
 /**
- * Generic icon component type. Platforms should provide their own concrete type.
- * - Web: SvgIcon from @yahoo/uds-icons
- * - Mobile: Component from @yahoo/uds-icons/svgMap
+ * Generic icon definition type. Platforms should provide their own concrete type.
+ * - Web: IconDefinition from @yahoo/uds-icons
+ * - Mobile: glyph/icon element type provided by the renderer
  */
-type GenericIconComponent = React.ComponentType<any>;
+type GenericIconMetadata = {
+  name: string;
+  isSvgIcon: true;
+  variants: IconVariant[];
+};
+type GenericIconMarkupMap = Partial<Record<IconVariant, Partial<Record<IconSize, string>>>>;
+type GenericIconDefinition = {
+  __iconDefinition: true;
+  metadata: GenericIconMetadata;
+  svg: GenericIconMarkupMap;
+};
+/** @deprecated Use GenericIconDefinition instead. */
+type GenericIconComponent = GenericIconDefinition;
+type IconSlotValue<Icon = GenericIconDefinition> = Icon;
 /** Ensure an array has a max length of N */
 type MaxLengthArray<T, N extends number, A extends T[] = []> = A['length'] extends N ? A : T[] extends A ? T[] : A | MaxLengthArray<T, N, [...A, T]>;
 type ExtractUrlFromFontFaceRule<T extends string> = T extends `url('${infer U}') format('woff2')` ? U : never;
@@ -473,9 +485,9 @@ interface UniversalTextProps extends PropsWithChildren, TextStyleProps, Universa
 }
 /**
  * Universal icon props with generic icon type.
- * @template Icon - The icon component type. Defaults to GenericIconComponent.
+ * @template Icon - The icon definition type. Defaults to GenericIconDefinition.
  */
-interface UniversalIconProps<Icon = GenericIconComponent> {
+interface UniversalIconProps<Icon = GenericIconDefinition> {
   /** The icon component to render. */
   name: Icon;
   /** Icon size. @default 'md' */
@@ -491,14 +503,14 @@ type IconSlotRenderProps = Omit<IconPropsWithSVGProps, 'name'>;
 type BackwardsCompatibleReactElement = null | undefined | ReactElement;
 /**
  * Universal icon slot type with generic icon type.
- * @template Icon - The icon component type.
+ * @template Icon - The icon definition type.
  */
-type UniversalIconSlot<Icon = GenericIconComponent> = Icon | BackwardsCompatibleReactElement | ((iconProps: IconSlotRenderProps) => BackwardsCompatibleReactElement);
+type UniversalIconSlot<Icon = GenericIconDefinition> = IconSlotValue<Icon> | BackwardsCompatibleReactElement | ((iconProps: IconSlotRenderProps) => BackwardsCompatibleReactElement);
 interface UniversalPressableProps extends Omit<UniversalBoxProps, 'as'> {
   /** Callback fired when the element is pressed. */
   onPress?: () => void;
 }
-interface UniversalIconButtonProps<Icon = GenericIconComponent> {
+interface UniversalIconButtonProps<Icon = GenericIconDefinition> {
   /** The visual style variant of the button. */
   variant?: ButtonVariantFlat;
   /** The size of the button. */
@@ -824,7 +836,7 @@ interface UniversalMenuItemProps<IconSlotType = UniversalIconSlot> extends Omit<
 type ToastSize = 'default';
 type ToastVariant = 'info' | 'success' | 'warning' | 'error' | 'loading';
 type ToastPosition = 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'top-center' | 'bottom-center';
-interface UniversalToastProps {
+interface UniversalToastProps<IconSlotType = UniversalIconSlot> {
   /**
    * The size of the toast.
    */
@@ -848,11 +860,11 @@ interface UniversalToastProps {
   /**
    * Optional icon displayed at the start of the toast.
    */
-  startIcon?: UniversalIconSlot | false;
+  startIcon?: IconSlotType | false;
   /**
    * Optional icon displayed at the start of the toast.
    */
-  closeIcon?: UniversalIconSlot | false;
+  closeIcon?: IconSlotType | false;
   /**
    * Callback function to be called when the close button is clicked.
    */
@@ -886,13 +898,13 @@ interface UniversalTooltipTriggerProps {
   /** The content to display inside the tooltip trigger. This is what the tooltip will be anchored to. */
   children: ReactNode;
 }
-interface UniversalTooltipContentProps {
+interface UniversalTooltipContentProps<IconSlotType = UniversalIconSlot> {
   /** The body content of the tooltip. */
   children: ReactNode;
   /** The maximum width of the tooltip content. Accepts a number in pixels or a string in CSS units. */
   maxWidth?: string | number;
   /** An icon displayed at the start of the tooltip title. */
-  startTitleIcon?: UniversalIconSlot;
+  startTitleIcon?: IconSlotType;
   /** An optional title rendered above the body content. */
   title?: ReactNode;
   /** Additional content rendered at the end of the tooltip (e.g. a keyboard shortcut). */
@@ -936,15 +948,15 @@ interface UniversalTabPanelProps {
   /** Optional class name for custom styling. */
   className?: string;
 }
-interface UniversalTabProps {
+interface UniversalTabProps<IconSlotType = UniversalIconSlot> {
   /** Unique identifier for this tab, used to connect with a TabPanel. When omitted, one is auto-generated. */
   value?: string;
   /** Tab content, typically a text label. */
   children: ReactNode;
   /** Icon rendered before the label. */
-  startIcon?: UniversalIconSlot;
+  startIcon?: IconSlotType;
   /** Icon rendered after the label. */
-  endIcon?: UniversalIconSlot;
+  endIcon?: IconSlotType;
   /** Disables the tab. */
   disabled?: boolean;
   /** Merge props onto the immediate child element instead of rendering a wrapper. */
@@ -1066,13 +1078,13 @@ interface UniversalPopoverTriggerProps {
   /** The content to display inside the popover trigger. This is what the popover will be anchored to. */
   children: ReactNode;
 }
-interface UniversalPopoverContentProps {
+interface UniversalPopoverContentProps<IconSlotType = UniversalIconSlot> {
   /** The content of the popover. */
   children: ReactNode;
   /** Custom CSS classes applied to the popover content container. */
   className?: string;
   /** Optional icon displayed at the end of the popover content. */
-  closeIcon?: UniversalIconSlot;
+  closeIcon?: IconSlotType;
   /** The maximum width of the popover content. Accepts a number in pixels or a string in CSS units. Keywords like 'none', 'auto', 'max-content', 'min-content', 'fit-content', 'inherit', 'initial', 'unset', 'revert', 'revert-layer' are not allowed. */
   maxWidth?: string | number;
   /** The maximum height of the popover content. Accepts a number in pixels or a string in CSS units. Keywords like 'none', 'auto', 'max-content', 'min-content', 'fit-content', 'inherit', 'initial', 'unset', 'revert', 'revert-layer' are not allowed. */
@@ -1122,6 +1134,6 @@ type UniversalTokensConfigGeneric<ConfigAuto = UniversalTokensConfigAutoBase> =
 type GlobalDefaultsConfig = {
   breakpoint: Breakpoint | 'base';
   enableResponsiveType: boolean;
-}; //#endregion
+};
 //#endregion
-export { type AlwaysPaletteAlias, type AlwaysPaletteAliasWithPrefix, type AlwaysPaletteColor, type Animation, type AriaAttribute, type AvatarAbbreviationStrategy, type AvatarShape, type AvatarSize, type AvatarSizeConfig, type AvatarVariant, type BackgroundColor, type BackgroundPalette, type BackgroundPaletteAlias, type BackgroundStyleProps, type BackwardsCompatibleReactElement, type BadgeSize, type BadgeVariant, type BannerInnerShadowOption, type BannerSize, type BannerVariant, type BorderRadius, type BorderRadiusConfig, type BorderStyleProps, type BorderWidth, type BorderWidthConfig, type BorderWidthWithElevation, type BottomSheetHeight, type BottomSheetSnapPoints, type BottomSheetVariant, type Breakpoint, type BreakpointValue, type BreakpointWithBase, type BreakpointsConfig, type ButtonPalette, type ButtonPaletteColor, type ButtonSize, type ButtonSpectrumColor, type ButtonVariant, type ButtonVariantFlat, type CheckboxSize, type CheckboxValue, type CheckboxVariant, type ChipSize, type ChipVariant, type ColorMode, type ColorModeConfig, type ColorModeForApp, type ColorsConfig, type ConfigurableComponentName, type CustomSizingStyleProps, type DataAttribute, type DeprecatedAlwaysPaletteAlias, type Display, type DividerVariant, type ElevationAlias, type ElevationBackgroundFillColor, type ElevationBorderColor, type ElevationConfig, type ElevationCustomShadows, type ElevationGlobalRampConfig, type ElevationGlobalRampSettings, type ElevationLevel, type ElevationPreset, type ElevationSurfaceColor, type ExtractUrlFromFontFaceRule, type Flex, type FlexAlignContent, type FlexAlignItems, type FlexAlignSelf, type FlexBasis, type FlexDirection, type FlexGrow, type FlexJustifyContent, type FlexShrink, type FlexStyleProps, type FlexWrap, type FocusRingColor, type FocusRingConfig, type FocusRingModeConfig, type FocusRingOffset, type FocusRingWidth, type FontAlias, type FontConfig, type FontCssVar, type FontFamilyConfig, type FontSize, type FontSizeConfig, type FontSlantConfig, type FontType, type FontWeightConfig, type FontWeightDescriptive, type FontWeightNumeric, type FontWidthConfig, type ForegroundColor, type ForegroundPalette, type ForegroundPaletteAlias, type GenericIconComponent, type GlobalDefaultsConfig, type HighContrastMode, type Hue, type HueStep, type IconButtonSize, type IconPixelSize, type IconPropsWithSVGProps, type IconSize, type IconSizeConfig, type IconSlotRenderProps, type IconVariant, type ImagePropsWithImgProps, type ImageStyleProps, type ImgElementProps, type InputSize, type LayoutStyleProps, type LineClampAlias, type LineColor, type LineHeight, type LineHeightConfig, type LinePalette, type LinePaletteAlias, type LinkTextVariant, type LinkVariant, type LinkableValue, type MaxLengthArray, type Modes, type MotionConfig, type MotionCssVar, type MotionSpringConfig, type MotionSpringConfigOptions, type MotionVariant, type MotionVariantSpeed, type MotionVariantValues, type NestedBorderRadiusStyleProps, type OpacityStep, type Overflow, type Palette, type PaletteConfig, type PaletteType, type PaletteValue, type Percentage, type PercentageUnit, type PixelsUnit, type PlatformMode, type PopoverPlacement, type PopoverSize, type PopoverVariant, type Position, type PropertyToPaletteAliasMap, type RGBAUnit, type RGBColorValue, type RGBUnit, type RadioSize, type RadioValue, type RadioVariant, type RegionMode, type RemsUnit, type SVGElementProps, type ScaleConfig, type ScaleEffect, type ScaleMode, type ScaleModeConfig, type ScaleModeForApp, type ShadowAlwaysColor, type ShadowColor, type ShadowColorConfig, type ShadowConfig, type ShadowOffset, type ShadowOpacity, type ShadowPalette, type ShadowPaletteAlias, type ShadowPaletteColor, type ShadowPreset, type ShadowSpectrumColor, type ShadowSpreadRadius, type ShadowStyleProps, type ShadowType, type ShadowTypeConfig, type ShadowVariant, type ShadowVariantConfig, type ShadowVariantInvert, type ShadowVariantWithElevation, type ShadowVariantWithInvert, type SharedPaletteAlias, type SizeStyleProps, type SpacingAlias, type SpacingConfig, type SpacingStyleProps, type SpectrumColor, type SpectrumConfig, type SpectrumRGB, type SpectrumValue, type SpectrumValueEntry, type StateStyleProps, type StyleProps, type SwitchSize, type TShirtSize, type TShirtSizeCommon, type TextDecorationLine, type TextProperty, type TextStyleProps, type TextTransform, type TextTransformConfig, type TextVariant, type TextVariantTypography, type TextVariantUi, type TextVariantWithoutEmphasized, type ToastPosition, type ToastSize, type ToastVariant, type TooltipPlacement, type TooltipSize, type TooltipVariant, type TransitionDelay, type TransitionDuration, type TransitionTiming, type TypographyConfig, type TypographyResponsiveProperty, type TypographyStyle, type TypographyStyleProperty, type TypographyUnitValue, type UdsCssVar, type UnitlessUnit, type UniversalAvatarBaseProps, type UniversalAvatarIconProps, type UniversalAvatarImageProps, type UniversalAvatarProps, type UniversalAvatarTextProps, type UniversalBadgeProps, type UniversalBannerProps, type UniversalBottomSheetContentProps, type UniversalBottomSheetHeaderProps, type UniversalBottomSheetProps, type UniversalBoxProps, type UniversalButtonProps, type UniversalCheckboxProps, type UniversalChipBaseProps, type UniversalChipButtonProps, type UniversalChipDismissibleProps, type UniversalChipLinkProps, type UniversalChipProps, type UniversalChipToggleProps, type UniversalDividerProps, type UniversalFormLabelProps, type UniversalIconButtonProps, type UniversalIconProps, type UniversalIconSlot, type UniversalImageProps, type UniversalInputProps, type UniversalLinkProps, type UniversalMenuItemProps, type UniversalPopoverContentProps, type UniversalPopoverProps, type UniversalPopoverTriggerProps, type UniversalPressableProps, type UniversalRadioGroupProps, type UniversalRadioProps, type UniversalStackProps, type UniversalSwitchProps, type UniversalTabListProps, type UniversalTabPanelProps, type UniversalTabProps, type UniversalTabsProps, type UniversalTabsVariant, type UniversalTextProps, type UniversalToastProps, type UniversalTokensConfigAutoBase, type UniversalTokensConfigBase, type UniversalTokensConfigGeneric, type UniversalTooltipContentProps, type UniversalTooltipProps, type UniversalTooltipTriggerProps };
+export { type AlwaysPaletteAlias, type AlwaysPaletteAliasWithPrefix, type AlwaysPaletteColor, type Animation, type AriaAttribute, type AvatarAbbreviationStrategy, type AvatarShape, type AvatarSize, type AvatarSizeConfig, type AvatarVariant, type BackgroundColor, type BackgroundPalette, type BackgroundPaletteAlias, type BackgroundStyleProps, type BackwardsCompatibleReactElement, type BadgeSize, type BadgeVariant, type BannerInnerShadowOption, type BannerSize, type BannerVariant, type BorderRadius, type BorderRadiusConfig, type BorderStyleProps, type BorderWidth, type BorderWidthConfig, type BorderWidthWithElevation, type BottomSheetHeight, type BottomSheetSnapPoints, type BottomSheetVariant, type Breakpoint, type BreakpointValue, type BreakpointWithBase, type BreakpointsConfig, type ButtonPalette, type ButtonPaletteColor, type ButtonSize, type ButtonSpectrumColor, type ButtonVariant, type ButtonVariantFlat, type CheckboxSize, type CheckboxValue, type CheckboxVariant, type ChipSize, type ChipVariant, type ColorMode, type ColorModeConfig, type ColorModeForApp, type ColorsConfig, type ConfigurableComponentName, type CustomSizingStyleProps, type DataAttribute, type DeprecatedAlwaysPaletteAlias, type Display, type DividerVariant, type ElevationAlias, type ElevationBackgroundFillColor, type ElevationBorderColor, type ElevationConfig, type ElevationCustomShadows, type ElevationGlobalRampConfig, type ElevationGlobalRampSettings, type ElevationLevel, type ElevationPreset, type ElevationSurfaceColor, type ExtractUrlFromFontFaceRule, type Flex, type FlexAlignContent, type FlexAlignItems, type FlexAlignSelf, type FlexBasis, type FlexDirection, type FlexGrow, type FlexJustifyContent, type FlexShrink, type FlexStyleProps, type FlexWrap, type FocusRingColor, type FocusRingConfig, type FocusRingModeConfig, type FocusRingOffset, type FocusRingWidth, type FontAlias, type FontConfig, type FontCssVar, type FontFamilyConfig, type FontSize, type FontSizeConfig, type FontSlantConfig, type FontType, type FontWeightConfig, type FontWeightDescriptive, type FontWeightNumeric, type FontWidthConfig, type ForegroundColor, type ForegroundPalette, type ForegroundPaletteAlias, type GenericIconComponent, type GenericIconDefinition, type GlobalDefaultsConfig, type HighContrastMode, type Hue, type HueStep, type IconButtonSize, type IconPixelSize, type IconPropsWithSVGProps, type IconSize, type IconSizeConfig, type IconSlotRenderProps, type IconVariant, type ImagePropsWithImgProps, type ImageStyleProps, type ImgElementProps, type InputSize, type LayoutStyleProps, type LineClampAlias, type LineColor, type LineHeight, type LineHeightConfig, type LinePalette, type LinePaletteAlias, type LinkTextVariant, type LinkVariant, type LinkableValue, type MaxLengthArray, type Modes, type MotionConfig, type MotionCssVar, type MotionSpringConfig, type MotionSpringConfigOptions, type MotionVariant, type MotionVariantSpeed, type MotionVariantValues, type NestedBorderRadiusStyleProps, type OpacityStep, type Overflow, type Palette, type PaletteConfig, type PaletteType, type PaletteValue, type Percentage, type PercentageUnit, type PixelsUnit, type PlatformMode, type PopoverPlacement, type PopoverSize, type PopoverVariant, type Position, type PropertyToPaletteAliasMap, type RGBAUnit, type RGBColorValue, type RGBUnit, type RadioSize, type RadioValue, type RadioVariant, type RegionMode, type RemsUnit, type SVGElementProps, type ScaleConfig, type ScaleEffect, type ScaleMode, type ScaleModeConfig, type ScaleModeForApp, type ShadowAlwaysColor, type ShadowColor, type ShadowColorConfig, type ShadowConfig, type ShadowOffset, type ShadowOpacity, type ShadowPalette, type ShadowPaletteAlias, type ShadowPaletteColor, type ShadowPreset, type ShadowSpectrumColor, type ShadowSpreadRadius, type ShadowStyleProps, type ShadowType, type ShadowTypeConfig, type ShadowVariant, type ShadowVariantConfig, type ShadowVariantInvert, type ShadowVariantWithElevation, type ShadowVariantWithInvert, type SharedPaletteAlias, type SizeStyleProps, type SpacingAlias, type SpacingConfig, type SpacingStyleProps, type SpectrumColor, type SpectrumConfig, type SpectrumRGB, type SpectrumValue, type SpectrumValueEntry, type StateStyleProps, type StyleProps, type SwitchSize, type TShirtSize, type TShirtSizeCommon, type TextDecorationLine, type TextProperty, type TextStyleProps, type TextTransform, type TextTransformConfig, type TextVariant, type TextVariantTypography, type TextVariantUi, type TextVariantWithoutEmphasized, type ToastPosition, type ToastSize, type ToastVariant, type TooltipPlacement, type TooltipSize, type TooltipVariant, type TransitionDelay, type TransitionDuration, type TransitionTiming, type TypographyConfig, type TypographyResponsiveProperty, type TypographyStyle, type TypographyStyleProperty, type TypographyUnitValue, type UdsCssVar, type UnitlessUnit, type UniversalAvatarBaseProps, type UniversalAvatarIconProps, type UniversalAvatarImageProps, type UniversalAvatarProps, type UniversalAvatarTextProps, type UniversalBadgeProps, type UniversalBannerProps, type UniversalBottomSheetContentProps, type UniversalBottomSheetHeaderProps, type UniversalBottomSheetProps, type UniversalBoxProps, type UniversalButtonProps, type UniversalCheckboxProps, type UniversalChipBaseProps, type UniversalChipButtonProps, type UniversalChipDismissibleProps, type UniversalChipLinkProps, type UniversalChipProps, type UniversalChipToggleProps, type UniversalDividerProps, type UniversalFormLabelProps, type UniversalIconButtonProps, type UniversalIconProps, type UniversalIconSlot, type UniversalImageProps, type UniversalInputProps, type UniversalLinkProps, type UniversalMenuItemProps, type UniversalPopoverContentProps, type UniversalPopoverProps, type UniversalPopoverTriggerProps, type UniversalPressableProps, type UniversalRadioGroupProps, type UniversalRadioProps, type UniversalStackProps, type UniversalSwitchProps, type UniversalTabListProps, type UniversalTabPanelProps, type UniversalTabProps, type UniversalTabsProps, type UniversalTabsVariant, type UniversalTextProps, type UniversalToastProps, type UniversalTokensConfigAutoBase, type UniversalTokensConfigBase, type UniversalTokensConfigGeneric, type UniversalTooltipContentProps, type UniversalTooltipProps, type UniversalTooltipTriggerProps };