https://github.com/isaacdarcilla/select-philippines-address

📍Promise-based address selection in the Philippines
https://github.com/isaacdarcilla/select-philippines-address

address cities html javascript node npm package ph philippines provinces react regions select vue

Last synced: 5 days ago
JSON representation

📍Promise-based address selection in the Philippines

• Host: GitHub
• URL: https://github.com/isaacdarcilla/select-philippines-address
• Owner: isaacdarcilla
• Created: 2021-04-25T10:23:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-04T02:00:40.000Z (4 months ago)
• Last Synced: 2024-10-05T16:38:21.193Z (4 months ago)
• Topics: address, cities, html, javascript, node, npm, package, ph, philippines, provinces, react, regions, select, vue
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/select-philippines-address
• Size: 2.32 MB
• Stars: 24
• Watchers: 3
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## [email protected]

Promised-based select addresses in the Philippines using HTML select tag base on address codes or location name.

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![npm version](https://badge.fury.io/js/select-philippines-address.svg)](https://badge.fury.io/js/select-philippines-address) [![codecov](https://codecov.io/gh/nodejs/undici/branch/main/graph/badge.svg?token=yZL6LtXkOA)](https://codecov.io/gh/nodejs/undici)

### Demos

> React JS

[![Deploy with Vercel](https://vercel.com/button)](https://select-philippines-address.vercel.app/)

> Vue JS

[![Deploy with Vercel](https://vercel.com/button)](https://select-philippines-address-vue.vercel.app/)

### Installation

```

npm i select-philippines-address --save

```

### Usage

```js

import { regions, provinces, cities, barangays, regionByCode, provincesByCode, provinceByName } from "select-philippines-address";

regions().then((region) => console.log(region));

regionByCode("01").then((region) => console.log(region.region_name));

provinces("01").then((province) => console.log(province));

provincesByCode("01").then((province) => console.log(province));

provinceByName("Rizal").then((province) => console.log(province.province_code));

cities("0128").then((city) => console.log(city));

barangays("052011").then((barangays) => console.log(barangays));

```

### Description

| Function           | Parameters                   | Description                                        |

|--------------------|------------------------------|----------------------------------------------------|

| `regions()`        | None                         | Returns all regions.                               |

| `regionByCode()`   | `region_code`                | Returns a region by its code.                      |

| `provinces()`      | `region_code`                | Returns provinces in the specified region.         |

| `provincesByCode()`| `region_code`                | Returns provinces in the specified region.         |

| `provinceByName()` | `province_name`              | Returns a province by its name.                    |

| `cities()`         | `province_code`              | Returns cities in the specified province.         |

| `barangays()`      | `city_code`                  | Returns barangays in the specified city.           |

### Demo Source Code

-   [React JS](https://github.com/isaacdarcilla/select-philippines-address/tree/main/demo/react)

-   [Vue JS](https://github.com/isaacdarcilla/select-philippines-address/tree/main/demo/vue)

###  License

[Apache-2.0](https://github.com/isaacdarcilla/select-philippines-address/blob/master/LICENSE)

### Contributors

- [Isaac Arcilla](https://facebook.com/isaacdarcilla)


- [LA Colinares](https://github.com/la-colinares)