1.6.2 • Published 3 years ago

@validate-phone/react-input v1.6.2

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

React input component with phone number validation

  • Minimalistic <2kB
  • Utilizes validatephonenumber.com free API
  • Compatible with all modern browsers

npm.io

Install

npm i @validate-phone/react-input

How to use

import { PhoneInput } from '@validate-phone/react-input'

export function MyApp() {
  const [valid, setValid] = useState(false)

  return (
    <>
      <PhoneInput onValidation={(isValid) => setValid(isValid)} />
      <div>{String(valid)}</div>
    </>
  )
}
export interface PhoneInputProps
  extends React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> {
  onValidation?: (isValid: boolean) => void
  // default: false
  validateOnChange?: boolean
  // default: true
  // if true, defaults to 400 (400ms delay)
  validateOnChangeDelayed?: boolean | number
  // default: true
  // false if validateOnChange is true
  validateOnBlur?: boolean
  // recognise local phone numbers in country
  // default: US
  countryCode?: string
}