Component
Select With Leading Icon
Custom select with a meaningful leading icon inside the trigger.
- Component
- React
- TSX
- Tailwind CSS
- MIT
What it does
Capabilities
- Semantic HTML
- ARIA
- Associated labels
Preview
Live component
9:41 100%
devsnips.site/library/react/components/selects/select-with-leading-icon/ fluid · no fixed width 100%
Install
Add to your project
npx devsnips add React/Components/Selects/select-with-leading-icon React/Components/Selects/select-with-leading-icon import type { KeyboardEvent, ReactNode, RefObject } from "react";
import { useEffect, useId, useRef, useState } from "react";
export type SelectSize = "sm" | "md" | "lg";
export interface SelectOption {
value: string;
label: string;
disabled?: boolean;
}
export interface SelectWithLeadingIconProps {
label?: string;
helperText?: string;
error?: string;
success?: string;
options: SelectOption[];
value?: string;
defaultValue?: string;
onChange?: (value: string, option: SelectOption) => void;
size?: SelectSize;
placeholder?: string;
leadingIcon?: ReactNode;
id?: string;
name?: string;
className?: string;
}
function cx(...parts: Array<string | false | null | undefined>): string {
return parts.filter(Boolean).join(" ");
}
const SIZES: Record<SelectSize, string> = {
sm: "h-8 text-[13px] [&_svg]:size-[14px]",
md: "h-9 text-sm [&_svg]:size-4",
lg: "h-11 text-sm [&_svg]:size-[18px]",
};
function ChevronDown({ className }: { className?: string }) {
return (
<svg className={className} viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={1.75} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
<path d="m6 9 6 6 6-6" />
</svg>
);
}
function DefaultSearchIcon() {
return (
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={1.75} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true" className="size-4">
<circle cx={11} cy={11} r={8} />
<path d="m21 21-4.3-4.3" />
</svg>
);
}
/**
* Accessible custom select with a leading icon slot inside the trigger. The
* `leadingIcon` ReactNode is rendered absolutely at `left-3`; the trigger gets
* `pl-9` to make room. The icon is decorative — it carries `aria-hidden` so
* it is excluded from the a11y tree. Implements the full WAI-ARIA combobox /
* listbox pattern: trigger button with `aria-haspopup="listbox"`,
* `aria-expanded`, `aria-controls`, `aria-activedescendant`; panel with
* `role="listbox"` of `role="option"` rows carrying `aria-selected`. Keyboard:
* ArrowUp/Down/Home/End/Enter/Space/Escape/Tab. Outside-click + Escape close.
* Controlled (value/onChange) and uncontrolled (defaultValue) both supported.
*/
export function SelectWithLeadingIcon({
label = "Select",
helperText,
error,
success,
options,
value,
defaultValue = "",
onChange,
size = "md",
placeholder = "Select an option",
leadingIcon,
id,
name,
className,
}: SelectWithLeadingIconProps) {
const generatedId = useId();
const triggerId = id ?? `select-${generatedId}`;
const listboxId = `${triggerId}-listbox`;
const messageId = `${triggerId}-message`;
const message = error ?? success ?? helperText;
const [internalValue, setInternalValue] = useState(defaultValue);
const selectedValue = value ?? internalValue;
const selected = options.find((o) => o.value === selectedValue) ?? null;
const [open, setOpen] = useState(false);
const [activeIndex, setActiveIndex] = useState(() => {
const enabled = options.findIndex((o) => !o.disabled);
return enabled === -1 ? 0 : enabled;
});
const triggerRef = useRef<HTMLButtonElement>(null);
const listboxRef = useRef<HTMLDivElement>(null);
const icon = leadingIcon !== undefined && leadingIcon !== null ? leadingIcon : <DefaultSearchIcon />;
function openListbox(nextActive?: number) {
setOpen(true);
const cur = selected ? options.indexOf(selected) : -1;
const fallback = options.findIndex((o) => !o.disabled);
const start = nextActive ?? (cur >= 0 ? cur : fallback);
setActiveIndex(Math.max(0, Math.min(options.length - 1, start < 0 ? 0 : start)));
}
function choose(option: SelectOption) {
if (option.disabled) return;
if (value === undefined) setInternalValue(option.value);
onChange?.(option.value, option);
setOpen(false);
triggerRef.current?.focus();
}
function moveActive(step: number) {
setActiveIndex((cur) => {
let next = cur;
for (let i = 0; i < options.length; i++) {
next = (next + step + options.length) % options.length;
if (!options[next].disabled) return next;
}
return cur;
});
}
function onKeyDown(event: KeyboardEvent<HTMLButtonElement>) {
switch (event.key) {
case "ArrowDown":
event.preventDefault();
if (!open) openListbox();
else moveActive(1);
break;
case "ArrowUp":
event.preventDefault();
if (!open) openListbox(options.length - 1);
else moveActive(-1);
break;
case "Home":
if (open) { event.preventDefault(); for (let i = 0; i < options.length; i++) if (!options[i].disabled) { setActiveIndex(i); break; } }
break;
case "End":
if (open) { event.preventDefault(); for (let i = options.length - 1; i >= 0; i--) if (!options[i].disabled) { setActiveIndex(i); break; } }
break;
case "Enter":
case " ":
case "Spacebar":
event.preventDefault();
if (open) choose(options[activeIndex]);
else openListbox();
break;
case "Escape":
if (open) { event.preventDefault(); setOpen(false); }
break;
case "Tab":
if (open) setOpen(false);
break;
}
}
const selectedIndex = selected ? options.indexOf(selected) : -1;
return (
<div className="w-full">
<label htmlFor={triggerId} className="mb-2 block text-[13px] font-medium leading-5 text-[var(--ds-color-foreground)]">
{label}
</label>
{message ? (
<p id={messageId} className={cx("mb-2 text-xs", error ? "text-[var(--ds-color-destructive)]" : success ? "text-[var(--ds-color-success)]" : "text-[var(--ds-color-muted-foreground)]")}>
{error ? `Error: ${error}` : success ? `Success: ${success}` : helperText}
</p>
) : null}
<div className="relative">
{name ? <input type="hidden" name={name} value={selectedValue} readOnly /> : null}
<button
ref={triggerRef}
id={triggerId}
type="button"
aria-haspopup="listbox"
aria-expanded={open}
aria-controls={open ? listboxId : undefined}
aria-activedescendant={open ? `${triggerId}-opt-${activeIndex}` : undefined}
aria-invalid={error ? true : undefined}
aria-describedby={message ? messageId : undefined}
onClick={() => (open ? setOpen(false) : openListbox())}
onKeyDown={onKeyDown}
className={cx(
"inline-flex w-full items-center justify-between gap-2 rounded-[var(--ds-radius-sm)] border bg-[var(--ds-color-input)] pl-9 pr-3 text-left text-[var(--ds-color-foreground)] transition-colors duration-150 ease-out hover:bg-[var(--ds-color-input-hover,var(--ds-color-input))] focus:bg-[var(--ds-color-input-focus,var(--ds-color-input))] focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] motion-reduce:transition-none",
error ? "border-[var(--ds-color-destructive)]" : success ? "border-[var(--ds-color-success)]" : "border-[var(--ds-color-border)] focus:border-[var(--ds-color-border-strong)]",
SIZES[size],
className,
)}
>
<span className="pointer-events-none absolute left-3 flex items-center text-[var(--ds-color-muted-foreground)] [&_svg]:size-4" aria-hidden="true">
{icon}
</span>
<span className={cx("flex-1 truncate", !selected && "text-[var(--ds-color-muted-foreground)]")}>
{selected ? selected.label : placeholder}
</span>
<ChevronDown className={cx("shrink-0 text-[var(--ds-color-muted-foreground)] transition-transform duration-150 motion-reduce:transition-none", open && "rotate-180")} />
</button>
{open ? (
<ListboxPanel
ref={listboxRef}
id={listboxId}
labelledby={triggerId}
options={options}
activeIndex={activeIndex}
selectedIndex={selectedIndex}
triggerId={triggerId}
onChoose={choose}
onHover={setActiveIndex}
onOutside={() => setOpen(false)}
/>
) : null}
</div>
</div>
);
}
export default SelectWithLeadingIcon;
function ListboxPanel({
ref,
id,
labelledby,
options,
activeIndex,
selectedIndex,
triggerId,
onChoose,
onHover,
onOutside,
}: {
ref: RefObject<HTMLDivElement>;
id: string;
labelledby: string;
options: SelectOption[];
activeIndex: number;
selectedIndex: number;
triggerId: string;
onChoose: (o: SelectOption) => void;
onHover: (i: number) => void;
onOutside: () => void;
}) {
useEffect(() => {
function onDown(e: MouseEvent) {
if (ref.current && !ref.current.contains(e.target as Node)) onOutside();
}
document.addEventListener("mousedown", onDown);
return () => document.removeEventListener("mousedown", onDown);
}, [onOutside, ref]);
useEffect(() => {
const el = ref.current?.querySelector(`[data-i="${activeIndex}"]`);
el?.scrollIntoView({ block: "nearest" });
}, [activeIndex, ref]);
return (
<div
ref={ref}
id={id}
role="listbox"
aria-labelledby={labelledby}
className="absolute z-20 mt-1.5 max-h-60 w-full overflow-auto rounded-[var(--ds-radius-md)] border border-[var(--ds-color-border)] bg-[var(--ds-color-surface-elevated)] p-1 shadow-[var(--ds-shadow-md)]"
>
{options.map((option, i) => (
<button
key={option.value}
id={`${triggerId}-opt-${i}`}
type="button"
data-i={i}
role="option"
aria-selected={i === selectedIndex}
aria-disabled={option.disabled || undefined}
disabled={option.disabled}
onMouseEnter={() => onHover(i)}
onClick={() => onChoose(option)}
className={cx(
"flex w-full items-center justify-between gap-2 rounded-[var(--ds-radius-sm)] px-2.5 py-1.5 text-left text-[13px] text-[var(--ds-color-foreground)] transition-colors motion-reduce:transition-none focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)]",
i === activeIndex ? "bg-[var(--ds-color-surface-hover)]" : "",
i === selectedIndex ? "font-medium" : "",
option.disabled ? "cursor-not-allowed text-[var(--ds-color-muted-foreground)] opacity-60" : "",
)}
>
<span className="truncate">{option.label}</span>
{i === selectedIndex ? (
<svg className="shrink-0 text-[var(--ds-color-primary)]" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={2} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
<path d="M20 6 9 17l-5-5" />
</svg>
) : null}
</button>
))}
</div>
);
} /* DevSnips React — JavaScript parity build.
* Same API, behavior, and classes as code.tsx; TypeScript types removed.
* Regenerated from code.tsx — edit code.tsx and re-run the generator.
*/
import { useEffect, useId, useRef, useState } from "react";
function cx(...parts) {
return parts.filter(Boolean).join(" ");
}
const SIZES = {
sm: "h-8 text-[13px] [&_svg]:size-[14px]",
md: "h-9 text-sm [&_svg]:size-4",
lg: "h-11 text-sm [&_svg]:size-[18px]"
};
function ChevronDown({ className }) {
return <svg className={className} viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={1.75} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
<path d="m6 9 6 6 6-6" />
</svg>;
}
function DefaultSearchIcon() {
return <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={1.75} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true" className="size-4">
<circle cx={11} cy={11} r={8} />
<path d="m21 21-4.3-4.3" />
</svg>;
}
export function SelectWithLeadingIcon({
label = "Select",
helperText,
error,
success,
options,
value,
defaultValue = "",
onChange,
size = "md",
placeholder = "Select an option",
leadingIcon,
id,
name,
className
}) {
const generatedId = useId();
const triggerId = id ?? `select-${generatedId}`;
const listboxId = `${triggerId}-listbox`;
const messageId = `${triggerId}-message`;
const message = error ?? success ?? helperText;
const [internalValue, setInternalValue] = useState(defaultValue);
const selectedValue = value ?? internalValue;
const selected = options.find((o) => o.value === selectedValue) ?? null;
const [open, setOpen] = useState(false);
const [activeIndex, setActiveIndex] = useState(() => {
const enabled = options.findIndex((o) => !o.disabled);
return enabled === -1 ? 0 : enabled;
});
const triggerRef = useRef(null);
const listboxRef = useRef(null);
const icon = leadingIcon !== undefined && leadingIcon !== null ? leadingIcon : <DefaultSearchIcon />;
function openListbox(nextActive) {
setOpen(true);
const cur = selected ? options.indexOf(selected) : -1;
const fallback = options.findIndex((o) => !o.disabled);
const start = nextActive ?? (cur >= 0 ? cur : fallback);
setActiveIndex(Math.max(0, Math.min(options.length - 1, start < 0 ? 0 : start)));
}
function choose(option) {
if (option.disabled) return;
if (value === undefined) setInternalValue(option.value);
onChange?.(option.value, option);
setOpen(false);
triggerRef.current?.focus();
}
function moveActive(step) {
setActiveIndex((cur) => {
let next = cur;
for (let i = 0; i < options.length; i++) {
next = (next + step + options.length) % options.length;
if (!options[next].disabled) return next;
}
return cur;
});
}
function onKeyDown(event) {
switch (event.key) {
case "ArrowDown":
event.preventDefault();
if (!open) openListbox();
else moveActive(1);
break;
case "ArrowUp":
event.preventDefault();
if (!open) openListbox(options.length - 1);
else moveActive(-1);
break;
case "Home":
if (open) {
event.preventDefault();
for (let i = 0; i < options.length; i++) if (!options[i].disabled) {
setActiveIndex(i);
break;
}
}
break;
case "End":
if (open) {
event.preventDefault();
for (let i = options.length - 1; i >= 0; i--) if (!options[i].disabled) {
setActiveIndex(i);
break;
}
}
break;
case "Enter":
case " ":
case "Spacebar":
event.preventDefault();
if (open) choose(options[activeIndex]);
else openListbox();
break;
case "Escape":
if (open) {
event.preventDefault();
setOpen(false);
}
break;
case "Tab":
if (open) setOpen(false);
break;
}
}
const selectedIndex = selected ? options.indexOf(selected) : -1;
return <div className="w-full">
<label htmlFor={triggerId} className="mb-2 block text-[13px] font-medium leading-5 text-[var(--ds-color-foreground)]">
{label}
</label>
{message ? <p id={messageId} className={cx("mb-2 text-xs", error ? "text-[var(--ds-color-destructive)]" : success ? "text-[var(--ds-color-success)]" : "text-[var(--ds-color-muted-foreground)]")}>
{error ? `Error: ${error}` : success ? `Success: ${success}` : helperText}
</p> : null}
<div className="relative">
{name ? <input type="hidden" name={name} value={selectedValue} readOnly /> : null}
<button
ref={triggerRef}
id={triggerId}
type="button"
aria-haspopup="listbox"
aria-expanded={open}
aria-controls={open ? listboxId : undefined}
aria-activedescendant={open ? `${triggerId}-opt-${activeIndex}` : undefined}
aria-invalid={error ? true : undefined}
aria-describedby={message ? messageId : undefined}
onClick={() => open ? setOpen(false) : openListbox()}
onKeyDown={onKeyDown}
className={cx(
"inline-flex w-full items-center justify-between gap-2 rounded-[var(--ds-radius-sm)] border bg-[var(--ds-color-input)] pl-9 pr-3 text-left text-[var(--ds-color-foreground)] transition-colors duration-150 ease-out hover:bg-[var(--ds-color-input-hover,var(--ds-color-input))] focus:bg-[var(--ds-color-input-focus,var(--ds-color-input))] focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] motion-reduce:transition-none",
error ? "border-[var(--ds-color-destructive)]" : success ? "border-[var(--ds-color-success)]" : "border-[var(--ds-color-border)] focus:border-[var(--ds-color-border-strong)]",
SIZES[size],
className
)}
>
<span className="pointer-events-none absolute left-3 flex items-center text-[var(--ds-color-muted-foreground)] [&_svg]:size-4" aria-hidden="true">
{icon}
</span>
<span className={cx("flex-1 truncate", !selected && "text-[var(--ds-color-muted-foreground)]")}>
{selected ? selected.label : placeholder}
</span>
<ChevronDown className={cx("shrink-0 text-[var(--ds-color-muted-foreground)] transition-transform duration-150 motion-reduce:transition-none", open && "rotate-180")} />
</button>
{open ? <ListboxPanel
ref={listboxRef}
id={listboxId}
labelledby={triggerId}
options={options}
activeIndex={activeIndex}
selectedIndex={selectedIndex}
triggerId={triggerId}
onChoose={choose}
onHover={setActiveIndex}
onOutside={() => setOpen(false)}
/> : null}
</div>
</div>;
}
function ListboxPanel({
ref,
id,
labelledby,
options,
activeIndex,
selectedIndex,
triggerId,
onChoose,
onHover,
onOutside
}) {
useEffect(() => {
function onDown(e) {
if (ref.current && !ref.current.contains(e.target)) onOutside();
}
document.addEventListener("mousedown", onDown);
return () => document.removeEventListener("mousedown", onDown);
}, [onOutside, ref]);
useEffect(() => {
const el = ref.current?.querySelector(`[data-i="${activeIndex}"]`);
el?.scrollIntoView({ block: "nearest" });
}, [activeIndex, ref]);
return <div
ref={ref}
id={id}
role="listbox"
aria-labelledby={labelledby}
className="absolute z-20 mt-1.5 max-h-60 w-full overflow-auto rounded-[var(--ds-radius-md)] border border-[var(--ds-color-border)] bg-[var(--ds-color-surface-elevated)] p-1 shadow-[var(--ds-shadow-md)]"
>
{options.map((option, i) => <button
key={option.value}
id={`${triggerId}-opt-${i}`}
type="button"
data-i={i}
role="option"
aria-selected={i === selectedIndex}
aria-disabled={option.disabled || undefined}
disabled={option.disabled}
onMouseEnter={() => onHover(i)}
onClick={() => onChoose(option)}
className={cx(
"flex w-full items-center justify-between gap-2 rounded-[var(--ds-radius-sm)] px-2.5 py-1.5 text-left text-[13px] text-[var(--ds-color-foreground)] transition-colors motion-reduce:transition-none focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)]",
i === activeIndex ? "bg-[var(--ds-color-surface-hover)]" : "",
i === selectedIndex ? "font-medium" : "",
option.disabled ? "cursor-not-allowed text-[var(--ds-color-muted-foreground)] opacity-60" : ""
)}
>
<span className="truncate">{option.label}</span>
{i === selectedIndex ? <svg className="shrink-0 text-[var(--ds-color-primary)]" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={2} strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
<path d="M20 6 9 17l-5-5" />
</svg> : null}
</button>)}
</div>;
}
export default SelectWithLeadingIcon; # Select With Leading Icon
Custom select with a meaningful leading icon inside the trigger.
## Usage
```tsx
import { SelectWithLeadingIcon } from './code';
<SelectWithLeadingIcon label="Repository" leadingIcon={<SearchIcon/>} options={opts} />
```
## JavaScript
A `code.jsx` build is provided for projects that ship plain JSX. It exposes the same API and behavior as `code.tsx` — only the TypeScript types are removed.
```jsx
import { SelectWithLeadingIcon } from './code';
<SelectWithLeadingIcon label="Repository" leadingIcon={<SearchIcon/>} options={opts} />
```
## Props
| Name | Type | Default | Description |
|---|---|---:|---|
| `leadingIcon` | `ReactNode` | — | Icon rendered at the trigger left. |
| `label` / `options` / `value` / `defaultValue` / `onChange` / `size` / `placeholder` | — | — | As reference. |
## Behavior
Reference combobox/listbox behavior. The leading icon is decorative (`aria-hidden`) and shifts the trigger content with `pl-9`.
## Accessibility
Leading icon is `aria-hidden`; the trigger remains fully labeled and keyboard-operable.
## Styling
Built with React, Tailwind CSS, and DevSnips design tokens. The component consumes the `--ds-*` semantic tokens via arbitrary values (for example `bg-[var(--ds-color-input)]`). Define the tokens once in your theme — no component-specific CSS file is required.
## Design Tokens
See [React/DESIGN_TOKENS.md](../../../DESIGN_TOKENS.md) for the authoritative token specification. This select uses the semantic color, radius, spacing, and motion tokens.
## Notes
Use a leading icon only when it adds meaning (e.g. a search icon for a filterable context). Avoid decorative icons. 299 lines UTF-8 · LF · Spaces: 2
DevSnips AI ready Claude · Cursor · Windsurf
Agent skill & Model Context Protocol
Pass this component straight into your AI workflow. DevSnips exposes each resource as a structured, addressable registry entry, so your agent installs the real files instead of approximating them.
devsnips://components/selects/select-with-leading-icon I want to use this DevSnips resource in production: Page: https://devsnips.site/library/react/components/selects/select-with-leading-icon/ Install: npx devsnips add React/Components/Selects/select-with-leading-icon This is the Select With Leading Icon — Custom select with a meaningful leading icon inside the trigger. Use this DevSnips resource as the starting point for my project. Adapt it to my project's stack and conventions, fix any issues, and make it production-ready while preserving its intended design and behavior.
Paste into ChatGPT, Claude or your agent — it already carries the page URL and the exact install path.
Resource URI
devsnips://components/selects/select-with-leading-icon