Filament CEP Field

https://github.com/jeffersongoncalves/filament-cep-field
Admin
A custom input component for Brazilian postal codes (CEP) that provides formatting, validation, and...
Tokens:17,807
Snippets:162
Trust Score:9.8
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Full Configuration Example

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

A comprehensive example combining multiple configuration methods for the CepInput component.

```php
CepInput::make('cep')
    ->label('Codigo Postal')
    ->required()
    ->setMode('prefix')
    ->setActionLabel('Consultar')
    ->setActionLabelHidden(false)
    ->setErrorMessage('CEP nao encontrado ou invalido.')
    ->setStreetField('endereco')
    ->setNeighborhoodField('bairro')
    ->setCityField('cidade')
    ->setStateField('estado');
```

--------------------------------

### setMode usage examples

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Demonstrates how to position the search action button as a suffix or prefix.

```php
use JeffersonGoncalves\Filament\CepField\Forms\Components\CepInput;

// Button rendered after the input (default behavior, explicit)
CepInput::make('cep')->setMode('suffix');

// Button rendered before the input
CepInput::make('cep')->setMode('prefix');
```

--------------------------------

### Configure CepInput component

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/configuration.md

Example showing the fluent configuration methods available on the CepInput component for field mapping, action labels, and validation messages.

```php
use JeffersonGoncalves\Filament\CepField\Forms\Components\CepInput;

CepInput::make('cep')
    ->required()
    ->setMode('suffix')                 // 'suffix' | 'prefix'
    ->setActionLabel('Buscar CEP')      // button label
    ->setActionLabelHidden(false)       // false = label visible
    ->setErrorMessage('CEP não encontrado.')
    ->setStreetField('street')          // address field mapping
    ->setNeighborhoodField('neighborhood')
    ->setCityField('city')
    ->setStateField('state');
```

--------------------------------

### Usage of setCityField

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Example of configuring the city field name to 'cidade'.

```php
CepInput::make('cep')
    ->setCityField('cidade');
```

--------------------------------

### CepInput component usage

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Examples of basic and advanced configuration for the CepInput component in Filament forms.

```php
use JeffersonGoncalves\Filament\CepField\Forms\Components\CepInput;

// Basic usage
CepInput::make('cep')
    ->required(),

// Advanced usage with all available options
CepInput::make('cep')
    ->required()
    ->setMode('suffix') // 'prefix' or 'suffix' (default: 'suffix')
    ->setActionLabel('Buscar CEP') // Custom search button label
    ->setActionLabelHidden(false) // Show/hide action label (default: false)
    ->setErrorMessage('CEP não encontrado.') // Custom error message
    ->setStreetField('street') // Field to populate with street name
    ->setNeighborhoodField('neighborhood') // Field to populate with neighborhood
    ->setCityField('city') // Field to populate with city name
    ->setStateField('state'), // Field to populate with state
```

--------------------------------

### Usage of setNeighborhoodField

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Example of configuring the neighborhood field name to 'bairro'.

```php
CepInput::make('cep')
    ->setNeighborhoodField('bairro');
```

--------------------------------

### setActionLabelHidden usage examples

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Demonstrates toggling between an icon-only button and a labeled button.

```php
// Icon-only search button
CepInput::make('cep')
    ->setActionLabelHidden(true);

// Icon + label (default)
CepInput::make('cep')
    ->setActionLabelHidden(false);
```

--------------------------------

### Usage of setStateField

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Example of configuring the state field name to 'estado'.

```php
CepInput::make('cep')
    ->setStateField('estado');
```

--------------------------------

### Complete Usage Example with CepInput

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Configures CepInput inside a Filament form schema to bind with street, neighborhood, city, and state TextInput fields.

```php
use JeffersonGoncalves\Filament\CepField\Forms\Components\CepInput;
use Filament\Forms\Form;

public function form(Form $form): Form
{
    return $form
        ->schema([
            TextInput::make('street'),
            TextInput::make('neighborhood'),
            TextInput::make('city'),
            TextInput::make('state'),
            CepInput::make('cep')
                ->required()
                ->setMode('suffix')
                ->setActionLabel('Buscar CEP')
                ->setActionLabelHidden(false)
                ->setErrorMessage('CEP não encontrado.')
                ->setStreetField('street')
                ->setNeighborhoodField('neighborhood')
                ->setCityField('city')
                ->setStateField('state'),
        ]);
}
```

