react-us-states

React Hooks extensions to states-us npm package.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-us-states
001.0.23 years ago3 years agoMinified + gzip package size for react-us-states in KB

Readme

react-us-states
React Hooks module for the states-us package.
npm version npm-publish npm downloads

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.