@yahoo/uds 3.58.2-beta.1 → 3.59.0-beta.1

package/src/components/client/Chip/ChipDismissible.tsx

@@ -0,0 +1,90 @@
+import { Cross } from '@yahoo/uds-icons';
+import React, { forwardRef, useCallback, useMemo } from 'react';
+
+import { cx, getStyles } from '../../../styles/styler';
+import type { UniversalChipDismissibleProps } from '../../../tokens';
+import { mergeSlotProps } from '../../../utils/mergeSlotProps';
+import type { IconProps } from '../../Icon';
+import { IconSlot } from '../../IconSlot';
+import { Pressable } from '../Pressable';
+import type { ChipBaseProps } from './ChipBase';
+import { ChipBase, VARIANT_DEFAULT } from './ChipBase';
+
+type HtmlDivProps = Omit<React.HTMLAttributes<HTMLDivElement>, 'children' | 'onToggle' | 'label'>;
+
+interface ChipDismissibleProps extends HtmlDivProps, Omit<UniversalChipDismissibleProps, 'type'> {
+  slotProps?: ChipBaseProps['slotProps'];
+}
+
+const ChipDismissible = forwardRef<HTMLDivElement, ChipDismissibleProps>(function ChipDismissible(
+  {
+    dismissButtonAriaLabel,
+    onDismiss,
+    dismissIcon,
+    variant = VARIANT_DEFAULT,
+    disabled,
+    slotProps,
+    className,
+    ...rest
+  }: ChipDismissibleProps,
+  ref,
+) {
+  const classNames = useMemo(
+    () => ({
+      root: getStyles({
+        chipDismissibleVariantRoot: variant,
+        className,
+      }),
+
+      icon: getStyles({
+        chipDismissibleVariantIcon: variant,
+      }),
+
+      iconPressable: cx('uds-chip-dismissible-button', 'uds-hit-target'),
+    }),
+    [className, variant],
+  );
+
+  /**
+   * Handlers
+   */
+  const handleDismissClick = useCallback(
+    (e: React.MouseEvent<HTMLButtonElement>) => {
+      e.stopPropagation();
+      onDismiss?.();
+    },
+    [onDismiss],
+  );
+
+  const mergedSlotProps = mergeSlotProps(slotProps, {
+    startIcon: { className: classNames.icon },
+    endIcon: { className: classNames.icon },
+  });
+
+  return (
+    <ChipBase
+      ref={ref}
+      disabled={disabled}
+      tabIndex={-1}
+      endIcon={(iconProps: Omit<IconProps, 'name'>) => (
+        <Pressable
+          // Note: asChild interferes with motion/react here so we keep the wrapper
+          aria-label={dismissButtonAriaLabel}
+          className={classNames.iconPressable}
+          onClick={handleDismissClick}
+          disabled={disabled}
+        >
+          <IconSlot icon={dismissIcon ?? Cross} iconProps={iconProps} />
+        </Pressable>
+      )}
+      className={classNames.root}
+      slotProps={mergedSlotProps}
+      {...rest}
+    />
+  );
+});
+
+// Need to re-set this because of the forwardRef wrapper
+ChipDismissible.displayName = 'ChipDismissible';
+
+export { ChipDismissible, type ChipDismissibleProps };

package/src/components/client/Chip/ChipLink.tsx

@@ -0,0 +1,60 @@
+import React, { forwardRef, useMemo } from 'react';
+
+import { getStyles } from '../../../styles/styler';
+import type { UniversalChipLinkProps } from '../../../tokens';
+import { mergeSlotProps } from '../../../utils/mergeSlotProps';
+import type { ChipBaseProps } from './ChipBase';
+import { ChipBase, VARIANT_DEFAULT } from './ChipBase';
+
+type HtmlAnchorProps = Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href' | 'type'>;
+
+interface ChipLinkProps extends HtmlAnchorProps, Omit<UniversalChipLinkProps, 'type'> {
+  slotProps?: ChipBaseProps['slotProps'];
+}
+
+const ChipLink = forwardRef<HTMLAnchorElement, ChipLinkProps>(function ChipLink(
+  { variant = VARIANT_DEFAULT, href, disabled, slotProps, className, ...rest }: ChipLinkProps,
+  ref,
+) {
+  const classNames = useMemo(
+    () => ({
+      root: getStyles({
+        chipLinkVariantRoot: variant,
+        className,
+      }),
+
+      icon: getStyles({
+        chipLinkVariantIcon: variant,
+      }),
+    }),
+    [className, variant],
+  );
+
+  const mergedSlotProps = mergeSlotProps(slotProps, {
+    startIcon: { className: classNames.icon },
+    endIcon: { className: classNames.icon },
+  });
+
+  return (
+    <ChipBase
+      as="a"
+      ref={ref as React.ForwardedRef<HTMLDivElement>}
+      disabled={disabled}
+      className={classNames.root}
+      slotProps={mergedSlotProps}
+      // Required for Safari to render a focus ring
+      tabIndex={0}
+      {...({
+        ...rest,
+
+        // Remove the href is the only way to disable a link
+        href: disabled ? undefined : href,
+      } as ChipBaseProps)}
+    />
+  );
+});
+
+// Need to re-set this because of the forwardRef wrapper
+ChipLink.displayName = 'ChipLink';
+
+export { ChipLink, type ChipLinkProps };

