@dxos/react-ui-searchlist 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

package/src/components/SearchList/SearchList.stories.tsx

@@ -0,0 +1,532 @@
+//
+// Copyright 2025 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 { useSearchListInput, useSearchListItem, useSearchListResults } from './hooks';
+import { SearchList } from './SearchList';
+
+faker.seed(1234);
+
+type StoryItem = {
+  id: string;
+  label: string;
+  icon?: string;
+};
+
+const defaultItems: StoryItem[] = faker.helpers.uniqueArray(faker.commerce.productName, 16).map((label) => ({
+  id: faker.string.uuid(),
+  label,
+  icon: 'ph--file--regular',
+}));
+
+//
+// Default Story - Basic composition with SearchList.Item
+//
+
+type DefaultStoryProps = {
+  items?: StoryItem[];
+};
+
+const DefaultStory = ({ items = defaultItems }: DefaultStoryProps) => {
+  const { results, handleSearch } = useSearchListResults({ items });
+
+  return (
+    <SearchList.Root onSearch={handleSearch}>
+      <SearchList.Content classNames='h-[400px]'>
+        <SearchList.Input placeholder='Search items...' autoFocus />
+        <SearchList.Viewport>
+          {results.length > 0 ? (
+            results.map((item) => (
+              <SearchList.Item
+                key={item.id}
+                value={item.id}
+                label={item.label}
+                icon={item.icon}
+                onSelect={() => console.log('[SearchList.Item.onSelect]', item.id, item.label)}
+              />
+            ))
+          ) : (
+            <SearchList.Empty>No results found</SearchList.Empty>
+          )}
+        </SearchList.Viewport>
+      </SearchList.Content>
+    </SearchList.Root>
+  );
+};
+
+//
+// Controlled Story - Controlled query state
+//
+
+const ControlledStory = ({ items = defaultItems }: DefaultStoryProps) => {
+  const [query, setQuery] = useState('');
+  const [results, setResults] = useState<StoryItem[]>(items);
+
+  const handleSearch = (searchQuery: string) => {
+    if (!searchQuery) {
+      setResults(items);
+      return;
+    }
+    const filtered = items.filter((item) => item.label.toLowerCase().includes(searchQuery.toLowerCase()));
+    setResults(filtered);
+  };
+
+  const handleQueryChange = (newQuery: string) => {
+    setQuery(newQuery);
+    handleSearch(newQuery);
+  };
+
+  return (
+    <div className='w-full h-[400px] flex flex-col gap-2'>
+      <div className='text-sm text-description'>Controlled query: &quot;{query}&quot;</div>
+      <SearchList.Root onSearch={handleSearch} value={query}>
+        <SearchList.Input placeholder='Controlled search...' onChange={(e) => handleQueryChange(e.target.value)} />
+        <SearchList.Content>
+          <SearchList.Viewport>
+            {results.map((item) => (
+              <SearchList.Item
+                key={item.id}
+                value={item.id}
+                label={item.label}
+                icon={item.icon}
+                onSelect={() => console.log('[SearchList.Item.onSelect]', item.id)}
+              />
+            ))}
+          </SearchList.Viewport>
+        </SearchList.Content>
+      </SearchList.Root>
+      <button className='px-2 py-1 rounded-sm bg-accent-surface text-accent-text' onClick={() => handleQueryChange('')}>
+        Clear Query
+      </button>
+    </div>
+  );
+};
+
+//
+// Custom Rendering Story - Custom components in Content using useSearchItem hook
+//
+
+type CustomItemProps = {
+  value: string;
+  label: string;
+  description: string;
+  onSelect?: () => void;
+};
+
+const CustomItem = ({ value, label, description, onSelect }: CustomItemProps) => {
+  const { selectedValue, registerItem, unregisterItem } = useSearchListItem();
+  const ref = React.useRef<HTMLDivElement>(null);
+  const isSelected = selectedValue === value;
+
+  React.useEffect(() => {
+    registerItem(value, ref.current, onSelect);
+    return () => unregisterItem(value);
+  }, [value, onSelect, registerItem, unregisterItem]);
+
+  // Scroll into view when selected.
+  React.useEffect(() => {
+    if (isSelected && ref.current) {
+      ref.current.scrollIntoView({ block: 'nearest', behavior: 'smooth' });
+    }
+  }, [isSelected]);
+
+  return (
+    <div
+      ref={ref}
+      role='option'
+      aria-selected={isSelected}
+      data-selected={isSelected}
+      className={`p-2 border-b border-separator cursor-pointer ${isSelected ? 'bg-hover-overlay' : 'hover:bg-hover-overlay'}`}
+      onClick={onSelect}
+    >
+      <div className='font-medium'>{label}</div>
+      <div className='text-xs text-description'>{description}</div>
+    </div>
+  );
+};
+
+const CustomRenderingStory = ({ items = defaultItems }: DefaultStoryProps) => {
+  const { results, handleSearch } = useSearchListResults({ items });
+
+  return (
+    <div className='w-full h-[400px] flex flex-col'>
+      <SearchList.Root onSearch={handleSearch}>
+        <SearchList.Input placeholder='Search with custom rendering...' autoFocus />
+        <SearchList.Content>
+          <SearchList.Viewport>
+            {results.map((item) => (
+              <CustomItem
+                key={item.id}
+                value={item.id}
+                label={item.label}
+                description={`ID: ${item.id}`}
+                onSelect={() => console.log('[CustomItem.onSelect]', item.id, item.label)}
+              />
+            ))}
+          </SearchList.Viewport>
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// With Empty Story - Show Empty component when no results
+//
+
+const WithEmptyStory = () => {
+  const [hasSearched, setHasSearched] = useState(false);
+
+  const handleSearch = (query: string) => {
+    setHasSearched(!!query);
+  };
+
+  return (
+    <div className='w-full h-[400px] flex flex-col'>
+      <SearchList.Root onSearch={handleSearch}>
+        <SearchList.Input placeholder='Try searching for anything...' />
+        <SearchList.Content>
+          {hasSearched ? (
+            <SearchList.Empty classNames='text-center text-description p-4'>
+              <div className='text-lg'>🔍</div>
+              <div>No results found</div>
+              <div className='text-xs'>Try a different search term</div>
+            </SearchList.Empty>
+          ) : (
+            <SearchList.Empty classNames='text-center text-description p-4'>
+              <div>Start typing to search</div>
+            </SearchList.Empty>
+          )}
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// Without Viewport Story - Content without scrolling
+//
+
+const WithoutViewportStory = ({ items = defaultItems }: DefaultStoryProps) => {
+  const { results, handleSearch } = useSearchListResults({ items });
+
+  return (
+    <div className='w-full h-[300px] flex flex-col'>
+      <SearchList.Root onSearch={handleSearch}>
+        <SearchList.Input placeholder='Search without viewport (no scroll)...' classNames='shrink-0' />
+        <SearchList.Content>
+          {results.map((item) => (
+            <SearchList.Item
+              key={item.id}
+              value={item.id}
+              label={item.label}
+              icon={item.icon}
+              onSelect={() => console.log('[SearchList.Item.onSelect]', item.id)}
+            />
+          ))}
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// With Icons Story - Various icon configurations
+//
+
+const iconsItems: StoryItem[] = [
+  { id: '1', label: 'Document', icon: 'ph--file-text--regular' },
+  { id: '2', label: 'Folder', icon: 'ph--folder--regular' },
+  { id: '3', label: 'Image', icon: 'ph--image--regular' },
+  { id: '4', label: 'Settings', icon: 'ph--gear--regular' },
+  { id: '5', label: 'No icon item' },
+];
+
+const WithIconsStory = () => {
+  return (
+    <div className='w-full flex flex-col'>
+      <SearchList.Root>
+        <SearchList.Input placeholder='Search items with icons...' />
+        <SearchList.Content>
+          {iconsItems.map((item) => (
+            <SearchList.Item
+              key={item.id}
+              value={item.id}
+              label={item.label}
+              icon={item.icon}
+              onSelect={() => console.log('[SearchList.Item.onSelect]', item.id)}
+            />
+          ))}
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// Custom Input Story - Demonstrate using hooks for custom input
+//
+
+const CustomInput = () => {
+  const { query, onQueryChange, selectedValue, onSelectedValueChange, getItemValues, triggerSelect } =
+    useSearchListInput();
+
+  const handleKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => {
+    const values = getItemValues();
+    if (values.length === 0) {
+      if (event.key === 'Escape') {
+        onQueryChange('');
+      }
+      return;
+    }
+
+    const currentIndex = selectedValue !== undefined ? values.indexOf(selectedValue) : -1;
+
+    switch (event.key) {
+      case 'ArrowDown': {
+        event.preventDefault();
+        const nextIndex = currentIndex === -1 ? 0 : Math.min(currentIndex + 1, values.length - 1);
+        const nextValue = values[nextIndex];
+        if (nextValue !== undefined) {
+          onSelectedValueChange(nextValue);
+        }
+        break;
+      }
+      case 'ArrowUp': {
+        event.preventDefault();
+        const prevIndex = currentIndex === -1 ? values.length - 1 : Math.max(currentIndex - 1, 0);
+        const prevValue = values[prevIndex];
+        if (prevValue !== undefined) {
+          onSelectedValueChange(prevValue);
+        }
+        break;
+      }
+      case 'Enter': {
+        if (selectedValue !== undefined) {
+          event.preventDefault();
+          triggerSelect();
+        }
+        break;
+      }
+      case 'Escape': {
+        event.preventDefault();
+        if (selectedValue !== undefined) {
+          onSelectedValueChange(undefined);
+        } else {
+          onQueryChange('');
+        }
+        break;
+      }
+    }
+  };
+
+  return (
+    <div className='flex gap-2 items-center p-2 bg-input rounded-sm'>
+      <input
+        type='text'
+        value={query}
+        onChange={(ev) => onQueryChange(ev.target.value)}
+        onKeyDown={handleKeyDown}
+        placeholder='Custom input...'
+        className='bg-transparent outline-hidden grow'
+      />
+      {query && (
+        <button onClick={() => onQueryChange('')} className='text-description hover:text-base-surface-text'>
+          ✕
+        </button>
+      )}
+    </div>
+  );
+};
+
+const CustomInputStory = ({ items = defaultItems }: DefaultStoryProps) => {
+  const { results, handleSearch } = useSearchListResults({ items });
+
+  return (
+    <div className='w-full h-[400px] flex flex-col border border-separator'>
+      <SearchList.Root onSearch={handleSearch}>
+        <CustomInput />
+        <SearchList.Content>
+          <SearchList.Viewport>
+            {results.map((item) => (
+              <SearchList.Item
+                key={item.id}
+                value={item.id}
+                label={item.label}
+                icon={item.icon}
+                onSelect={() => console.log('[SearchList.Item.onSelect]', item.id)}
+              />
+            ))}
+          </SearchList.Viewport>
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// With Disabled Items Story
+//
+
+const disabledItems: StoryItem[] = [
+  { id: '1', label: 'Available item 1', icon: 'ph--check--regular' },
+  { id: '2', label: 'Disabled item (cannot select)', icon: 'ph--prohibit--regular' },
+  { id: '3', label: 'Available item 2', icon: 'ph--check--regular' },
+  { id: '4', label: 'Disabled item 2', icon: 'ph--prohibit--regular' },
+  { id: '5', label: 'Available item 3', icon: 'ph--check--regular' },
+];
+
+const WithDisabledItemsStory = () => {
+  return (
+    <div className='w-full flex flex-col'>
+      <SearchList.Root>
+        <SearchList.Input placeholder='Arrow keys skip disabled items...' autoFocus />
+        <SearchList.Content>
+          {disabledItems.map((item, index) => (
+            <SearchList.Item
+              key={item.id}
+              value={item.id}
+              label={item.label}
+              icon={item.icon}
+              disabled={index === 1 || index === 3}
+              onSelect={() => console.log('[SearchList.Item.onSelect]', item.id)}
+            />
+          ))}
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// With Groups Story
+//
+
+type GroupedItem = StoryItem & { category: string };
+
+const groupedItems: GroupedItem[] = [
+  { id: '1', label: 'Document 1', icon: 'ph--file-text--regular', category: 'Documents' },
+  { id: '2', label: 'Document 2', icon: 'ph--file-text--regular', category: 'Documents' },
+  { id: '3', label: 'Image 1', icon: 'ph--image--regular', category: 'Images' },
+  { id: '4', label: 'Image 2', icon: 'ph--image--regular', category: 'Images' },
+  { id: '5', label: 'Settings', icon: 'ph--gear--regular', category: 'Other' },
+];
+
+const WithGroupsStory = () => {
+  const { results, handleSearch } = useSearchListResults({ items: groupedItems });
+
+  // Group items by category.
+  const grouped = results.reduce(
+    (acc, item) => {
+      if (!acc[item.category]) {
+        acc[item.category] = [];
+      }
+      acc[item.category].push(item);
+      return acc;
+    },
+    {} as Record<string, GroupedItem[]>,
+  );
+
+  return (
+    <div className='w-full h-[400px] flex flex-col'>
+      <SearchList.Root onSearch={handleSearch}>
+        <SearchList.Input placeholder='Search grouped items...' autoFocus />
+        <SearchList.Content>
+          <SearchList.Viewport>
+            {Object.entries(grouped).map(([category, items]) => (
+              <SearchList.Group key={category} heading={category}>
+                {items.map((item) => (
+                  <SearchList.Item
+                    key={item.id}
+                    value={item.id}
+                    label={item.label}
+                    icon={item.icon}
+                    onSelect={() => console.log('[SearchList.Item.onSelect]', item.id, item.label)}
+                  />
+                ))}
+              </SearchList.Group>
+            ))}
+            {results.length === 0 && <SearchList.Empty>No results found</SearchList.Empty>}
+          </SearchList.Viewport>
+        </SearchList.Content>
+      </SearchList.Root>
+    </div>
+  );
+};
+
+//
+// Meta
+//
+
+const meta = {
+  title: 'ui/react-ui-searchlist/SearchList',
+  component: SearchList.Root as any,
+  decorators: [withTheme(), withLayout({ layout: 'column' })],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  render: DefaultStory,
+  args: {
+    items: defaultItems,
+  },
+};
+
+export const Controlled: Story = {
+  render: ControlledStory,
+  args: {
+    items: defaultItems,
+  },
+};
+
+export const CustomRendering: Story = {
+  render: CustomRenderingStory,
+  args: {
+    items: defaultItems,
+  },
+};
+
+export const WithEmpty: Story = {
+  render: WithEmptyStory,
+};
+
+export const WithoutViewport: Story = {
+  render: WithoutViewportStory,
+  args: {
+    items: defaultItems,
+  },
+};
+
+export const WithIcons: Story = {
+  render: WithIconsStory,
+};
+
+export const CustomInputExample: Story = {
+  render: CustomInputStory,
+  args: {
+    items: defaultItems,
+  },
+};
+
+export const WithDisabledItems: Story = {
+  render: WithDisabledItemsStory,
+};
+
+export const WithGroups: Story = {
+  render: WithGroupsStory,
+};