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

Components / Inputs

Phone Field Input

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

Phone field with dial-code prefix and live US-style formatting. Returns raw digits via onChange for validation and API calls.

Preview

+1

We will send a verification code by SMS.

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/phone-field-input.tsx in your project.

  4. 4

    Import and render:

    Example

    import { PhoneFieldInput } from "@/components/inputs/phone-field-input";

    <PhoneFieldInput dialCode="+44" required onChange={(digits) => setPhone(digits)} />

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/phone-field-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
"use client";
 
import {
forwardRef,
useCallback,
useId,
useState,
type ChangeEvent,
type ComponentPropsWithoutRef,
} from "react";
 
import { cn } from "@/lib/cn";
 
export type PhoneFieldInputProps = Readonly<
{
label?: string;
hint?: string;
error?: boolean;
errorMessage?: string;
dialCode?: string;
containerClassName?: string;
} & Omit<ComponentPropsWithoutRef<"input">, "size" | "type" | "onChange">
> & {
onChange?: (value: string, event: ChangeEvent<HTMLInputElement>) => void;
};
 
function formatPhoneDisplay(raw: string, dialCode: string): string {
const digits = raw.replace(/\D/g, "").slice(0, 15);
if (dialCode.replace(/\s/g, "") !== "+1") return digits;
if (digits.length <= 3) return digits;
if (digits.length <= 6) {
return `(${digits.slice(0, 3)}) ${digits.slice(3)}`;
}
return `(${digits.slice(0, 3)}) ${digits.slice(3, 6)}-${digits.slice(6)}`;
}
 
function digitsOnly(raw: string): string {
return raw.replace(/\D/g, "").slice(0, 15);
}
 
export const PhoneFieldInput = forwardRef<HTMLInputElement, PhoneFieldInputProps>(
function PhoneFieldInput(
{
className,
containerClassName,
id,
label = "Phone number",
hint = "We will send a verification code by SMS.",
error = false,
errorMessage = "Enter a valid phone number.",
dialCode = "+1",
disabled,
required,
value,
defaultValue = "",
autoComplete = "tel-national",
onChange,
...props
},
ref,
) {
const generatedId = useId();
const inputId = id ?? generatedId;
const hintId = `${inputId}-hint`;
const errorId = `${inputId}-error`;
 
const isControlled = value !== undefined;
const [internal, setInternal] = useState(() => digitsOnly(String(defaultValue)));
const display = isControlled
? formatPhoneDisplay(String(value), dialCode)
: formatPhoneDisplay(internal, dialCode);
 
const handleChange = useCallback(
(event: ChangeEvent<HTMLInputElement>) => {
const nextRaw = digitsOnly(event.target.value);
if (!isControlled) setInternal(nextRaw);
onChange?.(nextRaw, event);
},
[isControlled, onChange],
);
 
return (
<div
data-slot="phone-field-input"
data-error={error || undefined}
className={cn("w-full max-w-sm font-sans", containerClassName)}
>
<label
htmlFor={inputId}
className="mb-1.5 block text-sm font-medium text-neutral-900"
>
{label}
{required ? (
<span className="ml-0.5 text-rose-500" aria-hidden>
*
</span>
) : null}
</label>
 
<div
className={cn(
"flex overflow-hidden rounded-lg border bg-white transition-[border-color] duration-200",
error
? "border-rose-300 focus-within:border-rose-400"
: "border-neutral-200 focus-within:border-neutral-900",
disabled && "bg-neutral-50",
)}
>
<span
aria-hidden
className={cn(
"flex shrink-0 items-center border-r border-neutral-200 bg-neutral-50 px-3 font-mono text-sm text-neutral-600",
disabled && "text-neutral-400",
)}
>
{dialCode}
</span>
 
<input
ref={ref}
id={inputId}
type="tel"
inputMode="tel"
autoComplete={autoComplete}
disabled={disabled}
required={required}
value={display}
aria-invalid={error || undefined}
aria-describedby={
error ? errorId : hint ? hintId : undefined
}
placeholder="(555) 000-0000"
onChange={handleChange}
className={cn(
"h-10 min-w-0 flex-1 bg-transparent px-3.5 font-sans text-sm text-neutral-900 outline-none ring-0 placeholder:text-neutral-400 focus:ring-0 disabled:cursor-not-allowed disabled:text-neutral-400",
className,
)}
{...props}
/>
</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>
);
},
);
 
PhoneFieldInput.displayName = "PhoneFieldInput";
PreviousNext

On this

page

Jump to a section on this page.

  • lib/cn.ts
  • components/inputs/phone-field-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.