--------------------------------

### setActionLabel usage example

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets the text label for the search action button.

```php
CepInput::make('cep')
    ->setActionLabel('Consultar');
```

--------------------------------

### Install Filament CEP Field via Composer

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

The command to add the package to your Laravel project dependencies.

```text
composer require jeffersongoncalves/filament-cep-field
```

--------------------------------

### setStreetField usage example

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Configures the form field name to be populated with the street name.

```php
CepInput::make('cep')
    ->setStreetField('endereco');
```

--------------------------------

### setErrorMessage usage example

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets a custom error message to be displayed when the CEP lookup fails.

```php
// Custom message on lookup failure
CepInput::make('cep')
    ->setErrorMessage('CEP não encontrado ou inválido.');
```

--------------------------------

### CepInput::setMode

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets the display mode of the CEP input field. The example uses 'suffix' mode, which likely shows the action button as a suffix.

```APIDOC
## CepInput::setMode

### Description
Sets the display mode of the CEP input field. The example uses 'suffix' mode, which likely shows the action button as a suffix.

### Method
instance

### Signature
`setMode(string $mode)`

### Parameters
- **$mode** (string) - Required - The mode to set. Example value: 'suffix'.

### Usage Example
```php
CepInput::make('cep')->setMode('suffix')
```
```

--------------------------------

### Run tests with Composer

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Execute the project's test suite using the Composer package manager.

```bash
composer test
```

--------------------------------

### ConfigurePackage Method Signature

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

The method signature for configuring the package descriptor.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Package Name Configuration

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

The implementation of configurePackage that sets the package name.

```php
$package
    ->name('filament-cep-field');
```

--------------------------------

### Download cacert.pem via cURL

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Use this command to download the latest CA certificate bundle from the official cURL website.

```bash
# Download the latest cacert.pem file
curl -o cacert.pem https://curl.se/ca/cacert.pem
```

--------------------------------

### Verify SSL Configuration

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Run this PHP script to test if the SSL connection to the BrasilAPI endpoint is successful.

```php
// Test SSL connection
$response = file_get_contents('https://brasilapi.com.br/api/cep/v1/01310100');
if ($response !== false) {
    echo "SSL configuration is working correctly!";
} else {
    echo "SSL configuration needs attention.";
}
```

--------------------------------

### Publishing and Migrating CEP Dependencies

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

Commands to publish and run migrations for the underlying laravel-cep dependency.

```bash
php artisan vendor:publish --tag=cep-migrations
php artisan migrate
```

--------------------------------

### Configure SSL Certificate in php.ini

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Troubleshooting SSL certificate errors by pointing to a valid CA bundle in the php.ini file.

```ini
openssl.cafile = "C:\php\extras\ssl\cacert.pem"
curl.cainfo = "C:\php\extras\ssl\cacert.pem"
```

--------------------------------

### Configure php.ini for SSL

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Update your php.ini file to point to the location of the cacert.pem file for both OpenSSL and cURL.

```ini
; Enable SSL certificate verification
openssl.cafile = "C:\php\extras\ssl\cacert.pem"  ; Windows path
; openssl.cafile = "/etc/ssl/certs/cacert.pem"   ; Linux/macOS path

; For cURL specifically
curl.cainfo = "C:\php\extras\ssl\cacert.pem"     ; Windows path
; curl.cainfo = "/etc/ssl/certs/cacert.pem"      ; Linux/macOS path
```

--------------------------------

### Composer Package Discovery Configuration

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

The entry in composer.json that enables automatic package discovery for the service provider.

```json
"extra": {
    "laravel": {
        "providers": [
            "JeffersonGoncalves\\Filament\\CepField\\CepFieldServiceProvider"
        ]
    }
}
```

--------------------------------

### Service Provider Contract Verification

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

A test snippet demonstrating the instantiation and configuration of the service provider.

```php
use JeffersonGoncalves\Filament\CepField\CepFieldServiceProvider;

// Instantiate (normally done by Laravel, not manually)
$provider = new CepFieldServiceProvider(app());

$package = new Package;
$provider->configurePackage($package);

echo $package->name; // 'filament-cep-field'
```

--------------------------------

