@ceed/cds 1.34.0 → 1.35.0

package/dist/components/inputs/SearchBar.md

@@ -2,102 +2,201 @@
 
 ## Introduction
 
-A search input component that optionally includes a category Select for filtering search by keyword type.
-
-> 💡 **Placeholder guidance**
->
-> When `options` are provided, each option can include a `placeholder` field to hint at the expected input format for that category. This helps users understand what value to enter.
->
-> - Account #: `e.g. 1234567`
-> - Jira Issue #: `e.g. PROC-1234`
+A search input component combining a text field and a search button. Optionally includes a category Select that lets users narrow results by keyword type. Hovering over the input while it has a value reveals a clear (✕) button to reset the field. Sizes to its content by default (`inline-flex`) and accepts all `Box` props for layout control.
 
 ```tsx
-<SearchBar options={SAMPLE_OPTIONS} value={value} onChange={setValue} />
+<SearchBar value={value} onChange={setValue} />
 ```
 
-| Field      | Description | Default |
-| ---------- | ----------- | ------- |
-| hideSelect | —           | —       |
-| options    | —           | —       |
-| value      | —           | —       |
-| onChange   | —           | —       |
-| onSearch   | —           | —       |
+| Field       | Description | Default |
+| ----------- | ----------- | ------- |
+| showSelect  | —           | —       |
+| options     | —           | —       |
+| placeholder | —           | —       |
+| value       | —           | —       |
+| onChange    | —           | —       |
+| onSearch    | —           | —       |
 
 ## Usage
 
 ```tsx
 import { SearchBar } from '@ceed/cds';
 
+// Basic
+<SearchBar value={query} onChange={setQuery} onSearch={({ inputValue }) => fetch(inputValue)} />
+
+// With category Select
 <SearchBar
-  value={query}
-  onChange={setQuery}
+  showSelect
   options={[
     { label: 'Account #', value: 'account', placeholder: 'e.g. 1234567' },
     { label: 'Jira Issue #', value: 'jira', placeholder: 'e.g. PROC-1234' },
   ]}
-  onSearch={({ selectValue, inputValue }) => console.log(selectValue, inputValue)}
+  value={query}
+  onChange={setQuery}
+  onSearch={({ selectValue, inputValue }) => fetch(selectValue, inputValue)}
 />
 ```
 
-## Without Select
+## With Select
 
-Use `hideSelect` to hide the category Select and render a narrower input-only layout.
+Use `showSelect` together with `options` to display a category Select to the left of the text input. The selected category is passed as `selectValue` in the `onSearch` callback.
 
 ```tsx
-<SearchBar hideSelect options={SAMPLE_OPTIONS} value={value} onChange={setValue} />
+<SearchBar showSelect options={SAMPLE_OPTIONS} value={value} onChange={setValue} />
+```
+
+## Clearable Input
+
+When the input has a value, hovering over the component reveals a clear (✕) button at the right of the text field. Clicking it calls `onChange('')` without triggering `onSearch`.
+
+```tsx
+<Stack alignItems="flex-start" gap={2}>
+    <Typography level="body-sm">Hover over the input to reveal the clear (✕) button.</Typography>
+    <SearchBar value={value} onChange={setValue} />
+  </Stack>
+```
+
+## Placeholder
+
+Each `SearchBarOption` can include a `placeholder` field that is shown in the text input while that category is selected. Pass a `placeholder` prop directly to override the option-level placeholder for all categories.
+
+```tsx
+<Stack alignItems="flex-start" gap={3}>
+    <Stack alignItems="flex-start" gap={1}>
+      <Typography level="body-xs" fontWeight="md">
+        No placeholder prop — uses the active option's placeholder
+      </Typography>
+      <SearchBar showSelect options={SAMPLE_OPTIONS} value={value} onChange={setValue} />
+    </Stack>
+    <Stack alignItems="flex-start" gap={1}>
+      <Typography level="body-xs" fontWeight="md">
+        placeholder="Search by keyword" — overrides option-level placeholder
+      </Typography>
+      <SearchBar
+        showSelect
+        options={SAMPLE_OPTIONS}
+        placeholder="Search by keyword"
+        value={value}
+        onChange={setValue}
+      />
+    </Stack>
+  </Stack>
 ```
 
 ## onSearch
 
