@dxos/react-ui-searchlist 0.8.4-main.84f28bd → 0.8.4-main.9735255

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@dxos/react-ui-searchlist",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.9735255",
   "description": "A themed ⌘K-style combobox component, triggered by a button (or keyboard shortcut), where values are queried only within the invoked modal.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -24,29 +29,28 @@
     "src"
   ],
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
+    "@fluentui/react-tabster": "9.26.11",
+    "@radix-ui/react-compose-refs": "1.1.1",
     "@radix-ui/react-context": "1.1.1",
     "@radix-ui/react-use-controllable-state": "1.1.0",
-    "cmdk": "^0.2.0"
+    "command-score": "0.1.2"
   },
   "devDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/random": "0.8.4-main.84f28bd",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd",
-    "@dxos/storybook-utils": "0.8.4-main.84f28bd"
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "7.1.9",
+    "@dxos/random": "0.8.4-main.9735255",
+    "@dxos/react-ui": "0.8.4-main.9735255",
+    "@dxos/storybook-utils": "0.8.4-main.9735255",
+    "@dxos/ui-theme": "0.8.4-main.9735255"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-theme": "0.8.4-main.84f28bd"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.9735255",
+    "@dxos/ui-theme": "0.8.4-main.9735255"
   },
   "publishConfig": {
     "access": "public"

package/src/components/Combobox/Combobox.stories.tsx

@@ -0,0 +1,62 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React from 'react';
+
+import { faker } from '@dxos/random';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+import { useSearchListResults } from '../SearchList/hooks';
+
+import { Combobox } from './Combobox';
+
+faker.seed(1234);
+
+const items = faker.helpers.uniqueArray(faker.commerce.productName, 16).sort();
+
+const DefaultStory = () => {
+  const { results, handleSearch } = useSearchListResults({
+    items,
+  });
+
+  return (
+    <Combobox.Root
+      placeholder='Nothing selected'
+      onValueChange={(value) => {
+        console.log('[Combobox.Root.onValueChange]', value);
+      }}
+    >
+      <Combobox.Trigger />
+      <Combobox.Content onSearch={handleSearch}>
+        <Combobox.Input placeholder='Search...' />
+        <Combobox.List>
+          {results.map((value) => (
+            <Combobox.Item key={value} value={value} label={value} />
+          ))}
+        </Combobox.List>
+        <Combobox.Arrow />
+      </Combobox.Content>
+    </Combobox.Root>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-searchlist/Combobox',
+  component: Combobox.Root as any,
+  render: DefaultStory,
+  decorators: [withTheme, withLayout({ layout: 'column', classNames: 'p-2' })],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {},
+};

package/src/components/Combobox/Combobox.tsx

@@ -0,0 +1,356 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { createContext } from '@radix-ui/react-context';
+import { useControllableState } from '@radix-ui/react-use-controllable-state';
+import React, { type PropsWithChildren, forwardRef, useCallback } from 'react';
+
+import {
+  Button,
+  type ButtonProps,
+  Icon,
+  Popover,
+  type PopoverArrowProps,
+  type PopoverContentProps,
+  type PopoverVirtualTriggerProps,
+} from '@dxos/react-ui';
+import { useId } from '@dxos/react-ui';
+import { mx, staticPlaceholderText } from '@dxos/ui-theme';
+
+import {
+  SearchList,
+  type SearchListContentProps,
+  type SearchListEmptyProps,
+  type SearchListInputProps,
+  type SearchListItemProps,
+  type SearchListRootProps,
+} from '../SearchList';
+
+const COMBOBOX_NAME = 'Combobox';
+const COMBOBOX_CONTENT_NAME = 'ComboboxContent';
+const COMBOBOX_ITEM_NAME = 'ComboboxItem';
+const COMBOBOX_TRIGGER_NAME = 'ComboboxTrigger';
+
+//
+// Context
+//
+
+type ComboboxContextValue = {
+  modalId: string;
+  isCombobox: true;
+  placeholder?: string;
+  open: boolean;
+  onOpenChange: (nextOpen: boolean) => void;
+  value: string;
+  onValueChange: (nextValue: string) => void;
+};
+
+const [ComboboxProvider, useComboboxContext] = createContext<Partial<ComboboxContextValue>>(COMBOBOX_NAME, {});
+
+//
+// Root
+//
+
+type ComboboxRootProps = PropsWithChildren<
+  Partial<ComboboxContextValue & { modal: boolean; defaultOpen: boolean; defaultValue: string; placeholder: string }>
+>;
+
+const ComboboxRoot = ({
+  modal,
+  modalId: propsModalId,
+  open: propsOpen,
+  defaultOpen,
+  onOpenChange: propsOnOpenChange,
+  value: propsValue,
+  defaultValue,
+  onValueChange: propsOnValueChange,
+  placeholder,
+  children,
+}: ComboboxRootProps) => {
+  const modalId = useId(COMBOBOX_NAME, propsModalId);
+  const [open = false, onOpenChange] = useControllableState({
+    prop: propsOpen,
+    onChange: propsOnOpenChange,
+    defaultProp: defaultOpen,
+  });
+  const [value = '', onValueChange] = useControllableState({
+    prop: propsValue,
+    onChange: propsOnValueChange,
+    defaultProp: defaultValue,
+  });
+
+  return (
+    <Popover.Root open={open} onOpenChange={onOpenChange} modal={modal}>
+      <ComboboxProvider
+        isCombobox
+        modalId={modalId}
+        placeholder={placeholder}
+        open={open}
+        onOpenChange={onOpenChange}
+        value={value}
+        onValueChange={onValueChange}
+      >
+        {children}
+      </ComboboxProvider>
+    </Popover.Root>
+  );
+};
+
+//
+// ContentProps
+//
+
+type ComboboxContentProps = SearchListRootProps & PopoverContentProps & { label?: string };
+
+const ComboboxContent = forwardRef<HTMLDivElement, ComboboxContentProps>(
+  (
+    {
+      side = 'bottom',
+      collisionPadding = 48,
+      sideOffset,
+      align,
+      alignOffset,
+      avoidCollisions,
+      collisionBoundary,
+      arrowPadding,
+      sticky,
+      hideWhenDetached,
+      onOpenAutoFocus,
+      onCloseAutoFocus,
+      onEscapeKeyDown,
+      onPointerDownOutside,
+      onFocusOutside,
+      onInteractOutside,
+      forceMount,
+      children,
+      classNames,
+      onSearch,
+      value,
+      defaultValue,
+      debounceMs,
+      label,
+    },
+    forwardedRef,
+  ) => {
+    const { modalId } = useComboboxContext(COMBOBOX_CONTENT_NAME);
+
+    return (
+      <Popover.Content
+        {...{
+          side,
+          sideOffset,
+          align,
+          alignOffset,
+          avoidCollisions,
+          collisionBoundary,
+          collisionPadding,
+          arrowPadding,
+          sticky,
+          hideWhenDetached,
+          onOpenAutoFocus,
+          onCloseAutoFocus,
+          onEscapeKeyDown,
+          onPointerDownOutside,
+          onFocusOutside,
+          onInteractOutside,
+          forceMount,
+        }}
+        classNames={[
+          'is-[--radix-popover-trigger-width] max-bs-[--radix-popover-content-available-height] grid grid-rows-[min-content_1fr]',
+          classNames,
+        ]}
+        id={modalId}
+        ref={forwardedRef}
+      >
+        <SearchList.Root onSearch={onSearch} value={value} defaultValue={defaultValue} debounceMs={debounceMs}>
+          <div className='contents density-fine' aria-label={label} role='combobox' aria-expanded='true'>
+            {children}
+          </div>
+        </SearchList.Root>
+      </Popover.Content>
+    );
+  },
+);
+
+ComboboxContent.displayName = COMBOBOX_CONTENT_NAME;
+
+//
+// Trigger
+//
+
+type ComboboxTriggerProps = ButtonProps;
+
+const ComboboxTrigger = forwardRef<HTMLButtonElement, ComboboxTriggerProps>(
+  ({ children, onClick, ...props }, forwardedRef) => {
+    const { modalId, open, onOpenChange, placeholder, value } = useComboboxContext(COMBOBOX_TRIGGER_NAME);
+    const handleClick = useCallback(
+      (event: Parameters<Exclude<ButtonProps['onClick'], undefined>>[0]) => {
+        onClick?.(event);
+        onOpenChange?.(true);
+      },
+      [onClick, onOpenChange],
+    );
+
+    return (
+      <Popover.Trigger asChild>
+        <Button
+          {...props}
+          role='combobox'
+          aria-expanded={open}
+          aria-controls={modalId}
+          aria-haspopup='dialog'
+          onClick={handleClick}
+          ref={forwardedRef}
+        >
+          {children ?? (
+            <>
+              <span
+                className={mx('font-normal text-start flex-1 min-is-0 truncate mie-2', !value && staticPlaceholderText)}
+              >
+                {value || placeholder}
+              </span>
+              <Icon icon='ph--caret-down--bold' size={3} />
+            </>
+          )}
+        </Button>
+      </Popover.Trigger>
+    );
+  },
+);
+
+ComboboxTrigger.displayName = COMBOBOX_TRIGGER_NAME;
+
+//
+// VirtualTrigger
+//
+
+type ComboboxVirtualTriggerProps = PopoverVirtualTriggerProps;
+
+const ComboboxVirtualTrigger = Popover.VirtualTrigger;
+
+//
+// Input
+//
+
+type ComboboxInputProps = SearchListInputProps;
+
+const ComboboxInput = forwardRef<HTMLInputElement, ComboboxInputProps>(({ classNames, ...props }, forwardedRef) => {
+  return (
+    <SearchList.Input
+      {...props}
+      classNames={[
+        'mli-cardSpacingChrome mbs-cardSpacingChrome mbe-0 is-[calc(100%-2*var(--dx-cardSpacingChrome))]',
+        classNames,
+      ]}
+      ref={forwardedRef}
+    />
+  );
+});
+
+//
+// List
+//
+
+type ComboboxListProps = SearchListContentProps;
+
+const ComboboxList = forwardRef<HTMLDivElement, ComboboxListProps>(({ classNames, ...props }, forwardedRef) => {
+  return (
+    <SearchList.Content
+      {...props}
+      classNames={['min-bs-0 overflow-y-auto plb-cardSpacingChrome', classNames]}
+      ref={forwardedRef}
+    />
+  );
+});
+
+//
+// Item
+//
+
+type ComboboxItemProps = SearchListItemProps & {
+  /** Whether to close the popover when this item is selected. Defaults to true. */
+  closeOnSelect?: boolean;
+};
+
+const ComboboxItem = forwardRef<HTMLDivElement, ComboboxItemProps>(
+  ({ classNames, onSelect, value, closeOnSelect = true, ...props }, forwardedRef) => {
+    const { onValueChange, onOpenChange } = useComboboxContext(COMBOBOX_ITEM_NAME);
+    const handleSelect = useCallback<NonNullable<SearchListItemProps['onSelect']>>(() => {
+      onSelect?.();
+      if (value !== undefined) {
+        onValueChange?.(value);
+      }
+      if (closeOnSelect) {
+        onOpenChange?.(false);
+      }
+    }, [onSelect, onValueChange, onOpenChange, value, closeOnSelect]);
+
+    return (
+      <SearchList.Item
+        {...props}
+        value={value}
+        classNames={['mli-cardSpacingChrome pli-cardSpacingChrome', classNames]}
+        onSelect={handleSelect}
+        ref={forwardedRef}
+      />
+    );
+  },
+);
+
+ComboboxItem.displayName = COMBOBOX_ITEM_NAME;
+
+//
+// Arrow
+//
+
+type ComboboxArrowProps = PopoverArrowProps;
+
+const ComboboxArrow = Popover.Arrow;
+
+//
+// Empty
+//
+
+type ComboboxEmptyProps = SearchListEmptyProps;
+
+const ComboboxEmpty = SearchList.Empty;
+
+//
+// Combobox
+// https://www.w3.org/WAI/ARIA/apg/patterns/combobox
+//
+
+//
+// Portal
+//
+
+type ComboboxPortalProps = React.ComponentPropsWithoutRef<typeof Popover.Portal>;
+
+const ComboboxPortal = Popover.Portal;
+
+export const Combobox = {
+  Root: ComboboxRoot,
+  Portal: ComboboxPortal,
+  Content: ComboboxContent,
+  Trigger: ComboboxTrigger,
+  VirtualTrigger: ComboboxVirtualTrigger,
+  Input: ComboboxInput,
+  List: ComboboxList,
+  Item: ComboboxItem,
+  Arrow: ComboboxArrow,
+  Empty: ComboboxEmpty,
+};
+
+export type {
+  ComboboxRootProps,
+  ComboboxPortalProps,
+  ComboboxContentProps,
+  ComboboxTriggerProps,
+  ComboboxVirtualTriggerProps,
+  ComboboxInputProps,
+  ComboboxListProps,
+  ComboboxItemProps,
+  ComboboxArrowProps,
+  ComboboxEmptyProps,
+};

package/src/components/Combobox/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './Combobox';

package/src/components/Listbox/Listbox.stories.tsx

@@ -0,0 +1,53 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useState } from 'react';
+
+import { faker } from '@dxos/random';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+
+import { translations } from '../../translations';
+
+import { Listbox } from './Listbox';
+
+faker.seed(1234);
+
+type StoryItem = { value: string; label: string };
+
+const options: StoryItem[] = faker.helpers.multiple(
+  () => ({ value: faker.string.uuid(), label: faker.commerce.productName() }) satisfies StoryItem,
+  { count: 16 },
+);
+
+const DefaultStory = () => {
+  const [selectedValue, setSelectedValue] = useState<string>();
+
+  return (
+    <Listbox.Root value={selectedValue} onValueChange={setSelectedValue}>
+      {options.map((option) => (
+        <Listbox.Option key={option.value} value={option.value}>
+          <Listbox.OptionLabel>{option.label}</Listbox.OptionLabel>
+          <Listbox.OptionIndicator />
+        </Listbox.Option>
+      ))}
+    </Listbox.Root>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-searchlist/Listbox',
+  component: Listbox.Root,
+  render: DefaultStory,
+  decorators: [withTheme, withLayout({ layout: 'column', classNames: 'p-2' })],
+  parameters: {
+    translations,
+  },
+} satisfies Meta<typeof Listbox.Root>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};