본문으로 건너뛰기
Amineslab UI

Component

PhoneInput

한국 전화번호 포맷과 중간 편집 캐럿을 보존하는 입력입니다.

Playground

옵션을 조절하며 화면과 사용 코드를 함께 확인하세요.

PC 1280px
Controls

빈 입력 안내 · 사용처의 언어와 문구로 변경

Code
import { type InputProps, PhoneInput } from '@amineslab/ui'

import { useState } from 'react'

function PhoneExample({ size, ...inputProps }: {
    size: string;
} & Pick<InputProps, 'opaque' | 'variant' | 'invalid' | 'disabled' | 'startAdornment' | 'endAdornment' | 'placeholder' | 'autoComplete'>) {
    const [value, setValue] = useState('01012345678');
    const resolvedSize = size === 'xs' || size === 'sm' || size === 'lg' || size === 'xl' ? size : 'md';
    return (<div className="grid w-full max-w-sm gap-2">
      <PhoneInput {...inputProps} aria-label="전화번호" size={resolvedSize} value={value} onValueChange={setValue}/>
    </div>);
}

export default function ExamplePreview() {
  return ((<PhoneExample {...({"placeholder":"010-0000-0000","opaque":false,"variant":"filled","invalid":false,"disabled":false,"startAdornment":"","endAdornment":"","size":"md"} as const)} variant={"filled"}/>))
}

Props

import {
  PhoneInput,
  formatPhoneInput,
  formatPhoneNumber,
  isValidPhoneNumber,
} from '@amineslab/ui'

PhoneInput

입력 중 포맷·캐럿·유효성 계약을 소유합니다.

NameTypeDefaultDescription
valuestring-raw 숫자 또는 포맷 문자열을 받을 수 있습니다.
onValueChange(value: string) => void-하이픈이 포함된 정규화 문자열을 전달합니다.
onValidityChange(valid: boolean) => void-현재 전화번호 형식이 완성됐는지 알립니다.
placeholderstring-기본 010-0000-0000 안내를 덮어씁니다.
invalidbooleanfalse오류 테두리를 표시하며 focus·open 상태에서도 유지합니다. aria-invalid도 함께 전달합니다.
variant'filled' | 'outline'filled공통 필드 표면 표현입니다. focus·hover는 중립 elevation을 사용합니다.
opaquebooleanfalseelevation 레이어 아래 불투명한 테마 바탕을 추가합니다. hover·focus·invalid 표현은 유지합니다.
startAdornment / endAdornmentReactNode | IconComponent-Input과 동일하게 아이콘 컴포넌트·문자열·ReactNode를 받습니다. PasswordInput의 표시 버튼은 오른쪽 슬롯과 함께 배치됩니다.

Examples

자주 쓰는 조합을 살펴보고, 필요한 예시의 코드를 펼쳐 확인하세요.

공통 필드 표면

variant는 filled·outline 표현을, opaque는 elevation 아래의 불투명 바탕을 정합니다. focus와 hover는 중립 elevation을 사용하고 invalid 테두리는 포커스 중에도 유지합니다. NumberInput·PhoneInput·PasswordInput은 Input의 아이콘·문자열·ReactNode 슬롯을 상속합니다. SelectField에서는 같은 표면 props를 직접 지정하거나 triggerProps로 세부 설정할 수 있습니다.

투명 바탕
+82
불투명 바탕
+82
Outline + 불투명 바탕
+82
<PhoneInput startAdornment="+82" />

<PhoneInput startAdornment="+82" opaque />

<PhoneInput startAdornment="+82" variant="outline" opaque />

하이픈과 캐럿 보존

중간 위치를 편집해도 숫자 기준으로 캐럿을 재배치합니다.

import { type InputProps, PhoneInput } from '@amineslab/ui'

import { useState } from 'react'

function PhoneExample({ size, ...inputProps }: {
    size: string;
} & Pick<InputProps, 'opaque' | 'variant' | 'invalid' | 'disabled' | 'startAdornment' | 'endAdornment' | 'placeholder' | 'autoComplete'>) {
    const [value, setValue] = useState('01012345678');
    const resolvedSize = size === 'xs' || size === 'sm' || size === 'lg' || size === 'xl' ? size : 'md';
    return (<div className="grid w-full max-w-sm gap-2">
      <PhoneInput {...inputProps} aria-label="전화번호" size={resolvedSize} value={value} onValueChange={setValue}/>
    </div>);
}

export default function ExamplePreview() {
  return (<PhoneExample size="md"/>)
}

PhoneField로 사용하기

PhoneField는 기본 입력에 label·required·description·error를 함께 제공합니다. FormStack 안에 직접 넣으며 FormField로 다시 감싸지 않습니다.

라벨·설명·필수 표시를 Field가 함께 처리합니다.

import { useState } from 'react'

import { PhoneField } from '@amineslab/ui'

const fieldDescription = '라벨·설명·필수 표시를 Field가 함께 처리합니다.';

function PhoneFieldExample() {
    const [value, setValue] = useState('');
    return (<PhoneField label="전화번호" description={fieldDescription} required value={value} onValueChange={setValue}/>);
}

export default function ExamplePreview() {
  return (<PhoneFieldExample />)
}

사용 기준

권장하는 사용
  • onChange는 하이픈이 포함된 정규화 문자열을 전달합니다.
  • 외부 value 초기화는 포커스 중에도 반영하고, 일반 편집의 캐럿 위치는 유지합니다.
  • 유효성 표시 시점은 onValidityChange와 소비 폼의 blur 정책을 조합해 결정합니다.
피해야 할 사용
  • 겉모양만으로 사용을 결정하지 마세요.
  • 의미와 키보드 동작, 모바일에서의 흐름을 함께 확인하세요.

접근성

화면에 맞는 이름을 제공하고, 키보드만으로 작업을 마칠 수 있는지 확인하세요.

  • 방향키 / Home / End: 숫자 기준 캐럿 위치를 보존하며 중간을 편집합니다.