-`onSearch` fires when the search button is clicked or the Enter key is pressed. It receives both the active `selectValue` (omitted when `hideSelect` is `true`) and the current `inputValue`.
+`onSearch` fires when the search button is clicked or the Enter key is pressed. It receives `inputValue` (always present) and `selectValue` (only present when `showSelect` is `true`).
 
 ```tsx
-<Stack gap={2}>
-  <SearchBar options={SAMPLE_OPTIONS} value={value} onChange={setValue} onSearch={setLastSearch} />
-  <Typography level="body-sm">value: "{value}"</Typography>
-  {lastSearch && <Typography level="body-sm">
-  onSearch: [{lastSearch.selectValue}] "{lastSearch.inputValue}"
-</Typography>}
-</Stack>
+<Stack alignItems="flex-start" gap={2}>
+    <SearchBar
+      showSelect
+      options={SAMPLE_OPTIONS}
+      value={value}
+      onChange={setValue}
+      onSearch={setLastSearch}
+    />
+    <Typography level="body-sm">value: "{value}"</Typography>
+    {lastSearch && (
+      <Typography level="body-sm">
+        onSearch: [{lastSearch.selectValue}] "{lastSearch.inputValue}"
+      </Typography>
+    )}
+  </Stack>
 ```
 
-## Props and Customization
+When `showSelect` is `false`, `selectValue` is omitted from the payload entirely — not `undefined` as a key, but absent.
+
+```tsx
+<Stack alignItems="flex-start" gap={2}>
+    <Typography level="body-sm">
+      When <code>showSelect</code> is <code>false</code>, <code>selectValue</code> is omitted from
+      the <code>onSearch</code> payload.
+    </Typography>
+    <SearchBar value={value} onChange={setValue} onSearch={setLastSearch} />
+    {lastSearch && (
+      <Stack alignItems="flex-start" gap={0.5}>
+        <Typography level="body-sm">inputValue: "{lastSearch.inputValue}"</Typography>
+        <Typography
+          level="body-sm"
+          sx={{
+            color: lastSearch.selectValue === undefined ? "success.500" : "danger.500"
+          }}
+        >
+          selectValue:{" "}
+          {lastSearch.selectValue === undefined ? "undefined ✅" : `"${lastSearch.selectValue}" ❌`}
+        </Typography>
+      </Stack>
+    )}
+  </Stack>
+```
 
-| Prop         | Type                                                             | Default | Description                                                                                                                                                                                            |
-| ------------ | ---------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `value`      | `string`                                                         | —       | Current text input value                                                                                                                                                                               |
-| `onChange`   | `(value: string) => void`                                        | —       | Called when the text input value changes                                                                                                                                                               |
-| `onSearch`   | `(params: { selectValue?: string; inputValue: string }) => void` | —       | Called on search button click or Enter key                                                                                                                                                             |
-| `hideSelect` | `boolean`                                                        | `false` | Hide the category Select and show a narrower input-only layout                                                                                                                                         |
-| `options`    | `SearchBarOption[]`                                              | —       | List of selectable categories rendered in the category Select. Each item may include a `placeholder` hint shown in the text input when that category is active. Required when `hideSelect` is `false`. |
+## Width
 
-> **Note**: Also accepts all standard HTML `div` attributes (`className`, `style`, `sx`, etc.).
+SearchBar sizes to its content by default. Pass any `Box` width prop to constrain or stretch it.
 