package/src/components/client/Chip/ChipToggle.tsx

@@ -0,0 +1,79 @@
+import type { ForwardedRef } from 'react';
+import React, { forwardRef, useCallback, useMemo } from 'react';
+
+import { getStyles } from '../../../styles/styler';
+import type { UniversalChipToggleProps } from '../../../tokens';
+import { mergeSlotProps } from '../../../utils/mergeSlotProps';
+import type { ChipBaseProps } from './ChipBase';
+import { ChipBase, VARIANT_DEFAULT } from './ChipBase';
+
+type HtmlDivProps = Omit<React.HTMLAttributes<HTMLDivElement>, 'children' | 'label' | 'onToggle'>;
+
+interface ChipToggleProps extends UniversalChipToggleProps, HtmlDivProps {
+  slotProps?: ChipBaseProps['slotProps'];
+}
+
+const ChipToggle = forwardRef<HTMLDivElement, ChipToggleProps>(function ChipToggle(
+  {
+    isToggled = false,
+    onToggle,
+    onClick,
+    variant = VARIANT_DEFAULT,
+    slotProps,
+    className,
+    role = 'checkbox',
+    ...rest
+  }: ChipToggleProps,
+  ref,
+) {
+  const classNames = useMemo(
+    () => ({
+      root: getStyles({
+        chipToggleVariantRoot: variant,
+        chipToggleVariantActiveRoot: isToggled ? 'on' : 'off',
+        className,
+      }),
+
+      icon: getStyles({
+        chipToggleVariantIcon: variant,
+      }),
+    }),
+    [className, isToggled, variant],
+  );
+
+  const handleClick = useCallback(
+    (e: React.MouseEvent<HTMLDivElement>) => {
+      onToggle?.(!isToggled);
+      onClick?.(e);
+    },
+    [isToggled, onClick, onToggle],
+  );
+
+  const mergedSlotProps = mergeSlotProps(slotProps, {
+    startIcon: { className: classNames.icon },
+    endIcon: { className: classNames.icon },
+  });
+
+  // If a user passes a role other than checkbox or switch, they should also manage aria attributes, if applicable, themselves.
+  const isCheckboxOrSwitch = role === 'checkbox' || role === 'switch';
+
+  return (
+    <ChipBase
+      ref={ref as ForwardedRef<HTMLDivElement>}
+      as="button"
+      role={role}
+      aria-checked={isCheckboxOrSwitch ? isToggled : undefined}
+      onClick={handleClick}
+      className={classNames.root}
+      slotProps={mergedSlotProps}
+      // Required for Safari to render a focus ring
+      tabIndex={0}
+      {...rest}
+    />
+  );
+});
+
+// Need to re-set this because of the forwardRef wrapper
+ChipToggle.displayName = 'ChipToggle';
+
+export { ChipToggle, type ChipToggleProps };

package/src/components/client/Chip/index.ts

@@ -0,0 +1,5 @@
+export { Chip, type ChipProps } from './Chip';
+export { ChipButton, type ChipButtonProps } from './ChipButton';
+export { ChipDismissible, type ChipDismissibleProps } from './ChipDismissible';
+export { ChipLink, type ChipLinkProps } from './ChipLink';
+export { ChipToggle, type ChipToggleProps } from './ChipToggle';

package/src/components/client/IconButton.tsx