### CepInput::make()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Creates a new CepInput component instance for use in Filament forms. This is the entry point for using the CEP field component.

```APIDOC
## CepInput::make()

### Description
Creates a new CepInput component instance for use in Filament forms. This is the entry point for using the CEP field component.

### Method
CepInput::make()

### Parameters
- **name** (string) - Required - The field name for the CEP input.

### Usage Example
```php
CepInput::make('cep')
    ->required()
```
```

--------------------------------

### Set SSL_CERT_FILE Environment Variable

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

An alternative method to configure the certificate path via environment variables, though not recommended for production.

```bash
export SSL_CERT_FILE=/path/to/cacert.pem
```

--------------------------------

### Basic CEP Input Component

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

A simple implementation of the CepInput component in a Filament form.

```php
use JeffersonGoncalves\Filament\CepField\Forms\Components\CepInput;

CepInput::make('postal_code')
    ->label('CEP')
    ->required();
```

--------------------------------

### CEP with prefix button and custom labels

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Customizing the search button position and labels.

```php
CepInput::make('cep')
    ->label('Código Postal')
    ->setMode('prefix')
    ->setActionLabel('Consultar')
    ->setActionLabelHidden(false)
    ->setErrorMessage('CEP não encontrado ou inválido.')
```

--------------------------------

### CepInput Import Statements

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

The full set of imports required for the CepInput component implementation.

```php
use Filament\Actions\Action;
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Components\Utilities\Set;
use Illuminate\Validation\ValidationException;
use JeffersonGoncalves\Cep\Models\Cep;
use Livewire\Component as Livewire;
```

--------------------------------

### Customize Search Button Label

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Configuring the button label text and visibility.

```php
CepInput::make('cep')
    ->setActionLabel('Consultar')       // Custom label text
    ->setActionLabelHidden(false);      // Show label (false = visible)

// Icon-only button (hide label)
CepInput::make('cep')
    ->setActionLabelHidden(true);
```

--------------------------------

### setMode(string $mode)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Sets the position of the search action button. Accepts 'suffix' (default) or 'prefix'.

```APIDOC
## setMode(string $mode)

### Description
Sets the position of the search action button. Accepts 'suffix' (default) or 'prefix'.

### Method
setMode(string $mode)

### Parameters
- **mode** (string) - Required - The position of the search action button. Values: 'suffix' (default) or 'prefix'.

### Usage Example
```php
CepInput::make('cep')
    ->setMode('prefix')
```
```

--------------------------------

### CepFieldServiceProvider::configurePackage()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Configures the package for Laravel Package Tools. This method is called during package registration.

```APIDOC
## CepFieldServiceProvider::configurePackage()

### Description
Configures the package for Laravel Package Tools. This method is called during package registration.

### Method
configurePackage(Package $package): void

### Parameters
- **package** (Package) - Required - The package instance to configure.

### Returns
- **void** - No return value.

### Example
```php
// Called automatically by the framework
```
```

--------------------------------

### setActionLabelHidden internal logic

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Shows how the internal action is configured based on the hidden flag.

```php
if (! $this->actionLabelHidden) {
    $action->button();
}
```

--------------------------------

### CEP Input with Address Auto-Population

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Configuring the CepInput to automatically fill address fields based on the CEP lookup.

```php
CepInput::make('cep')
    ->label('CEP')
    ->required()
    ->setStreetField('street')
    ->setNeighborhoodField('neighborhood')
    ->setCityField('city')
    ->setStateField('state');
```

--------------------------------

### Class Declaration for CepFieldServiceProvider

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cep-field-service-provider.md

The class definition for the service provider, which extends the Spatie PackageServiceProvider.

```php
class CepFieldServiceProvider extends PackageServiceProvider
```

--------------------------------

### CEP with custom field mapping

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Configuring the component to populate specific form fields with address data.

```php
CepInput::make('cep')
    ->label('CEP')
    ->required()
    ->setStreetField('endereco')
    ->setNeighborhoodField('bairro')
    ->setCityField('cidade')
    ->setStateField('estado')
```

--------------------------------

### Configure Laravel HTTP Client SSL Verification

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Use the Laravel HTTP client to specify the path to the certificate bundle for individual requests.

```php
Http::withOptions([
    'verify' => '/path/to/cacert.pem'
])->get('https://api.example.com');
```