-### SearchBarOption
+```tsx
+<Stack alignItems="flex-start" gap={3}>
+    <Stack alignItems="flex-start" gap={1}>
+      <Typography level="body-xs" fontWeight="md">
+        width="100%" — stretches to parent width
+      </Typography>
+      <Box
+        sx={{
+          border: "1px dashed",
+          borderColor: "neutral.300",
+          padding: 1
+        }}
+      >
+        <SearchBar width="100%" value={value} onChange={setValue} />
+      </Box>
+    </Stack>
+    <Stack alignItems="flex-start" gap={1}>
+      <Typography level="body-xs" fontWeight="md">
+        width={400} — fixed 400px
+      </Typography>
+      <SearchBar width={400} value={value} onChange={setValue} />
+    </Stack>
+    <Stack alignItems="flex-start" gap={1}>
+      <Typography level="body-xs" fontWeight="md">
+        No width prop — sizes to content (inline-flex default)
+      </Typography>
+      <SearchBar value={value} onChange={setValue} />
+    </Stack>
+  </Stack>
+```
 
-Each element of the `options` array has the following shape:
+## Props and Customization
 
-| Field         | Type     | Required | Description                                                                                 |
-| ------------- | -------- | -------- | ------------------------------------------------------------------------------------------- |
-| `label`       | `string` | ✓        | Display text shown in the Select dropdown                                                   |
-| `value`       | `string` | ✓        | Internal identifier passed as `selectValue` in the `onSearch` callback                      |
-| `placeholder` | `string` | —        | Hint text shown in the text input while this category is selected (e.g. `"e.g. PROC-1234"`) |
+| Prop          | Type                                                             | Default | Description                                                                         |
+| ------------- | ---------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------- |
+| `value`       | `string`                                                         | —       | Current value of the text input. Required.                                          |
+| `onChange`    | `(value: string) => void`                                        | —       | Called when the text input value changes. Required.                                 |
+| `onSearch`    | `(params: { selectValue?: string; inputValue: string }) => void` | —       | Called on search button click or Enter key.                                         |
+| `showSelect`  | `boolean`                                                        | `false` | Show the category Select alongside the input.                                       |
+| `options`     | `SearchBarOption[]`                                              | —       | Category options for the Select. Required when `showSelect` is `true`.              |
+| `placeholder` | `string`                                                         | —       | Placeholder text for the input. Takes priority over the option-level `placeholder`. |
 
-### CSS Custom Properties
+> **Note**: Also accepts all `Box` props (`width`, `sx`, `className`, `style`, etc.).
 
-| Variable                 | Default                               | Description                                     |
-| ------------------------ | ------------------------------------- | ----------------------------------------------- |
-| `--ceed-SearchBar-width` | `300px` / `220px` (when `hideSelect`) | Component width; override per instance via `sx` |
+### SearchBarOption
 
-Override example: `<SearchBar sx={{ '--ceed-SearchBar-width': '400px' }} … />`
+| Field         | Type     | Required | Description                                                                                                                             |
+| ------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `label`       | `string` | ✓        | Display text shown in the Select dropdown.                                                                                              |
+| `value`       | `string` | ✓        | Identifier passed as `selectValue` in the `onSearch` callback.                                                                          |
+| `placeholder` | `string` | —        | Hint text shown in the input while this category is selected (e.g. `"e.g. PROC-1234"`). Overridden by the top-level `placeholder` prop. |
 
 ## Best Practices
 
-- Always provide meaningful `label` values in `options` — they are the primary affordance for selecting a search category.
-- Use `placeholder` on each option to show the expected format for that category rather than a generic hint.
-- Prefer `onSearch` over reacting to every `onChange` keystroke for server-side search to reduce unnecessary requests.
+- Always provide `options` when `showSelect` is `true` — the Select renders nothing if `options` is omitted.
+- Add a `placeholder` to each option to show the expected input format for that category.
+- Use the top-level `placeholder` prop only when a single hint applies regardless of category.
+- Prefer handling `onSearch` over `onChange` for server-side queries — fire the request once on explicit submission rather than on every keystroke.
 
 ## Accessibility
 
 - The search button has `aria-label="Search"` and the clear button has `aria-label="Clear"`.
