Component

Creatable Select

Combobox that lets users create a new option when no match exists.

  • Component
  • React
  • TSX
  • Tailwind CSS
  • MIT

What it does

Capabilities

  • Semantic HTML
  • ARIA
  • Associated labels

Preview

Live component

Interactive preview
Open preview
9:41 100%
devsnips.site/library/react/components/selects/creatable-select/
fluid · no fixed width 100%
No dependencies Responsive · Light/dark · Focus-visible

Install

Add to your project

terminal
npx devsnips add React/Components/Selects/creatable-select
registry path: React/Components/Selects/creatable-select

Source

Implementation

code.tsx
import type { KeyboardEvent, RefObject } from "react";
import { useEffect, useId, useRef, useState } from "react";

export type SelectSize = "sm" | "md" | "lg";

export interface CreatableOption {
  value: string;
  label: string;
  disabled?: boolean;
}

export interface CreatableSelectProps {
  label?: string;
  options: CreatableOption[];
  value?: string;
  defaultValue?: string;
  onChange?: (value: string, option: CreatableOption) => void;
  onCreateOption?: (value: string) => void;
  size?: SelectSize;
  placeholder?: string;
  searchPlaceholder?: string;
  createLabel?: string;
  disabled?: boolean;
  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 CheckIcon({ className }: { className?: string }) {
  return (
    <svg className={className} 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>
  );
}

function SearchIcon({ 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">
      <circle cx="11" cy="11" r="7" />
      <path d="m21 21-4.3-4.3" />
    </svg>
  );
}

function PlusIcon({ 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="M12 5v14M5 12h14" />
    </svg>
  );
}

/**
 * Creatable combobox. Trigger opens a panel with a search input and a filtered
 * list of options below. Typing filters options by label (case-insensitive
 * substring). When the query is non-empty and no existing option is an exact
 * (case-insensitive) match for it, a "Create \"<query>\"" row is rendered at
 * the top of the list; choosing it calls onCreateOption(query), appends the new
 * option, and selects it. Keyboard: ArrowDown/Up moves active (skips the
 * create row when navigating with arrows — Enter on the create row creates),
 * Enter selects, Escape closes + clears the query. Outside-click closes.
 *
 * ARIA: trigger `aria-haspopup="listbox" aria-expanded aria-controls`; the
 * search input is `role="combobox" aria-autocomplete="list"` with
 * `aria-activedescendant`; listbox `role="listbox"`, options `role="option"
 * aria-selected`. Controlled (value/onChange) + uncontrolled (defaultValue).
 */
export function CreatableSelect({
  label = "Select",
  options,
  value,
  defaultValue = "",
  onChange,
  onCreateOption,
  size = "md",
  placeholder = "Select an option",
  searchPlaceholder = "Search options",
  createLabel = "Create",
  disabled,
  id,
  name,
  className,
}: CreatableSelectProps) {
  const generatedId = useId();
  const triggerId = id ?? `creatable-select-${generatedId}`;
  const listboxId = `${triggerId}-listbox`;
  const comboboxId = `${triggerId}-combobox`;

  const [created, setCreated] = useState<CreatableOption[]>([]);
  const allOptions = [...created, ...options];

  const [internalValue, setInternalValue] = useState(defaultValue);
  const selectedValue = value ?? internalValue;
  const selected = allOptions.find((o) => o.value === selectedValue) ?? null;

  const [open, setOpen] = useState(false);
  const [query, setQuery] = useState("");
  const [activeIndex, setActiveIndex] = useState(0);
  const triggerRef = useRef<HTMLButtonElement>(null);
  const inputRef = useRef<HTMLInputElement>(null);
  const listboxRef = useRef<HTMLDivElement>(null);

  const normalized = query.trim().toLowerCase();
  const trimmed = query.trim();
  const filtered = normalized === ""
    ? allOptions
    : allOptions.filter((o) => o.label.toLowerCase().includes(normalized));

  const exactMatch = normalized !== "" &&
    allOptions.some((o) => o.label.toLowerCase() === normalized || o.value.toLowerCase() === normalized);
  const canCreate = trimmed !== "" && !exactMatch;

  // The listbox rows: optional create row at index 0, then the filtered options.
  const rowCount = filtered.length + (canCreate ? 1 : 0);

  useEffect(() => {
    if (!open) return;
    setActiveIndex(canCreate ? 0 : 0);
    // Place active on the create row when available, else the first enabled row.
  }, [open, query, canCreate]);

  function openPanel() {
    setOpen(true);
    setQuery("");
  }

  function closePanel() {
    setOpen(false);
    setQuery("");
    triggerRef.current?.focus();
  }

  function chooseOption(option: CreatableOption) {
    if (option.disabled) return;
    if (value === undefined) setInternalValue(option.value);
    onChange?.(option.value, option);
    closePanel();
  }

  function createOption() {
    const text = trimmed;
    if (text === "") return;
    const newOption: CreatableOption = { value: text, label: text };
    setCreated((prev) => [...prev, newOption]);
    if (value === undefined) setInternalValue(newOption.value);
    onCreateOption?.(text);
    onChange?.(newOption.value, newOption);
    closePanel();
  }

  function chooseRow(index: number) {
    if (canCreate && index === 0) {
      createOption();
      return;
    }
    const optIndex = canCreate ? index - 1 : index;
    const option = filtered[optIndex];
    if (option) chooseOption(option);
  }

  function moveActive(step: number) {
    setActiveIndex((cur) => {
      if (rowCount === 0) return cur;
      let next = cur;
      for (let i = 0; i < rowCount; i++) {
        next = (next + step + rowCount) % rowCount;
        // Skip disabled options (the create row is never disabled).
        if (canCreate && next === 0) return next;
        const optIndex = canCreate ? next - 1 : next;
        const option = filtered[optIndex];
        if (option && !option.disabled) return next;
      }
      return cur;
    });
  }

  function jumpTo(edge: "first" | "last") {
    if (rowCount === 0) return;
    if (edge === "first") {
      if (canCreate) {
        setActiveIndex(0);
        return;
      }
      const hit = filtered.findIndex((o) => !o.disabled);
      if (hit !== -1) setActiveIndex(hit);
      return;
    }
    // last: scan from the end for an enabled option.
    for (let i = filtered.length - 1; i >= 0; i--) {
      if (!filtered[i].disabled) {
        setActiveIndex(canCreate ? i + 1 : i);
        return;
      }
    }
    if (canCreate) setActiveIndex(0);
  }

  function onInputKeyDown(event: KeyboardEvent<HTMLInputElement>) {
    switch (event.key) {
      case "ArrowDown":
        event.preventDefault();
        moveActive(1);
        break;
      case "ArrowUp":
        event.preventDefault();
        moveActive(-1);
        break;
      case "Home":
        event.preventDefault();
        jumpTo("first");
        break;
      case "End":
        event.preventDefault();
        jumpTo("last");
        break;
      case "Enter":
        event.preventDefault();
        chooseRow(activeIndex);
        break;
      case "Escape":
        event.preventDefault();
        if (query !== "") setQuery("");
        else closePanel();
        break;
      case "Tab":
        if (open) closePanel();
        break;
    }
  }

  // The aria-activedescendant id of the row currently active.
  let activeId: string | undefined;
  if (canCreate && activeIndex === 0) {
    activeId = `${triggerId}-create`;
  } else {
    const optIndex = canCreate ? activeIndex - 1 : activeIndex;
    if (filtered[optIndex]) activeId = `${triggerId}-opt-${optIndex}`;
  }

  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>
      <div className="relative">
        {name ? <input type="hidden" name={name} value={selectedValue} disabled={disabled} readOnly /> : null}
        <button
          ref={triggerRef}
          id={triggerId}
          type="button"
          disabled={disabled}
          aria-haspopup="listbox"
          aria-expanded={open}
          aria-controls={open ? listboxId : undefined}
          onClick={() => (open ? closePanel() : openPanel())}
          className={cx(
            "inline-flex w-full items-center justify-between gap-2 rounded-[var(--ds-radius-sm)] border bg-[var(--ds-color-input)] px-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)] disabled:pointer-events-none disabled:bg-[var(--ds-color-muted)] disabled:text-[var(--ds-color-muted-foreground)] disabled:opacity-60 motion-reduce:transition-none",
            "border-[var(--ds-color-border)] focus:border-[var(--ds-color-border-strong)]",
            SIZES[size],
            className,
          )}
        >
          <span className={cx("flex-1 truncate", !selected && "text-[var(--ds-color-muted-foreground)]")}>
            {selected ? selected.label : placeholder}
          </span>
          {selected ? (
            <CheckIcon className="shrink-0 text-[var(--ds-color-primary)]" />
          ) : null}
          <ChevronDown className={cx("shrink-0 text-[var(--ds-color-muted-foreground)] transition-transform duration-150 motion-reduce:transition-none", open && "rotate-180")} />
        </button>
        {open ? (
          <CreatablePanel
            ref={listboxRef}
            listboxId={listboxId}
            comboboxId={comboboxId}
            labelledby={triggerId}
            inputRef={inputRef}
            searchPlaceholder={searchPlaceholder}
            query={query}
            onQuery={setQuery}
            onInputKeyDown={onInputKeyDown}
            filtered={filtered}
            selectedValue={selectedValue}
            triggerId={triggerId}
            activeId={activeId}
            activeIndex={activeIndex}
            canCreate={canCreate}
            createLabel={createLabel}
            createText={trimmed}
            onChooseRow={chooseRow}
            onHover={setActiveIndex}
            onOutside={closePanel}
          />
        ) : null}
      </div>
    </div>
  );
}