--------------------------------

### setMode method definition

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Defines the signature for the setMode method.

```php
public function setMode(string $mode): static
```

--------------------------------

### setActionLabel method definition

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Defines the signature for the setActionLabel method.

```php
public function setActionLabel(string $actionLabel): static
```

--------------------------------

### setActionLabel(string $label)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Customizes the label text for the search action button. Default is 'Buscar CEP'.

```APIDOC
## setActionLabel(string $label)

### Description
Customizes the label text for the search action button. Default is 'Buscar CEP'.

### Method
setActionLabel(string $label)

### Parameters
- **label** (string) - Required - The custom label for the search action button.

### Usage Example
```php
CepInput::make('cep')
    ->setActionLabel('Buscar CEP')
```
```

--------------------------------

### Define setCityField method signature

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

The method signature for setting the city field name.

```php
public function setCityField(string $cityField): static
```

--------------------------------

### Custom Portuguese Field Names

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Mapping the CEP lookup results to custom field names in Portuguese.

```php
CepInput::make('cep')
    ->label('CEP')
    ->required()
    ->setStreetField('endereco')
    ->setNeighborhoodField('bairro')
    ->setCityField('cidade')
    ->setStateField('estado');
```

--------------------------------

### Define setStateField method signature

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

The method signature for setting the state field name.

```php
public function setStateField(string $stateField): static
```

--------------------------------

### Catch ValidationException in consumer code

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/errors.md

Shows how to catch the standard Laravel ValidationException when handling the CepInput lookup programmatically. The errors() method returns an array keyed by the field's state path, e.g. ['data.cep' => ['CEP não encontrado.']].

```php
use Illuminate\Validation\ValidationException;

try {
    // trigger the CepInput lookup (e.g. via a Livewire update)
} catch (ValidationException $e) {
    $errors = $e->errors(); // ['data.cep' => ['CEP não encontrado.']]
    // $e->getMessage() contains the compiled message string
}
```

--------------------------------

### Define setNeighborhoodField method signature

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

The method signature for setting the neighborhood field name.

```php
public function setNeighborhoodField(string $neighborhoodField): static
```

--------------------------------

### Customize Search Button Position

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Setting the search button position to either suffix or prefix mode.

```php
// Suffix (default) - button after input
CepInput::make('cep')
    ->setMode('suffix');

// Prefix - button before input
CepInput::make('cep')
    ->setMode('prefix');
```

--------------------------------

### CepInput Class Declaration

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

The CepInput component extends the standard Filament TextInput class.

```php
class CepInput extends TextInput
```

--------------------------------

### CepInput::setActionLabel()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the label for the action button that triggers the CEP lookup. This is a fluent setter.

```APIDOC
## CepInput::setActionLabel()

### Description
Sets the label for the action button that triggers the CEP lookup. This is a fluent setter.

### Method
setActionLabel()

### Parameters
- **label** (string) - Required - The label for the action button.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setActionLabel('Buscar')
```
```

--------------------------------

### CepInput::setActionLabelHidden()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets whether the action label is hidden. This is a fluent setter.

```APIDOC
## CepInput::setActionLabelHidden()

### Description
Sets whether the action label is hidden. This is a fluent setter.

### Method
setActionLabelHidden()

### Parameters
- **hidden** (bool) - Required - Whether to hide the action label.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setActionLabelHidden(true)
```
```

--------------------------------

### Namespace Declaration

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

The primary namespace for the Filament CEP Field component.

```text
JeffersonGoncalves\Filament\CepField
```

--------------------------------

### setActionLabelHidden method definition

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Defines the signature for the setActionLabelHidden method.

```php
public function setActionLabelHidden(bool $actionLabelHidden): static
```

--------------------------------

### setStreetField method definition

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Defines the signature for the setStreetField method.

```php
public function setStreetField(string $streetField): static
```

--------------------------------

### setCityField(string $fieldName)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Specifies the form field to populate with the city name. Default is 'city'.

```APIDOC
## setCityField(string $fieldName)

### Description
Specifies the form field to populate with the city name. Default is 'city'.

### Method
setCityField(string $fieldName)

### Parameters
- **fieldName** (string) - Required - The name of the form field to populate with the city name.

### Usage Example
```php
CepInput::make('cep')
    ->setCityField('cidade')