-- The text input is a native `<input>` element and supports keyboard navigation; pressing Enter triggers `onSearch`.
+- The text input is a native `<input>` element; pressing Enter triggers `onSearch`.
+- The clear button uses `onMouseDown` with `e.preventDefault()` to prevent the input from losing focus when clicked.

package/dist/components/inputs/Select.md

@@ -54,13 +54,7 @@ const options = [
 ];
 
 function MyComponent() {
-  return (
-    <Select
-      label="Choose a pet"
-      options={options}
-      defaultValue="dog"
-    />
-  );
+  return <Select label="Choose a pet" options={options} defaultValue="dog" />;
 }
 ```
 
@@ -70,11 +64,11 @@ Select supports four visual styles: `outlined` (default), `plain`, `soft`, and `
 
 ```tsx
 <Stack spacing={4}>
-  <Select defaultValue="dog" options={options} />
-  <Select defaultValue="dog" variant="plain" options={options} />
-  <Select defaultValue="dog" variant="soft" options={options} />
-  <Select defaultValue="dog" variant="solid" options={options} />
-</Stack>
+    <Select defaultValue="dog" options={options} />
+    <Select defaultValue="dog" variant="plain" options={options} />
+    <Select defaultValue="dog" variant="soft" options={options} />
+    <Select defaultValue="dog" variant="solid" options={options} />
+  </Stack>
 ```
 
 ```tsx
@@ -90,10 +84,10 @@ Three sizes are available: `sm`, `md` (default), and `lg`.
 
 ```tsx
 <Stack spacing={4}>
-  <Select defaultValue="dog" size="sm" options={options} />
-  <Select defaultValue="dog" size="md" options={options} />
-  <Select defaultValue="dog" size="lg" options={options} />
-</Stack>
+    <Select defaultValue="dog" size="sm" options={options} />
+    <Select defaultValue="dog" size="md" options={options} />
+    <Select defaultValue="dog" size="lg" options={options} />
+  </Stack>
 ```
 
 ```tsx
@@ -108,12 +102,12 @@ Apply semantic colors to communicate intent or state.
 
 ```tsx
 <Stack spacing={4}>
-  <Select defaultValue="dog" color="primary" options={options} />
-  <Select defaultValue="dog" color="neutral" options={options} />
-  <Select defaultValue="dog" color="success" options={options} />
-  <Select defaultValue="dog" color="danger" options={options} />
-  <Select defaultValue="dog" color="warning" options={options} />
-</Stack>
+    <Select defaultValue="dog" color="primary" options={options} />
+    <Select defaultValue="dog" color="neutral" options={options} />
+    <Select defaultValue="dog" color="success" options={options} />
+    <Select defaultValue="dog" color="danger" options={options} />
+    <Select defaultValue="dog" color="warning" options={options} />
+  </Stack>
 ```
 
 ```tsx
@@ -129,11 +123,19 @@ Apply semantic colors to communicate intent or state.
 Use `startDecorator` and `endDecorator` to add icons, badges, or other elements beside the select trigger.
 
 ```tsx
-<Select placeholder="Select a pet…" startDecorator={<FavoriteBorder />} endDecorator={<Chip size="sm" color="danger" variant="soft">
-  +5
-</Chip>} sx={{
-width: 240
-}} options={options} />
+<Select
+    placeholder="Select a pet…"
+    startDecorator={<FavoriteBorder />}
+    endDecorator={
+      <Chip size="sm" color="danger" variant="soft">
+        +5
+      </Chip>
+    }
+    sx={{
+      width: 240
+    }}
+    options={options}
+  />
 ```
 
 ```tsx
