Rewrite jQuery-TWzipcode in React
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
dist
example
scripts
src
.coveralls.yml
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.travis.yml
LICENSE
README.md
package.json
yarn.lock

README.md

React-TWzipcode

PRs Welcome Build Status npm version Coverage Status npm

Rewrite jQuery-TWzipcode in React.js.

Demo & Examples

Live demo: patw0929.github.io/react-twzipcode

To build the examples locally, run:

npm install
npm run start

or

yarn
yarn start

Then open localhost:3000 in a browser.

Installation

The easiest way to use react-twzipcode is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/main.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-twzipcode --save

or

yarn add react-twzipcode

Usage

import TWzipcode from 'react-twzipcode';

<TWzipcode css={['county-sel', 'district-sel', 'zipcode']} />

Properties

Please see the Demo Page

Development (src and the build process)

NOTE: The source code for the component is in src. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start or yarn start.

If you want to build to the bundle file to dist/ folder, please run:

npm run build

or

yarn run build

Contributing

To contribute to react-twzipcode, clone this repo locally and commit your code on a separate branch. Please write tests for your code, and run the linter before opening a pull-request:

npm test
npm run lint

or

yarn test
yarn run lint

And please remember don't bumping version in pull request commits.

License

MIT

Copyright (c) 2015-2017 patw.