```
```

--------------------------------

### setStateField(string $fieldName)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Specifies the form field to populate with the state. Default is 'state'.

```APIDOC
## setStateField(string $fieldName)

### Description
Specifies the form field to populate with the state. Default is 'state'.

### Method
setStateField(string $fieldName)

### Parameters
- **fieldName** (string) - Required - The name of the form field to populate with the state.

### Usage Example
```php
CepInput::make('cep')
    ->setStateField('estado')
```
```

--------------------------------

### setNeighborhoodField(string $fieldName)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Specifies the form field to populate with the neighborhood. Default is 'neighborhood'.

```APIDOC
## setNeighborhoodField(string $fieldName)

### Description
Specifies the form field to populate with the neighborhood. Default is 'neighborhood'.

### Method
setNeighborhoodField(string $fieldName)

### Parameters
- **fieldName** (string) - Required - The name of the form field to populate with the neighborhood.

### Usage Example
```php
CepInput::make('cep')
    ->setNeighborhoodField('bairro')
```
```

--------------------------------

### CepInput::setMode()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the mode of the CEP input component. This is a fluent setter that configures how the component behaves.

```APIDOC
## CepInput::setMode()

### Description
Sets the mode of the CEP input component. This is a fluent setter that configures how the component behaves.

### Method
setMode()

### Parameters
- **mode** (mixed) - Required - The mode to set.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setMode('search')
```
```

--------------------------------

### setActionLabelHidden(bool $hidden)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Controls whether the action button label is visible. When true, only the magnifying glass icon is shown.

```APIDOC
## setActionLabelHidden(bool $hidden)

### Description
Controls whether the action button label is visible. When true, only the magnifying glass icon is shown.

### Method
setActionLabelHidden(bool $hidden)

### Parameters
- **hidden** (bool) - Required - Whether to hide the action label. Default: false.

### Usage Example
```php
CepInput::make('cep')
    ->setActionLabelHidden(true)
```
```

--------------------------------

### setStateField(string $stateField): static

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets the name of the form field to populate with the state code. Returns the current CepInput instance for method chaining.

```APIDOC
## setStateField(string $stateField): static

### Description
Sets the name of the form field to populate with the state code. Returns the current CepInput instance for method chaining.

### Method
setStateField

### Signature
public function setStateField(string $stateField): static

### Parameters
- **$stateField** (string) - Required - Name of the form field to populate with the state code. Default is 'state'.

### Returns
- **static** - The current CepInput instance, enabling method chaining.

### Example
```php
CepInput::make('cep')
    ->setStateField('estado');
```
```

--------------------------------

### setStreetField(string $fieldName)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Specifies the form field to populate with the street name. Default is 'street'.

```APIDOC
## setStreetField(string $fieldName)

### Description
Specifies the form field to populate with the street name. Default is 'street'.

### Method
setStreetField(string $fieldName)

### Parameters
- **fieldName** (string) - Required - The name of the form field to populate with the street name.

### Usage Example
```php
CepInput::make('cep')
    ->setStreetField('endereco')
```
```

--------------------------------

### Throw ValidationException when CEP not found

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/errors.md

Thrown inside findByCep() when Cep::findByCep() returns a blank 'cep' key, after field validation passes. The exception message bag uses the field's state path as key and the configured error message as value.

```php
$cep = Cep::findByCep($state);
if (blank($cep['cep'])) {
    throw ValidationException::withMessages([
        $this->getStatePath() => $this->errorMessage,
    ]);
}
```

--------------------------------

### Configure Custom Error Message on CepInput

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets a custom error message on the CepInput field. Errors are reported directly through Filament's validation pipeline without requiring try/catch handling.

```php
// The error is reported on the field itself through Filament's
// validation pipeline; no try/catch is required in the form definition.
CepInput::make('cep')
    ->setErrorMessage('CEP não encontrado ou inválido.');
```

--------------------------------

### Set Custom Error Message

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/resources/boost/skills/cep-field-development/SKILL.md

Defining a custom error message for when a CEP is not found or invalid.

```php
CepInput::make('cep')
    ->setErrorMessage('CEP nao encontrado ou invalido.');