@@ -144,11 +146,13 @@ import { Chip } from '@ceed/cds';
   placeholder="Select a pet..."
   startDecorator={<FavoriteBorder />}
   endDecorator={
-    <Chip size="sm" color="danger" variant="soft">+5</Chip>
+    <Chip size="sm" color="danger" variant="soft">
+      +5
+    </Chip>
   }
   options={options}
   sx={{ width: 240 }}
-/>
+/>;
 ```
 
 ## Label and Helper Text
@@ -157,14 +161,14 @@ The `label` prop renders a form label above the select. The `helperText` prop re
 
 ```tsx
 <>
-  <Select label="Label" defaultValue="dog" options={options} />
-</>
+    <Select label="Label" defaultValue="dog" options={options} />
+  </>
 ```
 
 ```tsx
 <>
-  <Select label="Select" helperText="I'm helper text" defaultValue="dog" options={options} />
-</>
+    <Select label="Select" helperText="I'm helper text" defaultValue="dog" options={options} />
+  </>
 ```
 
 ```tsx
@@ -184,17 +188,12 @@ Set `error` to `true` to visually indicate a validation error. Combine with `hel
 
 ```tsx
 <>
-  <Select label="label" error defaultValue="dog" options={options} />
-</>
+    <Select label="label" error defaultValue="dog" options={options} />
+  </>
 ```
 
 ```tsx
-<Select
-  label="Pet"
-  error
-  helperText="This field is required"
-  options={options}
-/>
+<Select label="Pet" error helperText="This field is required" options={options} />
 ```
 
 ## Form Control
@@ -203,9 +202,9 @@ Combining `label`, `helperText`, and `error` produces a complete form field. Her
 
 ```tsx
 <>
-  <Select label="Label" helperText="I'm helper text" defaultValue="dog" options={options} />
-  <Select label="Label" helperText="I'm helper text" defaultValue="dog" error options={options} />
-</>
+    <Select label="Label" helperText="I'm helper text" defaultValue="dog" options={options} />
+    <Select label="Label" helperText="I'm helper text" defaultValue="dog" error options={options} />
+  </>
 ```
 
 ## Required Field
@@ -222,12 +221,7 @@ Set `required` to mark the field as required. An asterisk is added to the label
 ```
 
 ```tsx
-<Select
-  label="Pet"
-  helperText="This field is required"
-  required
-  options={options}
-/>
+<Select label="Pet" helperText="This field is required" required options={options} />
 ```
 
 ## Multiple Selection
@@ -245,12 +239,7 @@ Set `multiple` to allow selecting more than one option. The value becomes an arr
 ```
 
 ```tsx
-<Select
-  label="Pets"
-  multiple
-  defaultValue={['dog']}
-  options={options}
-/>
+<Select label="Pets" multiple defaultValue={['dog']} options={options} />
 ```
 
 ## Controlled Select
@@ -259,30 +248,41 @@ Use the `value` and `onChange` props for controlled behavior when you need to sy
 
 ```tsx
 <div>
-  <Select {...args} options={options} value={value} onChange={(event, newValue) => {
-    setValue(newValue);
-    args.onChange?.(event, newValue);
-  }} />
-  <Select {...args} options={['dog', 'cat', 'fish', 'bird'] as string[]} value={value} onChange={(event, newValue) => {
-    setValue(newValue);
-    args.onChange?.(event, newValue);
-  }} />
-  <Select {...args} options={['dog', 'cat', 'fish', 'bird'] as string[]} value={[value]} onChange={(event, newValue) => {
-    setValue(newValue);
-    args.onChange?.(event, newValue);
-  }} multiple />
-</div>
+    <Select
+      {...args}
+      options={options}
+      value={value}
+      onChange={(event, newValue) => {
+        setValue(newValue);
+        args.onChange?.(event, newValue);
+      }}
+    />
+    <Select
+      {...args}
+      options={["dog", "cat", "fish", "bird"] as string[]}
+      value={value}
+      onChange={(event, newValue) => {
+        setValue(newValue);
+        args.onChange?.(event, newValue);
+      }}
+    />
+    <Select
+      {...args}
+      options={["dog", "cat", "fish", "bird"] as string[]}
+      value={[value]}
+      onChange={(event, newValue) => {
+        setValue(newValue);
+        args.onChange?.(event, newValue);
+      }}
+      multiple
+    />
+  </div>
 ```
 
 ```tsx
 const [value, setValue] = useState('dog');
 
