Skip to content
This repository was archived by the owner on Jan 26, 2024. It is now read-only.

live-controls/autocep

Repository files navigation

Auto CEP

Release Version Packagist Version

THIS PROJECT WON'T BE UPDATED ANYMORE, USE ITS SUCCESSOR live-controls/autoaddress

An Input for CEP which would give you the informations for road, etc. based on CepAberto

Requirements

  • Laravel 9+
  • Livewire 2+

Translations

  • English (en)
  • German (de)
  • Brazilian Portuguese (pt_BR)

Installation

  1. Install AutoCep package
composer require live-controls/autocep

Content

  • GetCEP class
  • AutoCep input - @livewire('livecontrols-autocep')

Usage

First Step: You will need to create a CEPABERTO_TOKEN environment variable. You will get the token after registration from https://www.cepaberto.com/

Blade:

@livewire('livecontrols-autocep', [
'prefix' => 'student',
'titlesuffix' => '*',
'oldmodel' => $student,
'required' => true,
], key('autocep'))
  • prefix = The prefix is optional, but needed if you add more than one AutoCep component on a single page. It will be prefixroad etc. afterwards
  • titlesuffix = The suffix of the title, usually you'd set a * if they're required or such.
  • oldmodel = This is optional, if set, it will take the cep, street, bairro, uf and city of the model
  • required = If set to true it will set all inputs to "required"

From 1.1.6 on

  • areacodeName = The name/id of the areacode control (Default: areacode)
  • streetName = The name/id of the street control (Default: street)
  • numberName = The name/id of the housenumber control (Default: housenumber)
  • complementName = The name/id of the complement control (Default: complement)
  • areaName = The name/id of the area control (Default: area)
  • cityName = The name/id of the city control (Default: city)
  • ufName = The name/id of the UF/2-digit state control (Default: uf)
  • countryName = The name/id of the (hidden) country control (Default: country)

Important: In case you want to use more than one AutoCEP component, don't forget to add a "prefix" or change the areacodeName etc of the components so the informations won't be overwritten!

About

An Input for CEP which would give you the informations for road, etc. based on CepAberto

Resources

License

Stars

Watchers

Forks

Packages

No packages published