Skip to content

The Open Standard for Generative UI

2.0 KB
Raw Blame
import clsx from "clsx";
import { forwardRef, type HTMLAttributes, type ReactNode } from "react";

export type ChipsSelectionType = "single" | "multiple";

export interface ChipsItem {
  value: string;
  label: string;
  icon?: ReactNode;
  disabled?: boolean;
}

export interface ChipsProps extends Omit<HTMLAttributes<HTMLDivElement>, "onToggle"> {
  items: ChipsItem[];
  /** Currently selected item values. */
  selected?: string[];
  type?: ChipsSelectionType;
  /** Disables every chip (e.g. while streaming). */
  disabled?: boolean;
  onToggle?: (value: string) => void;
  className?: string;
}

const Chips = forwardRef<HTMLDivElement, ChipsProps>((props, ref) => {
  const {
    items,
    selected = [],
    type = "multiple",
    disabled = false,
    onToggle,
    className,
    ...rest
  } = props;

  // Items without a value have no stable identity to select or toggle by.
  const renderableItems = (items ?? []).filter((item) => Boolean(item?.value));

  return (
    <div
      ref={ref}
      className={clsx("openui-chips", className)}
      role="listbox"
      aria-multiselectable={type === "multiple"}
      {...rest}
    >
      {renderableItems.map((item) => {
        const isSelected = selected.includes(item.value);
        const isDisabled = disabled || item.disabled === true;

        return (
          <button
            key={item.value}
            type="button"
            role="option"
            aria-selected={isSelected}
            disabled={isDisabled}
            className={clsx(
              "openui-chip-item",
              isSelected && "openui-chip-item--selected",
              isDisabled && "openui-chip-item--disabled",
            )}
            onClick={() => onToggle?.(item.value)}
          >
            {item.icon ? <span className="openui-chip-item__icon">{item.icon}</span> : null}
            <span className="openui-chip-item__text">{item.label}</span>
          </button>
        );
      })}
    </div>
  );
});

Chips.displayName = "Chips";

export { Chips };