JSPM

  • Created
  • Published
  • Downloads 87780
  • Score
    100M100P100Q173894F
  • License MIT

A phone number input designed for the React library MUI built with libphonenumber-js

Package Exports

    Readme

    Material UI tel input

    A phone number input designed for the React library Material UI

    license ts npm

    Installation

    // with npm
    npm install mui-tel-input
    
    // with yarn
    yarn add mui-tel-input

    The component uses libphonenumber-js for phone number parsing and formatting.

    Usage

    import React from 'react'
    import { MuiTelInput } from 'mui-tel-input'
    
    const MyComponent = () => {
      const [value, setValue] = React.useState('')
    
      const handleChange = (newValue) => {
        setValue(newValue)
      }
    
      return <MuiTelInput value={value} onChange={handleChange} />
    }

    Next.js integration

    Learn how to use MUI Tel Input with Next.js.

    Once you have installed MUI Tel Input in your next.js project, it is important to transpile it as it is an ESM package first.

    /** @type {import('next').NextConfig} */
    const nextConfig = {
     transpilePackages: ['mui-tel-input'],
     // your config
    }
    
    module.exports = nextConfig

    Documentation

    Changelog

    Go to GitHub Releases

    TypeScript

    This library comes with TypeScript "typings". If you happen to find any bugs in those, create an issue.

    🐛 Bugs

    Please file an issue for bugs, missing documentation, or unexpected behavior.

    💡 Feature Requests

    Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

    LICENSE

    MIT