export default CreatableSelect;

function CreatablePanel({
  ref,
  listboxId,
  comboboxId,
  labelledby,
  inputRef,
  searchPlaceholder,
  query,
  onQuery,
  onInputKeyDown,
  filtered,
  selectedValue,
  triggerId,
  activeId,
  activeIndex,
  canCreate,
  createLabel,
  createText,
  onChooseRow,
  onHover,
  onOutside,
}: {
  ref: RefObject<HTMLDivElement>;
  listboxId: string;
  comboboxId: string;
  labelledby: string;
  inputRef: RefObject<HTMLInputElement>;
  searchPlaceholder: string;
  query: string;
  onQuery: (q: string) => void;
  onInputKeyDown: (e: KeyboardEvent<HTMLInputElement>) => void;
  filtered: CreatableOption[];
  selectedValue: string;
  triggerId: string;
  activeId: string | undefined;
  activeIndex: number;
  canCreate: boolean;
  createLabel: string;
  createText: string;
  onChooseRow: (index: number) => 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(() => {
    inputRef.current?.focus();
  }, [inputRef]);

  useEffect(() => {
    const el = ref.current?.querySelector(`[data-i="${activeIndex}"]`);
    el?.scrollIntoView({ block: "nearest" });
  }, [activeIndex, ref]);

  const empty = filtered.length === 0 && !canCreate;

  return (
    <div
      ref={ref}
      className="absolute z-20 mt-1.5 w-full overflow-hidden rounded-[var(--ds-radius-md)] border border-[var(--ds-color-border)] bg-[var(--ds-color-surface-elevated)] shadow-[var(--ds-shadow-md)]"
    >
      <div className="flex items-center gap-2 border-b border-[var(--ds-color-border-subtle)] px-2.5 py-2">
        <SearchIcon className="shrink-0 text-[var(--ds-color-muted-foreground)]" />
        <input
          ref={inputRef}
          id={comboboxId}
          type="text"
          role="combobox"
          aria-expanded={true}
          aria-haspopup="listbox"
          aria-controls={listboxId}
          aria-activedescendant={activeId}
          aria-autocomplete="list"
          value={query}
          onChange={(e) => onQuery(e.target.value)}
          onKeyDown={onInputKeyDown}
          placeholder={searchPlaceholder}
          className="w-full bg-transparent text-sm text-[var(--ds-color-foreground)] placeholder:text-[var(--ds-color-muted-foreground)] focus-visible:outline-none"
        />
      </div>
      <div
        id={listboxId}
        role="listbox"
        aria-labelledby={labelledby}
        className="max-h-60 overflow-auto p-1"
      >
        {empty ? (
          <div className="px-2.5 py-2 text-[13px] text-[var(--ds-color-muted-foreground)]">No matches</div>
        ) : (
          <>
            {canCreate ? (
              <button
                key="__create__"
                id={`${triggerId}-create`}
                type="button"
                data-i={0}
                role="option"
                aria-selected={false}
                onMouseEnter={() => onHover(0)}
                onClick={() => onChooseRow(0)}
                className={cx(
                  "flex w-full items-center 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)]",
                  activeIndex === 0 ? "bg-[var(--ds-color-surface-hover)]" : "",
                )}
              >
                <PlusIcon className="shrink-0 text-[var(--ds-color-primary)]" />
                <span className="truncate">
                  {createLabel} <span className="font-medium">&ldquo;{createText}&rdquo;</span>
                </span>
              </button>
            ) : null}
            {filtered.map((option, i) => {
              const row = canCreate ? i + 1 : i;
              const isSelected = option.value === selectedValue;
              return (
                <button
                  key={option.value}
                  id={`${triggerId}-opt-${i}`}
                  type="button"
                  data-i={row}
                  role="option"
                  aria-selected={isSelected}
                  aria-disabled={option.disabled || undefined}
                  disabled={option.disabled}
                  onMouseEnter={() => onHover(row)}
                  onClick={() => onChooseRow(row)}
                  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)]",
                    row === activeIndex ? "bg-[var(--ds-color-surface-hover)]" : "",
                    isSelected ? "font-medium" : "",
                    option.disabled ? "cursor-not-allowed text-[var(--ds-color-muted-foreground)] opacity-60" : "",
                  )}
                >
                  <span className="truncate">{option.label}</span>
                  {isSelected ? (
                    <CheckIcon className="shrink-0 text-[var(--ds-color-primary)]" />
                  ) : null}
                </button>
              );
            })}
          </>
        )}
      </div>
    </div>
  );
}
472 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/creatable-select
Prompt instruction
I want to use this DevSnips resource in production:

Page:
https://devsnips.site/library/react/components/selects/creatable-select/

Install: npx devsnips add
React/Components/Selects/creatable-select

This is the Creatable Select — Combobox that lets users create a new option when no match exists.

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/creatable-select