PPolaris ComponentsConnect an agent

Listbox

A keyboard-navigable list of selectable options with optional headers and actions, the building block behind Combobox and other custom pickers.

Preview

Code

Example.jsx
import { useState, useCallback } from 'react';
import { Card, Box, BlockStack, InlineStack, Text, Listbox, Icon, Badge } from '@shopify/polaris';
import { PlusCircleIcon } from '@shopify/polaris-icons';

const INITIAL_SEGMENTS = [
  { value: 'all-customers', label: 'All customers', count: 4820 },
  { value: 'repeat-buyers', label: 'Repeat buyers', count: 918 },
  { value: 'abandoned-checkout', label: 'Abandoned checkout', count: 231 },
  { value: 'email-subscribers', label: 'Email subscribers', count: 3105 },
];

const CREATE_SEGMENT = 'create-segment';

const NEW_SEGMENT = { value: 'vip-spenders', label: 'VIP spenders', count: 47 };

export const Example = () => {
  const [segments, setSegments] = useState(INITIAL_SEGMENTS);
  const [selected, setSelected] = useState('repeat-buyers');

  const handleSelect = useCallback((value) => {
    if (value === CREATE_SEGMENT) {
      setSegments((current) =>
        current.some((segment) => segment.value === NEW_SEGMENT.value) ? current : [...current, NEW_SEGMENT]
      );
      setSelected(NEW_SEGMENT.value);
      return;
    }
    setSelected(value);
  }, []);

  const selectedSegment = segments.find((segment) => segment.value === selected);

  return (
    <Card padding="0">
      <Box padding="300">
        <Text as="h2" variant="headingMd">
          Customer segments
        </Text>
      </Box>
      <Listbox accessibilityLabel="Customer segments" onSelect={handleSelect} enableKeyboardControl>
        <Listbox.Header>Saved segments</Listbox.Header>
        {segments.map((segment) => (
          <Listbox.Option
            key={segment.value}
            value={segment.value}
            selected={segment.value === selected}
            accessibilityLabel={segment.label}
          >
            <Listbox.TextOption selected={segment.value === selected}>
              <InlineStack align="space-between" blockAlign="center">
                <Text as="span">{segment.label}</Text>
                <Text as="span" tone="subdued" variant="bodySm">
                  {segment.count.toLocaleString('en-US')}
                </Text>
              </InlineStack>
            </Listbox.TextOption>
          </Listbox.Option>
        ))}
        <Listbox.Action value={CREATE_SEGMENT}>
          <InlineStack gap="100" blockAlign="center">
            <Icon source={PlusCircleIcon} tone="subdued" />
            <Text as="span">Add VIP spenders segment</Text>
          </InlineStack>
        </Listbox.Action>
      </Listbox>
      <Box padding="300" borderBlockStartWidth="025" borderColor="border">
        <InlineStack gap="200" blockAlign="center">
          <Badge tone="info">Active</Badge>
          <Text as="span" tone="subdued">
            {selectedSegment ? `${selectedSegment.label} · ${selectedSegment.count.toLocaleString('en-US')} customers` : 'No segment selected'}
          </Text>
        </InlineStack>
      </Box>
    </Card>
  );
};