@vendure-io/ui 1.0.5 → 1.2.0

package/README.md

@@ -29,8 +29,57 @@ import { cn } from "@vendure-io/ui/lib/utils";
 | `@vendure-io/ui/components/ui/*` | shadcn/ui primitives (button, dialog, input, etc.) |
 | `@vendure-io/ui/components/custom/*` | Vendure-specific components |
 | `@vendure-io/ui/lib/*` | Utilities (`cn`, etc.) |
+| `@vendure-io/ui/lib/base-ui` | `@base-ui/react` primitive namespaces (see below) |
 | `@vendure-io/ui/hooks/*` | Shared React hooks |
 
+## Customizing wrapper components
+
+The components under `components/ui/*` are thin wrappers around [`@base-ui/react`](https://base-ui.com/) primitives. To override a single subcomponent (e.g. swap `DialogTitle` for one with a different font) while re-using the rest, import the underlying primitive namespace from `@vendure-io/ui/lib/base-ui` rather than from `@base-ui/react` directly:
+
+```tsx
+// In your own dialog.tsx
+import { DialogPrimitive } from "@vendure-io/ui/lib/base-ui";
+import {
+  Dialog,
+  DialogClose,
+  DialogContent,
+  DialogDescription,
+  DialogFooter,
+  DialogHeader,
+  DialogOverlay,
+  DialogPortal,
+  DialogTrigger,
+} from "@vendure-io/ui/components/ui/dialog";
+
+export {
+  Dialog,
+  DialogClose,
+  DialogContent,
+  DialogDescription,
+  DialogFooter,
+  DialogHeader,
+  DialogOverlay,
+  DialogPortal,
+  DialogTrigger,
+};
+
+export function DialogTitle({ className, ...props }: DialogPrimitive.Title.Props) {
+  return (
+    <DialogPrimitive.Title
+      data-slot="dialog-title"
+      className={cn("font-display text-lg", className)}
+      {...props}
+    />
+  );
+}
+```
+
+Each primitive is exposed as a TypeScript namespace, so you get both the runtime component (`<DialogPrimitive.Title />`) and its prop types (`DialogPrimitive.Title.Props`) from the same import. This means you don't need `@base-ui/react` as a direct dependency in your project — `@vendure-io/ui` is the single source of truth for both wrappers and primitives.
+
+Available primitives include `AccordionPrimitive`, `AlertDialogPrimitive`, `AvatarPrimitive`, `ButtonPrimitive`, `CheckboxPrimitive`, `CollapsiblePrimitive`, `ComboboxPrimitive`, `ContextMenuPrimitive`, `DialogPrimitive`, `InputPrimitive`, `MenuPrimitive`, `MenubarPrimitive`, `NavigationMenuPrimitive`, `PopoverPrimitive`, `PreviewCardPrimitive`, `ProgressPrimitive`, `RadioPrimitive`, `RadioGroupPrimitive`, `ScrollAreaPrimitive`, `SelectPrimitive`, `SeparatorPrimitive`, `SliderPrimitive`, `SwitchPrimitive`, `TabsPrimitive`, `TogglePrimitive`, `ToggleGroupPrimitive`, `TooltipPrimitive`, plus the `mergeProps` and `useRender` helpers.
+
+> Where two wrappers share the same base-ui primitive (e.g. both `dialog` and `sheet` are built on `Dialog`; both `dropdown-menu` and `menubar` on `Menu`), the primitive is exposed under its canonical base-ui name only.
+
 ## License
 
 See [LICENSE.md](../../LICENSE.md) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendure-io/ui",
-  "version": "1.0.5",
+  "version": "1.2.0",
   "description": "React component library for Vendure, built on shadcn/ui and Tailwind v4",
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://github.com/vendurehq/design/tree/main/packages/ui",
@@ -10,6 +10,7 @@
     "directory": "packages/ui"
   },
   "type": "module",