@@ -0,0 +1,198 @@
+import { buttonIconSvgSize } from '@yahoo/uds/fixtures';
+import type { MotionVariant, UniversalIconButtonProps } from '@yahoo/uds/tokens';
+import { parseDeprecatedButtonPaletteVariant } from '@yahoo/uds/tokens';
+import { Progress } from '@yahoo/uds-icons';
+import type { HTMLMotionProps } from 'motion/react';
+import { AnimatePresence, m, useReducedMotion } from 'motion/react';
+import { forwardRef, useImperativeHandle, useMemo, useRef } from 'react';
+
+import { cx, getStyles } from '../../styles/styler';
+import {
+  buttonMotionVariants,
+  iconMotionVariants,
+  loadingMotionVariants,
+} from '../../tokens/consts/buttonMotionTokens';
+import { Icon } from '../Icon';
+import { SpringMotionConfig } from './SpringMotionConfig';
+
+type HtmlButtonProps = Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'color' | 'name'> &
+  Omit<HTMLMotionProps<'button'>, 'name'>;
+interface IconButtonProps extends HtmlButtonProps, UniversalIconButtonProps {}
+
+/**
+ * **⚙️️ An icon button element that can be used to trigger an action**
+ *
+ * @componentType Client component
+ *
+ * @description An icon button is essentially an interactive icon. They should be used to display an icon which, when clicked, allows the user to trigger an action. Icon buttons provide additional features such hover states, focus states, and pressable functionality.
+ *
+ * @see
+ * Check out the {@link https://uds.build/docs/components/icon-button IconButton Docs} for more info
+ *
+ * @usage
+ * - When you need a button that is represented by an icon rather than text. This is useful in compact spaces, toolbars, or when the action is commonly understood through a visual symbol.
+ * - If you need a button that is used to trigger a non-critical action.
+ *
+ * @example
+ * ```tsx
+ * 'use client';
+ * import { IconButton } from "@yahoo/uds";
+ * import { AddFolder } from "@yahoo/uds-icons";
+ *
+ * <IconButton name={AddFolder} variant="primary" />
+ * ```
+ *
+ * @related [Icon](https://uds.build/docs/components/icon), [Button](https://uds.build/docs/components/button), and [Pressable](https://uds.build/docs/components/pressable)
+ *
+ **/
+
+const IconButton = forwardRef<HTMLButtonElement, IconButtonProps>(function IconButton(
+  {
+    // Button config props
+    variant,
+    size: iconButtonSize,
+    // Icon props
+    iconVariant,
+    // State props
+    loading,
+    disableEffects,
+    // Misc props
+    name,
+    // HTML props (className, disabled, aria-*, data-*, onClick, etc.)
+    type = 'button',
+    htmlName,
+    className,
+    children,
+    ...rest
+  }: IconButtonProps,
+  forwardedRef,
+) {
+  /* ------------------------------- Setup refs ------------------------------- */
+  const ref = useRef<HTMLButtonElement>(null);
+  useImperativeHandle(forwardedRef, () => ref.current as HTMLButtonElement);
+
+  /* ---------------------------- Setup classNames ---------------------------- */
+  const { palette: buttonPalette_DEPRECATED, variant: buttonVariant_DEPRECATED } =
+    parseDeprecatedButtonPaletteVariant({ flatVariant: variant });
+
+  const classNames = useMemo(
+    () => ({
+      button: getStyles({
+        // We're still using the button config props here
+        buttonVariant: buttonVariant_DEPRECATED,
+        buttonPalette: buttonPalette_DEPRECATED,
+        // Icon button specific props
+        iconButtonSize,
+        className: cx(
+          // Base class name
+          'uds-icon-button',
+          // Extend button
+          'uds-button',
+          // Focus ring
+          'uds-ring',
+          // Minimum hit target of 44px
+          'uds-hit-target',
+          // State
+          loading && 'uds-button-loading',
+          disableEffects && 'uds-button-without-effects',
+          // Consumer class names
+          className,
+        ),
+      }),
+      loading: 'uds-button-icon start-content animate-spin',
+      icon: 'uds-button-icon start-content',
+    }),
+    [
+      buttonPalette_DEPRECATED,
+      buttonVariant_DEPRECATED,
+      className,
+      disableEffects,
+      iconButtonSize,
+      loading,
+    ],
+  );
+
+  /* --------------------- Motion config setup for button --------------------- */
+  const prefersReducedMotion = useReducedMotion();
+  const layoutVariant: MotionVariant = useMemo(
+    () => (prefersReducedMotion ? 'smooth' : 'subtle'),
+    [prefersReducedMotion],
+  );
+
+  const buttonVariants = useMemo(() => {
+    const { rest, hover, pressed } = buttonMotionVariants;
+
+    // Return empty variants if effects are disabled
+    if (disableEffects) {
+      return { rest: {}, hover: {}, pressed: {} };
+    }
+
+    return { rest, hover, pressed };
+  }, [disableEffects]);
+
+  /* -------------------------------------------------------------------------- */
+  /*                               The IconButton                               */
+  /* -------------------------------------------------------------------------- */
+  return (
+    <SpringMotionConfig
+      layoutSpeed="3"
+      layoutVariant={layoutVariant}
+      reducedMotion={disableEffects ? 'always' : 'user'}
+    >
+      <m.button
+        ref={ref}
+        type={type}
+        className={classNames.button}
+        initial="icon"
+        variants={buttonVariants}
+        whileHover="hover"
+        whileTap="pressed"
+        name={htmlName}
+        {...rest}
+      >
+        <AnimatePresence initial={false} mode="popLayout">
+          {loading && (
+            <m.span
+              key="loading"
+              variants={loadingMotionVariants}
+              initial="loading"
+              animate="loading"
+              exit="hide"
+            >
+              <Icon
+                size={buttonIconSvgSize}
+                name={Progress}
+                variant={iconVariant}
+                color="current"
+                className={classNames.loading}
+              />
+            </m.span>
+          )}
+          {name && !loading && (
+            <m.span
+              key={name.name}
+              variants={iconMotionVariants}
+              initial="icon"
+              animate="icon"
+              exit="hide"
+            >
+              {children || (
+                <Icon
+                  size={buttonIconSvgSize}
+                  name={name}
+                  variant={iconVariant}
+                  color="current"
+                  className={classNames.icon}
+                />
+              )}
+            </m.span>
+          )}
+        </AnimatePresence>
+      </m.button>
+    </SpringMotionConfig>
+  );
+});
+
+IconButton.displayName = 'IconButton';
+
+export { IconButton, type IconButtonProps };