-<Select
-  label="Pet"
-  value={value}
-  onChange={(event, newValue) => setValue(newValue)}
-  options={options}
-/>
+<Select label="Pet" value={value} onChange={(event, newValue) => setValue(newValue)} options={options} />;
 ```
 
 ## Disabled Options
@@ -308,7 +308,7 @@ const options = [
   { value: 'bird', label: 'Bird' },
 ];
 
-<Select label="Pet" options={options} defaultValue="dog" />
+<Select label="Pet" options={options} defaultValue="dog" />;
 ```
 
 ## Options with Secondary Text
@@ -317,16 +317,27 @@ Add a `secondaryText` field to display supplementary information below each opti
 
 ```tsx
 <Stack spacing={4} direction="row" alignItems="flex-start">
-  {sizes.map(size => <Stack key={size} spacing={1}>
-  <span style={{
-    color: '#6366f1',
-    fontSize: 12
-  }}>{size}</span>
-  <Select placeholder="Placeholder" options={optionsWithSecondaryText} sx={{
-    minWidth: 200
-  }} size={size} />
-</Stack>)}
-</Stack>
+    {sizes.map((size) => (
+      <Stack key={size} spacing={1}>
+        <span
+          style={{
+            color: "#6366f1",
+            fontSize: 12
+          }}
+        >
+          {size}
+        </span>
+        <Select
+          placeholder="Placeholder"
+          options={optionsWithSecondaryText}
+          sx={{
+            minWidth: 200
+          }}
+          size={size}
+        />
+      </Stack>
+    ))}
+  </Stack>
 ```
 
 ```tsx
@@ -336,7 +347,7 @@ const userOptions = [
   { value: 'sophia', label: 'Sophia Martinez', secondaryText: '(646) 555-0734' },
 ];
 
-<Select placeholder="Select a contact" options={userOptions} />
+<Select placeholder="Select a contact" options={userOptions} />;
 ```
 
 ## Numeric Values
@@ -345,11 +356,11 @@ Select supports both string and numeric option values. When using numeric values
 
 ```tsx
 <Stack spacing={4}>
-  <Select defaultValue={1} options={numericOptions} />
-  <Select defaultValue={1} variant="plain" options={numericOptions} />
-  <Select defaultValue={1} variant="soft" options={numericOptions} />
-  <Select defaultValue={1} variant="solid" options={numericOptions} />
-</Stack>
+    <Select defaultValue={1} options={numericOptions} />
+    <Select defaultValue={1} variant="plain" options={numericOptions} />
+    <Select defaultValue={1} variant="soft" options={numericOptions} />
+    <Select defaultValue={1} variant="solid" options={numericOptions} />
+  </Stack>
 ```
 
 ```tsx
@@ -359,7 +370,7 @@ const numericOptions = [
   { value: 3, label: 'Option 3' },
 ];
 
-<Select options={numericOptions} defaultValue={1} />
+<Select options={numericOptions} defaultValue={1} />;
 ```
 
 ## Common Use Cases
@@ -590,12 +601,12 @@ const options = [
   { value: 2, label: 'Option 2' },
 ] as const;
 
-<Select<typeof options[number], false>
+<Select<(typeof options)[number], false>
   options={options}
   onChange={(e, val) => {
     // val is typed as number
   }}
-/>
+/>;
 ```
 
 > **Note**: Select also accepts all Joy UI Select props.