Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saulosilva/jcep
Search address by cep Brazil
https://github.com/saulosilva/jcep
Last synced: 2 months ago
JSON representation
Search address by cep Brazil
- Host: GitHub
- URL: https://github.com/saulosilva/jcep
- Owner: SauloSilva
- License: mit
- Created: 2016-02-06T04:07:09.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T00:49:06.000Z (over 1 year ago)
- Last Synced: 2024-10-09T22:17:45.267Z (3 months ago)
- Language: JavaScript
- Size: 176 KB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jCep
[](https://travis-ci.org/SauloSilva/jcep)
[](https://codeclimate.com/github/SauloSilva/jcep)
## About jcep
Jcep is a library to helpful a search address by CEP on Brazil.
No dependency with **jQuery** or anything.
[**Live Demo**](http://codepen.io/SauloSilva/full/pyQgeg/)
## Install by bower
```
bower install jcep
```
## How to use
It's very simple. Look by example:
```javascript
new jcep();
```
### Elements by data attributes
If you using data attributes on your html, this library working
with auto-detect of elements on page. Eg.
**HTML**
```html
CEP:
Street:
Number:
Neighborhood:
City:
State:
```
**JavaScript**
```js
new jcep();
```
**Obs:** If you not specify any callbacks, this library will automatically
fill your form with results of search.
### Specify elements
If you choose specify elements, you ought to use by this way:
**JavaScript**
```js
new jcep({
elements: {
cepEl: '.cep',
streetEl: '.street',
numberEl: '.number',
neighborhoodEl: '.neighborhood',
cityEl: '.city',
stateEl: '.state'
}
});
```
## Callbacks by functions
You can configure jcep to working with functions to returns results. See for explanation about this callbacks.
### Success
You can use success callback to get result of search.
The result is sent with params for success function. Eg
```js
new jcep({
...
success: function(data) { console.log(data) },
...
});
```
### Error
You can use error callback to warn about errors.
The error message is sent with params for error function. Eg
```js
new jcep({
...
error: function(error) { console.error(error) },
...
});
```
### Before Send
The `beforeSend` callback is use before the request is sent to search for the zipcode.
```js
new jcep({
beforeSend: function() { console.log('before sending the request') },
});
```
## Callbacks by events
You can configure callback by events
### Success
If you want receive results of search by events, it's easy. Eg.
```js
new jcep({
triggerEventName: 'test'
});
document.addEventListener('test:success', function(data) {
console.log('results: ', data);
})
```
### Error
If you want receive error message of search by events, it's easy. Eg.
```js
new jcep({
triggerEventName: 'test'
});
document.addEventListener('test:error', function(error) {
console.error('error: ', error);
})
```
### Before Send
This event will be triggered before the request is sent to search for the zipcode.
```js
new jcep({
triggerEventName: 'test'
});
document.addEventListener('test:beforeSend', function() {
console.log('before sending the request');
});
```
**Obs:** The event names contains, name (you specified on configuration) with
prefix (`:success` or `:error`). Be careful don't forget the prefix
in the end of event name
## Contributors
- Saulo Santiago ([SauloSilva](https://github.com/SauloSilva))