+  "sideEffects": false,
   "exports": {
     "./components/ui/*": "./src/components/ui/*.tsx",
     "./components/custom/*": "./src/components/custom/*.tsx",
@@ -44,7 +45,7 @@
   },
   "dependencies": {
     "@base-ui/react": "^1.2.0",
-    "@vendure-io/design-tokens": "^1.1.1",
+    "@vendure-io/design-tokens": "^1.2.0",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
     "cmdk": "^1.1.1",

package/src/components/custom/multi-select.tsx

@@ -0,0 +1,176 @@
+'use client';
+
+import {
+  Select,
+  SelectContent,
+  SelectGroup,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from '@vendure-io/ui/components/ui/select';
+import { cn } from '@vendure-io/ui/lib/utils';
+import * as React from 'react';
+
+type ItemValue = string | number;
+
+/**
+ * Describes how to read a piece of data off an item. Pass a property key — only
+ * keys whose value is assignable to `R` are allowed — or a function for full control.
+ */
+type AccessorKey<T, R> = { [K in keyof T]-?: T[K] extends R ? K : never }[keyof T];
+type Accessor<T, R> = AccessorKey<T, R> | ((item: T) => R);
+
+function resolveAccessor<T, R>(item: T, accessor: Accessor<T, R>): R {
+  return typeof accessor === 'function' ? accessor(item) : (item[accessor] as R);
+}
+
+export interface MultiSelectProps<T> {
+  /** The list of options to choose from. */
+  items: readonly T[];
+  /**
+   * How to render each option's label. Pass a property key for the common case
+   * (`itemToLabel="name"`), or a function for full control
+   * (`itemToLabel={(item) => <Flag code={item.code} />}`).
+   * @default String(item)
+   */
+  itemToLabel?: Accessor<T, React.ReactNode>;
+  /**
+   * How to derive the stable value stored in state for each option. Pass a
+   * property key (`itemToValue="id"`) or a function. Required when items are
+   * objects; for string/number items it defaults to the item itself.
+   */
+  itemToValue?: Accessor<T, ItemValue>;
+  /** Selected values. Use for controlled usage. */
+  value?: readonly ItemValue[];
+  /** Initially selected values for uncontrolled usage. */
+  defaultValue?: readonly ItemValue[];
+  /** Called with the next array of selected values whenever the selection changes. */
+  onValueChange?: (value: ItemValue[]) => void;
+  /** Text shown in the trigger when nothing is selected. */
+  placeholder?: React.ReactNode;
+  /**
+   * Override how the selected options are summarised in the trigger. Defaults
+   * to the selected labels joined with commas. Provide this when `itemToLabel`
+   * renders multi-line content, so the trigger stays a single, non-growing line.
+   */
+  renderValue?: (selectedItems: T[]) => React.ReactNode;
+  /** Disable the entire control. */
+  disabled?: boolean;
+  /** Render the error state (sets `aria-invalid` on the trigger). */
+  invalid?: boolean;
+  /** Trigger height. */
+  size?: 'sm' | 'default';
+  /** Class applied to the trigger. Defaults to a full-width, non-growing trigger; pass e.g. `w-[260px]` to fix the width. */
+  className?: string;
+  /** Class applied to the dropdown content. */
+  contentClassName?: string;
+  /** Form field name for the hidden inputs base-ui renders for each value. */
+  name?: string;
+  /** Whether a selection is required for form submission. */
+  required?: boolean;
+  /** id forwarded to the trigger. */
+  id?: string;
+}
+
+function MultiSelect<T>({
+  items,
+  itemToLabel = String as unknown as Accessor<T, React.ReactNode>,
+  itemToValue,
+  value,
+  defaultValue,
+  onValueChange,
+  placeholder = 'Select…',
+  renderValue,
+  disabled,
+  invalid,
+  size = 'default',
+  className,
+  contentClassName,
+  name,
+  required,
+  id,
+}: MultiSelectProps<T>) {
+  const getValue = React.useCallback(
+    (item: T): ItemValue =>
+      itemToValue == null ? (item as unknown as ItemValue) : resolveAccessor(item, itemToValue),
+    [itemToValue],
+  );
+  const getLabel = React.useCallback(
+    (item: T): React.ReactNode => resolveAccessor(item, itemToLabel),
+    [itemToLabel],
+  );
+
+  const itemByValue = React.useMemo(() => {
+    const map = new Map<ItemValue, T>();
+    for (const item of items) {
+      const itemValue = getValue(item);
+      if (process.env.NODE_ENV !== 'production') {
+        if (typeof itemValue !== 'string' && typeof itemValue !== 'number') {
+          console.warn(
+            'MultiSelect: `itemToValue` must resolve to a string or number. When `items` are ' +
+              'objects, pass `itemToValue` (e.g. itemToValue="id") so the selection survives the ' +
+              'items array being recreated.',
+          );
+        } else if (map.has(itemValue)) {
+          console.warn(
+            `MultiSelect: duplicate item value ${JSON.stringify(itemValue)} — each item must ` +
+              'resolve to a unique `itemToValue`; later items override earlier ones.',
+          );
+        }
+      }
+      map.set(itemValue, item);
+    }
+    return map;
+  }, [items, getValue]);
+
+  return (
+    <Select
+      multiple
+      value={value as ItemValue[] | undefined}
+      defaultValue={defaultValue as ItemValue[] | undefined}
+      onValueChange={onValueChange}
+      disabled={disabled}
+      name={name}
+      required={required}
+    >
+      {/* [vendure] default to a stable, container-width trigger so it doesn't grow with the
+          selection — the underlying SelectTrigger is `w-fit`, which we override here. */}
+      <SelectTrigger
+        id={id}
+        size={size}
+        className={cn('w-full', className)}
+        aria-invalid={invalid || undefined}
+      >
+        <SelectValue placeholder={placeholder}>
+          {(selected: ItemValue[]) => {
+            const selectedItems = selected
+              .map((v) => itemByValue.get(v))
+              .filter((item): item is T => item !== undefined);
+            if (selectedItems.length === 0) return placeholder;
+            if (renderValue) return renderValue(selectedItems);
+            return selectedItems.map((item, index) => (
+              <React.Fragment key={getValue(item)}>
+                {index > 0 ? ', ' : null}
+                {getLabel(item)}
+              </React.Fragment>
+            ));
+          }}
+        </SelectValue>
+      </SelectTrigger>
+      <SelectContent className={contentClassName}>
+        <SelectGroup>
+          {items.map((item) => {
+            const itemValue = getValue(item);
+            return (
+              <SelectItem key={itemValue} value={itemValue}>
+                {getLabel(item)}
+              </SelectItem>
+            );
+          })}
+        </SelectGroup>
+      </SelectContent>
+    </Select>
+  );
+}
+
+export { MultiSelect };

package/src/components/ui/popover.tsx

@@ -9,6 +9,10 @@ function Popover({ ...props }: PopoverPrimitive.Root.Props) {
   return <PopoverPrimitive.Root data-slot="popover" {...props} />
 }
 
+function PopoverPortal({ ...props }: PopoverPrimitive.Portal.Props) {
+  return <PopoverPrimitive.Portal data-slot="popover-portal" {...props} />
+}
+
 function PopoverTrigger({ ...props }: PopoverPrimitive.Trigger.Props) {
   return <PopoverPrimitive.Trigger data-slot="popover-trigger" {...props} />
 }
@@ -82,6 +86,7 @@ function PopoverDescription({
 
 export {
   Popover,
+  PopoverPortal,
   PopoverContent,
   PopoverDescription,
   PopoverHeader,

package/src/lib/base-ui.ts

@@ -0,0 +1,53 @@
+/**
+ * Re-exports of `@base-ui/react` primitive namespaces.
+ *
+ * Why this exists: the wrapper components in `@vendure-io/ui/components/ui/*`
+ * are intentionally thin layers over `@base-ui/react` primitives. Consumers
+ * (notably `@vendure/dashboard`) often need to override a single subcomponent
+ * — e.g. swap `DialogTitle` for one that uses a different font — while
+ * re-exporting the rest of the wrapper. To do that they need access to the
+ * underlying primitive's types and components (e.g. `Dialog.Title.Props`).
+ *
+ * Exposing the primitives here means consumers can drop `@base-ui/react` as
+ * a direct dependency entirely — `@vendure-io/ui` becomes the single source
+ * of truth for both the wrapper and the primitive substrate.
+ *
+ * Each primitive is a TS namespace, so both values (`<DialogPrimitive.Title />`)
+ * and types (`DialogPrimitive.Title.Props`) are available from the same
+ * import.
+ *
+ * Where two wrapper files share a base-ui primitive (e.g. `Dialog` is used
+ * by both `dialog.tsx` and `sheet.tsx`; `Menu` by `dropdown-menu.tsx` and
+ * `menubar.tsx`), we expose the canonical base-ui name only — they resolve
+ * to the same underlying type.
+ */
+
+export { Accordion as AccordionPrimitive } from '@base-ui/react/accordion';
+export { AlertDialog as AlertDialogPrimitive } from '@base-ui/react/alert-dialog';
+export { Avatar as AvatarPrimitive } from '@base-ui/react/avatar';
+export { Button as ButtonPrimitive } from '@base-ui/react/button';
+export { Checkbox as CheckboxPrimitive } from '@base-ui/react/checkbox';
+export { Collapsible as CollapsiblePrimitive } from '@base-ui/react/collapsible';
+export { Combobox as ComboboxPrimitive } from '@base-ui/react/combobox';
+export { ContextMenu as ContextMenuPrimitive } from '@base-ui/react/context-menu';
+export { Dialog as DialogPrimitive } from '@base-ui/react/dialog';
+export { Input as InputPrimitive } from '@base-ui/react/input';
+export { Menu as MenuPrimitive } from '@base-ui/react/menu';
+export { Menubar as MenubarPrimitive } from '@base-ui/react/menubar';
+export { mergeProps } from '@base-ui/react/merge-props';
+export { NavigationMenu as NavigationMenuPrimitive } from '@base-ui/react/navigation-menu';
+export { Popover as PopoverPrimitive } from '@base-ui/react/popover';
+export { PreviewCard as PreviewCardPrimitive } from '@base-ui/react/preview-card';
+export { Progress as ProgressPrimitive } from '@base-ui/react/progress';
+export { Radio as RadioPrimitive } from '@base-ui/react/radio';
+export { RadioGroup as RadioGroupPrimitive } from '@base-ui/react/radio-group';
+export { ScrollArea as ScrollAreaPrimitive } from '@base-ui/react/scroll-area';
+export { Select as SelectPrimitive } from '@base-ui/react/select';
+export { Separator as SeparatorPrimitive } from '@base-ui/react/separator';
+export { Slider as SliderPrimitive } from '@base-ui/react/slider';
+export { Switch as SwitchPrimitive } from '@base-ui/react/switch';
+export { Tabs as TabsPrimitive } from '@base-ui/react/tabs';
+export { Toggle as TogglePrimitive } from '@base-ui/react/toggle';
+export { ToggleGroup as ToggleGroupPrimitive } from '@base-ui/react/toggle-group';
+export { Tooltip as TooltipPrimitive } from '@base-ui/react/tooltip';
+export { useRender } from '@base-ui/react/use-render';