react-us-states

react-us-states

React Hooks module for the states-us package.

Installation

To install react-ntc with npm:

npm install react-us-states

To install react-ntc with yarn:

yarn add react-us-states

Types

interface StateObject {
	name: string;
  abbreviation: string;
  territory: boolean;
  contiguous: boolean;
}

interface StateMap {
	[abbreviation: string]: string;
}

interface FullStateMap {
  [abbreviation: string]: StateObject;
}

type StateTuple = [
  name: string,
  abbreviation: string,
  territory: boolean,
  contiguous: boolean
];

Hooks

useStates()

useStateMap()

useFullStateMap()

useStateTuples()

useStateNameLookup(abbreviation: string)

useStateObjectLookup(abbreviation: string)

Demo

View demo here: https://alehechka.github.io/react-us-states/

License

This project is licensed under the terms of the MIT license.