opensourceui
GitHubTwitter/X
  1. Home
  2. Components
  3. Inputs
  4. Search Input
Back to Inputs

Components / Inputs

Search Input

Free Inputs React component — SearchInput. MIT licensed, copy-paste ready for Next.js and Tailwind CSS.

Search field with leading icon and clear button. Controlled or uncontrolled value, hidden native cancel, and keyboard-friendly reset.

Preview

Setup

How to use

Free for personal and commercial use. No UI attribution required. Include the MIT copyright notice when copying component source into your project. Read the MIT license.

  1. 1

    Run in your terminal:

    $npm install clsx tailwind-merge lucide-react
  2. 2

    Copy lib/cn.ts below. Skip if you already have cn().

  3. 3

    Copy the code below and create components/inputs/search-input.tsx in your project.

  4. 4

    Import and render:

    Example

    import { SearchInput } from "@/components/inputs/search-input";

    <SearchInput value={query} onChange={setQuery} onClear={() => setQuery("")} hint="Filter by name or category." />

lib/cn.ts

1
2
3
4
5
6
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
 
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}

components/inputs/search-input.tsx

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
"use client";
 
import {
forwardRef,
useCallback,
useEffect,
useId,
useRef,
useState,
type ChangeEvent,
type ComponentPropsWithoutRef,
} from "react";
 
import { Search, X } from "lucide-react";
 
import { cn } from "@/lib/cn";
 
export type SearchInputProps = Readonly<
{
label?: string;
hint?: string;
error?: boolean;
errorMessage?: string;
clearLabel?: string;
containerClassName?: string;
onClear?: () => void;
} & Omit<ComponentPropsWithoutRef<"input">, "size" | "type" | "onChange">
> & {
onChange?: (value: string, event: ChangeEvent<HTMLInputElement>) => void;
};
 
export const SearchInput = forwardRef<HTMLInputElement, SearchInputProps>(
function SearchInput(
{
className,
containerClassName,
id,
label = "Search",
hint,
error = false,
errorMessage = "Enter a valid search term.",
clearLabel = "Clear search",
disabled,
value,
defaultValue = "",
placeholder = "Search…",
onChange,
onClear,
...props
},
ref,
) {
const generatedId = useId();
const inputId = id ?? generatedId;
const hintId = `${inputId}-hint`;
const errorId = `${inputId}-error`;
const localRef = useRef<HTMLInputElement | null>(null);
 
const isControlled = value !== undefined;
const [internal, setInternal] = useState(String(defaultValue));
const current = isControlled ? String(value) : internal;
const hasValue = current.length > 0;
 
const handleChange = useCallback(
(event: ChangeEvent<HTMLInputElement>) => {
const next = event.target.value;
if (!isControlled) setInternal(next);
onChange?.(next, event);
},
[isControlled, onChange],
);
 
const handleClear = useCallback(() => {
if (!isControlled) setInternal("");
onClear?.();
localRef.current?.focus();
}, [isControlled, onClear]);
 
const setRefs = useCallback(
(node: HTMLInputElement | null) => {
localRef.current = node;
if (typeof ref === "function") ref(node);
else if (ref) ref.current = node;
},
[ref],
);
 
useEffect(() => {
if (isControlled) return;
const form = localRef.current?.form;
if (!form) return;
const handleReset = () => setInternal(String(defaultValue));
form.addEventListener("reset", handleReset);
return () => form.removeEventListener("reset", handleReset);
}, [defaultValue, isControlled]);
 
return (
<div
data-slot="search-input"
data-error={error || undefined}
className={cn("w-full max-w-sm font-sans", containerClassName)}
>
<label htmlFor={inputId} className="sr-only">
{label}
</label>
 
<div className="relative">
<Search
size={16}
strokeWidth={2}
aria-hidden
className="pointer-events-none absolute top-1/2 left-3.5 -translate-y-1/2 text-neutral-400"
/>
 
<input
ref={setRefs}
id={inputId}
type="search"
role="searchbox"
disabled={disabled}
value={current}
placeholder={placeholder}
aria-invalid={error || undefined}
aria-describedby={
error ? errorId : hint ? hintId : undefined
}
onChange={handleChange}
className={cn(
"h-10 w-full rounded-lg border bg-white py-2 pr-10 pl-10 font-sans text-sm text-neutral-900 outline-none ring-0 transition-[border-color,background-color] duration-200 placeholder:text-neutral-400 focus:ring-0 disabled:cursor-not-allowed disabled:bg-neutral-50 disabled:text-neutral-400",
"[&::-webkit-search-cancel-button]:hidden [&::-webkit-search-decoration]:hidden",
error
? "border-rose-300 focus:border-rose-400"
: "border-neutral-200 focus:border-neutral-900",
className,
)}
{...props}
/>
 
{hasValue && !disabled ? (
<button
type="button"
aria-label={clearLabel}
onClick={handleClear}
className="absolute top-1/2 right-2.5 flex size-6 -translate-y-1/2 cursor-pointer items-center justify-center rounded-md text-neutral-400 transition-colors hover:bg-neutral-100 hover:text-neutral-700"
>
<X size={14} strokeWidth={2} aria-hidden />
</button>
) : null}
</div>
 
{error ? (
<p id={errorId} role="alert" className="mt-1.5 text-xs text-rose-600">
{errorMessage}
</p>
) : hint ? (
<p id={hintId} className="mt-1.5 text-xs text-neutral-500">
{hint}
</p>
) : null}
</div>
);
},
);
 
SearchInput.displayName = "SearchInput";
PreviousNext

On this

page

Jump to a section on this page.

  • lib/cn.ts
  • components/inputs/search-input.tsx

Sponsor spot · demo preview

Logo

Your brand name

Your tagline or category

A short pitch about your product or service goes here. This is a preview of how sponsor cards will look in this sidebar.

Your call to action

This slot is available. Sponsor Opensource UI and reach developers browsing components every day.