1.0.10 • Published 10 months ago

@davzon/react-country-state-city v1.0.10

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

React-country-state-city

React-country-state-city allows you to create a responsive country, state, city dropdown with search options.

Installation

$ npm install --save react-country-state-city
$ yarn add react-country-state-city

Features

  • Easy to set up for real, you can make it work in less than 1minute!
  • Super easy to customize
  • Autosuggest: a list of matching countries is displayed when the input text changes.
  • Country data is provided, State data is provided based on given country id, City data is provided based on given country id and state id.
  • Country flag icons.
  • onChange and onTextChange callbacks.
  • And much more !

The gist

import {
  CitySelect,
  CountrySelect,
  StateSelect,
} from "react-country-state-city";
import "react-country-state-city/dist/react-country-state-city.css";

function App() {
  const [countryid, setCountryid] = useState(0);
  const [stateid, setstateid] = useState(0);
  return (
    <div>
      <h6>Country</h6>
      <CountrySelect
        onChange={(e) => {
          setCountryid(e.id);
        }}
        placeHolder="Select Country"
      />
      <h6>State</h6>
      <StateSelect
        countryid={countryid}
        onChange={(e) => {
          setstateid(e.id);
        }}
        placeHolder="Select State"
      />
      <h6>City</h6>
      <CitySelect
        countryid={countryid}
        stateid={stateid}
        onChange={(e) => {
          console.log(e);
        }}
        placeHolder="Select City"
      />
    </div>
  );
}

City Example

State Example

Country Example

The Country Select Properties

Properties used to customise the rendering:

NameTypeDescription
defaultValueCountryoptional The current value: a country object
containerClassNamestringoptional styles for a container
inputClassNamestringoptional styles for input box
onChangefunctionoptional The current value: a country object.The argument is the country object
onTextChangefunctionoptional A callback fired when the input text changes.
placeHolderstringoptional Placeholder text displayed in empty input
showFlagbooleanoptional Flags are displayed when true and not displayed when false. default is true.

State Select Properties

The same country select properties and additionally

NameTypeDescription
countryidnumberrequired The id of the selected country object

City Select Properties

The same country select properties and additionally

NameTypeDescription
countryidnumberrequired The id of the selected country object
stateidnumberrequired The id of the selected state object

Demo

A demo is worth a thousand words

Contribute

Show your ❤️ and support by giving a ⭐. Any suggestions are welcome! venkatmcajj@gmail.com

Financial Contributors

Become a financial contributor and help us sustain our community. Contribute

License

Licensed under MIT