```

--------------------------------

### setErrorMessage(string $message)

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/README.md

Sets a custom error message when CEP lookup fails. Default is 'CEP inválido.'.

```APIDOC
## setErrorMessage(string $message)

### Description
Sets a custom error message when CEP lookup fails. Default is 'CEP inválido.'.

### Method
setErrorMessage(string $message)

### Parameters
- **message** (string) - Required - The custom error message.

### Usage Example
```php
CepInput::make('cep')
    ->setErrorMessage('CEP não encontrado.')
```
```

--------------------------------

### CepInput::setErrorMessage()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the error message displayed when CEP validation fails. This is a fluent setter.

```APIDOC
## CepInput::setErrorMessage()

### Description
Sets the error message displayed when CEP validation fails. This is a fluent setter.

### Method
setErrorMessage()

### Parameters
- **message** (string) - Required - The error message to display.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setErrorMessage('Invalid CEP')
```
```

--------------------------------

### setErrorMessage method definition

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Defines the signature for the setErrorMessage method.

```php
public function setErrorMessage(string $errorMessage): static
```

--------------------------------

### setCityField(string $cityField): static

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets the name of the form field to populate with the city name. Returns the current CepInput instance for method chaining.

```APIDOC
## setCityField(string $cityField): static

### Description
Sets the name of the form field to populate with the city name. Returns the current CepInput instance for method chaining.

### Method
setCityField

### Signature
public function setCityField(string $cityField): static

### Parameters
- **$cityField** (string) - Required - Name of the form field to populate with the city name. Default is 'city'.

### Returns
- **static** - The current CepInput instance, enabling method chaining.

### Example
```php
CepInput::make('cep')
    ->setCityField('cidade');
```
```

--------------------------------

### CepInput::setStateField()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the name of the form field to auto-populate with the state from the CEP lookup. This is a fluent setter.

```APIDOC
## CepInput::setStateField()

### Description
Sets the name of the form field to auto-populate with the state from the CEP lookup. This is a fluent setter.

### Method
setStateField()

### Parameters
- **field** (string) - Required - The name of the state field.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setStateField('state')
```
```

--------------------------------

### CepInput::setNeighborhoodField()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the name of the form field to auto-populate with the neighborhood from the CEP lookup. This is a fluent setter.

```APIDOC
## CepInput::setNeighborhoodField()

### Description
Sets the name of the form field to auto-populate with the neighborhood from the CEP lookup. This is a fluent setter.

### Method
setNeighborhoodField()

### Parameters
- **field** (string) - Required - The name of the neighborhood field.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setNeighborhoodField('neighborhood')
```
```

--------------------------------

### CepInput::setCityField()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the name of the form field to auto-populate with the city from the CEP lookup. This is a fluent setter.

```APIDOC
## CepInput::setCityField()

### Description
Sets the name of the form field to auto-populate with the city from the CEP lookup. This is a fluent setter.

### Method
setCityField()

### Parameters
- **field** (string) - Required - The name of the city field.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setCityField('city')
```
```

--------------------------------

### CepInput::setStreetField()

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/overview.md

Sets the name of the form field to auto-populate with the street from the CEP lookup. This is a fluent setter.

```APIDOC
## CepInput::setStreetField()

### Description
Sets the name of the form field to auto-populate with the street from the CEP lookup. This is a fluent setter.

### Method
setStreetField()

### Parameters
- **field** (string) - Required - The name of the street field.

### Returns
- **static** - The component instance for chaining.

### Example
```php
CepInput::make('cep')->setStreetField('street')
```
```

--------------------------------

### setStreetField(string $streetField): static

Source: https://github.com/jeffersongoncalves/filament-cep-field/blob/3.x/_autodocs/api-reference/cepinput.md

Sets the name of the form field to populate with the street name from the CEP lookup. The default field name is 'street'.

```APIDOC
## setStreetField(string $streetField): static

### Description
Sets the name of the form field to populate with the street name from the CEP lookup. The default field name is 'street'.

### Method
setStreetField

### Parameters
#### Parameters
- **$streetField** (string) - Required - Name of the form field to populate with the street name from the CEP lookup. Default is 'street'

### Returns
- **static** - The current CepInput instance, enabling method chaining.

### Request Example
```php
CepInput::make('cep')
    ->setStreetField('endereco');
```
```
Tokens:
Raw