Filament Phone Input

https://github.com/ysfkaya/filament-phone-input
Admin
A Laravel Filament package that provides a phone input component with country dropdowns, flags, and...
Tokens:57,318
Snippets:393
Trust Score:8.7
License:MIT
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Install the package using Composer.

```bash
composer require ysfkaya/filament-phone-input
```

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

### setUp() with IP lookup and state hooks

Source: https://github.com/ysfkaya/filament-phone-input

Wires two state-transform hooks and a default IP lookup callback that issues GET https://ipinfo.io/json and returns the country field; on failure rescue() falls back to app()->getLocale() without reporting.

```php
protected function setUp(): void
{
    parent::setUp();

    $this->ipLookup(function () {
        return rescue(fn () => Http::get('https://ipinfo.io/json')->json('country'), app()->getLocale(), report: false);
    });

    $this->afterStateHydrated(/* re-formats state on hydrate */);
    $this->mutateDehydratedStateUsing(/* re-formats state on dehydrate */);
}
```

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

### Install commands for assets and package

Source: https://github.com/ysfkaya/filament-phone-input

Run these artisan commands to publish Filament assets and run the package install command. The install command chains publishAssets() and, unless --no-interaction is passed, prompts to star the repo.

```bash
php artisan filament:assets
php artisan filament-phone-input:install
```

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

### setUp lifecycle method

Source: https://github.com/ysfkaya/filament-phone-input

Sets default display format to PhoneInputNumberType::NATIONAL during component setup.

```php
protected function setUp(): void
{
    parent::setUp();

    $this->displayFormat(PhoneInputNumberType::NATIONAL);
}
```

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

### Usage Example

Source: https://github.com/ysfkaya/filament-phone-input

Demonstrates calling toLibPhoneNumberFormat() and handling the return type for both distributions.

```php
use Ysfkaya\FilamentPhoneInput\PhoneInputNumberType;
use libphonenumber\PhoneNumberFormat;

$format = PhoneInputNumberType::RFC3966->toLibPhoneNumberFormat();

if (is_int($format)) {
    // lite distribution: integer format constant
} else {
    // $format instanceof PhoneNumberFormat
    echo $format === PhoneNumberFormat::RFC3966 ? 'tel:...' : 'other';
}
```

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

### configurePackage() method

Source: https://github.com/ysfkaya/filament-phone-input

Configures the package with name 'filament-phone-input', registers views, and adds an install command that publishes assets and prompts to star the repo on GitHub unless --no-interaction is passed.

```php
public function configurePackage(Package $package): void
{
    $package
        ->name('filament-phone-input')
        ->hasViews()
        ->hasInstallCommand(function (InstallCommand $command) {
            $command->publishAssets();

            $command->startWith(function ($command) {
                $noInteraction = $command->option('no-interaction');

                if ($noInteraction) {
                    return;
                }

                $command->askToStarRepoOnGitHub('ysfkaya/filament-phone-input');
            });
        });
}
```

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

### Usage with Form, Table, and Infolist

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Shows how to integrate PhoneInput, PhoneColumn, and PhoneEntry into Filament resources. Includes imports and example methods for infolists, forms, and tables.

```php
use Filament\Forms;
use Filament\Forms\Form;
use Filament\Tables;
use Filament\Tables\Table;
use Filament\Infolists;
use Filament\Infolists\Infolist;
use Ysfkaya\FilamentPhoneInput\Forms\PhoneInput;
use Ysfkaya\FilamentPhoneInput\Tables\PhoneColumn;
use Ysfkaya\FilamentPhoneInput\Infolists\PhoneEntry;
use Ysfkaya\FilamentPhoneInput\PhoneInputNumberType;

  
    public static function infolists(Infolist $infolist): Infolist
    {
        return $infolist
            ->columns([
                Infolists\Components\TextEntry::make('name'),
                Tables\Columns\TextColumn::make('email'),
                PhoneEntry::make('phone')->displayFormat(PhoneInputNumberType::NATIONAL),
            ]);
    }

    public static function form(Form $form): Form
    {
        return $form
            ->schema([
                Forms\Components\TextInput::make('name')
                    ->required(),

                Forms\Components\TextInput::make('email')
                    ->required()
                    ->email()
                    ->unique(ignoreRecord: true),

                PhoneInput::make('phone'),
            ]);
    }

    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                Tables\Columns\TextColumn::make('name')
                    ->sortable()
                    ->searchable(),
                Tables\Columns\TextColumn::make('email')
                    ->sortable()
                    ->searchable(),

                PhoneColumn::make('phone')->displayFormat(PhoneInputNumberType::NATIONAL)
            ]);
    }
```

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

### displayFormat usage with countryColumn and INTERNATIONAL

Source: https://github.com/ysfkaya/filament-phone-input

Shows how to combine countryColumn with displayFormat for international formatting, and a separate RFC3966 example.

```php
PhoneEntry::make('phone')
    ->countryColumn('phone_country')
    ->displayFormat(PhoneInputNumberType::INTERNATIONAL);
```

```php
// See also RFC3966 (clickable tel: link):
PhoneEntry::make('phone')->displayFormat(PhoneInputNumberType::RFC3966);
```

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

### Usage examples for PhoneColumn

Source: https://github.com/ysfkaya/filament-phone-input

Shows how to use PhoneColumn with countryColumn and displayFormat for E164 and RFC3966 formats.

```php
use Ysfkaya\FilamentPhoneInput\Tables\PhoneColumn;
use Ysfkaya\FilamentPhoneInput\PhoneInputNumberType;

PhoneColumn::make('phone')
    ->countryColumn('phone_country')                       // country comes from the row
    ->displayFormat(PhoneInputNumberType::E164);           // +905301111111

// RFC3966 renders a clickable tel: link and disables column click:
PhoneColumn::make('phone')->displayFormat(PhoneInputNumberType::RFC3966);
```

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

### Custom Geo IP Lookup with ipLookup

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets a custom geoIp lookup function. The example uses ipinfo.io and falls back to the app locale on failure.

```php
PhoneInput::make('phone')
    ->ipLookup(function () {
        return rescue(fn () => Http::get('https://ipinfo.io/json')->json('country'), app()->getLocale(), report: false);
    })
```

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

### Default ipLookup callback using ipinfo.io

Source: https://github.com/ysfkaya/filament-phone-input

Default ipLookup callback set in setUp() (src/Forms/PhoneInput.php, line 99). Performs a GET to https://ipinfo.io/json and returns the 'country' field. On failure, rescue() returns app()->getLocale() (e.g. 'en') with report: false — note this fallback is a locale string, not a country code. Can be replaced with PhoneInput::ipLookup(Closure) or disabled with disableLookup() / enableIpLookup(false).

```php
$this->ipLookup(function () {
    return rescue(fn () => Http::get('https://ipinfo.io/json')->json('country'), app()->getLocale(), report: false);
});
```

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

### defaultCountry usage example

Source: https://github.com/ysfkaya/filament-phone-input

Sets a default country code for parsing the phone state.

```php
PhoneEntry::make('phone')->defaultCountry('US');
```

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

### countryColumn usage example

Source: https://github.com/ysfkaya/filament-phone-input

Uses a record attribute to determine the country code for each record.

```php
PhoneEntry::make('phone')->countryColumn('phone_country');
```

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

### Usage example: inputNumberFormat, displayNumberFormat, focusNumberFormat

Source: https://github.com/ysfkaya/filament-phone-input

Shows how to set the input, display, and focus number formats using PhoneInputNumberType enums. The inputNumberFormat sets the database value (e.g., E164), displayNumberFormat controls what the input shows (e.g., NATIONAL), and focusNumberFormat applies while the field is focused. Passing false to focusNumberFormat disables re-formatting on focus.

```php
PhoneInput::make('phone')
    ->inputNumberFormat(PhoneInputNumberType::E164)      // DB value: +905301111111
    ->displayNumberFormat(PhoneInputNumberType::NATIONAL) // input shows: 0530 111 11 11
    ->focusNumberFormat(PhoneInputNumberType::INTERNATIONAL);
```

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

### ipLookup() usage

Source: https://github.com/ysfkaya/filament-phone-input

Stores a callback resolving to a country code (ISO2). The default callback hits https://ipinfo.io/json, falling back to app()->getLocale() on failure. This example uses Http::get with a rescue fallback to 'US'.

```php
PhoneInput::make('phone')
    ->ipLookup(fn () => rescue(Http::get('https://ipinfo.io/json')->json('country'), 'US', report: false));
```

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

### Prepare testing environment

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Run this command to set up the testing environment before running tests.

```bash
composer prepare-test
```

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

### Run tests

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Run this command to execute the test suite.

```bash
composer test
```

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

### packageBooted() method

Source: https://github.com/ysfkaya/filament-phone-input

Registers Filament CSS and Alpine JS assets (CSS loaded on request) and publishes intl-tel-input flag/globe images to public/vendor/filament-phone-input under two publish groups.

```php
public function packageBooted(): void
{
    FilamentAsset::register([
        Css::make('filament-phone-input', __DIR__ . '/../dist/css/filament-phone-input.css')->loadedOnRequest(),
        AlpineComponent::make('filament-phone-input', __DIR__ . '/../dist/js/filament-phone-input.js'),
    ], package: 'ysfkaya/filament-phone-input');

    $this->publishes([
        $this->package->basePath('/../images/vendor/intl-tel-input/build') => public_path("vendor/{$this->package->shortName()}"),
    ], "{$this->package->shortName()}-assets");

    $this->publishes([
        $this->package->basePath('/../images/vendor/intl-tel-input/build') => public_path("vendor/{$this->package->shortName()}"),
    ], 'public');
}
```

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

### Service provider: FilamentPhoneInputServiceProvider

Source: https://github.com/ysfkaya/filament-phone-input

Documentation for the `FilamentPhoneInputServiceProvider` service provider.

```APIDOC
## Service provider: `FilamentPhoneInputServiceProvider`

### Description
Documentation for the `FilamentPhoneInputServiceProvider` service provider.

### Reference
See [Service provider: `FilamentPhoneInputServiceProvider`](api-reference/service-provider.md) for full details.
```

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

### Show Fullscreen Popup with useFullscreenPopup

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Enables fullscreen popup on mobile devices.

```php
PhoneInput::make('phone')
    ->useFullscreenPopup(),
```

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

### PhoneInput Component Methods

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Shows the available methods for configuring the PhoneInput component, including country state path, validation, default country, IP lookup, number formatting, dropdown options, and more.

```php
PhoneInput::make(string $name)
    ->countryStatePath(string | Closure $statePath, bool $isStatePathAbsolute)
    ->validateFor(string | array $country = 'AUTO', int | array | null $type = null, bool $lenient = false)
    ->defaultCountry(string $value)
    ->ipLookup(Closure $callback)
    ->disableLookup()
    ->enableIpLookup(bool | Closure $value = true)
    ->inputNumberFormat(PhoneInputNumberType | Closure $format)
    ->displayNumberFormat(PhoneInputNumberType | Closure $format)
    ->focusNumberFormat(PhoneInputNumberType | Closure $format)
    ->placeholderNumberType(PhoneInputNumberType | Closure $format)
    ->disallowDropdown()
    ->allowDropdown(bool | Closure $value = true)
    ->autoPlaceholder(string $value = 'polite')
    ->containerClass(string | Closure $value)
    ->countryOrder(array | Closure | null $value)
    ->countrySearch(bool | Closure $value = true)
    ->customPlaceholder(string | RawJs | Closure | null $value)
    ->dropdownContainer(string | null | Closure $value)
    ->excludeCountries(array | Closure $value)
    ->fixDropdownWidth(bool | Closure $value = true)
    ->formatAsYouType(bool | Closure $value = true)
    ->formatOnDisplay(bool | Closure $value = true)
    ->i18n(array | Closure $value)
    ->initialCountry(string | Closure $value)
    ->nationalMode(bool | Closure $value = true)
    ->onlyCountries(array | Closure $value)
    ->showFlags(bool | Closure $value = true)
    ->separateDialCode(bool | Closure $value = true)
    ->useFullscreenPopup(bool | Closure $value = true)
    ->strictMode(bool | Closure $value = true)
    ->cookieName(string | Closure $value)
    ->locale(string | Closure $value)
    ->customOptions(array | Closure $value)
```

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

### countryStatePath() usage example

Source: https://github.com/ysfkaya/filament-phone-input

Binds the selected country to a separate form state path (saved to its own column). The $isStatePathAbsolute parameter defaults to false; when true, the path is treated as absolute and resolveRelativeStatePath() is skipped.

```php
PhoneInput::make('phone')
    ->countryStatePath('phone_country')
    ->inputNumberFormat(PhoneInputNumberType::E164);
```

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

### displayFormat method implementation

Source: https://github.com/ysfkaya/filament-phone-input

Formats the phone state using the propaganistas phone() helper, producing an HTML link or span depending on the format.

```php
public function displayFormat(PhoneInputNumberType $format)
{
    return $this->formatStateUsing(function (PhoneEntry $entry, $state) use ($format) {
        // ...
        $formatted = phone(
            number: $state,
            country: $country,
            format: $format
        );

        if ($format === PhoneNumberFormat::RFC3966) {
            // <a href="tel:..." dir="ltr">$national</a>
        } else {
            // <span dir="ltr">$formatted</span>
        }

        return new HtmlString($html);
        // ...
    });
}
```

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

### Outbound HTTP - Geo-IP country lookup

Source: https://github.com/ysfkaya/filament-phone-input

Default outbound HTTP call made by the package during handleLookup to retrieve the country from ipinfo.io. It is a GET request to https://ipinfo.io/json and returns the 'country' field from the JSON response.

```APIDOC
## [GET] https://ipinfo.io/json

### Description
Default outbound HTTP call made by the package during handleLookup to retrieve the country from ipinfo.io. It is a GET request to https://ipinfo.io/json and returns the 'country' field from the JSON response.

### Method
GET

### Endpoint
https://ipinfo.io/json

### Parameters
None

### Response
#### Success Response (200)
- `country` (string) - ISO2 country code (e.g. `"TR"`)

### Failure Behavior
- Returns `app()->getLocale()` (e.g. `'en'`) with `report: false` via `rescue()`.
```

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

### useFullscreenPopup

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Enables a fullscreen popup for country selection on mobile devices.

```APIDOC
## useFullscreenPopup

### Description
Enables a fullscreen popup for country selection on mobile devices.

### Method
`useFullscreenPopup`

### Parameters
None

### Example
```php
PhoneInput::make('phone')
    ->useFullscreenPopup(),
```
```

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

### defaultCountry(string|Closure $value): static / getDefaultCountry(): ?string

Source: https://github.com/ysfkaya/filament-phone-input

Sets or gets the country used by `phoneFormat()` when the country could not be resolved otherwise. The README recommends this to avoid 'Number requires a country to be specified' parse errors for legacy data.

```APIDOC
## defaultCountry(string|Closure $value): static / getDefaultCountry(): ?string

### Description
Sets/gets the country used by `phoneFormat()` when the country could not be resolved otherwise (`$country ??= $this->getDefaultCountry() ?? []`).

### Parameters
- **$value** (string|Closure) - Required - The country code to set as default.

### Returns
- `defaultCountry()`: `static` - The current instance for chaining.
- `getDefaultCountry()`: `?string` - The default country code, or `null` if not set.

### Request Example
```php
PhoneInput::make('phone')->defaultCountry('US');
```
```

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

### Using validateFor() with country, type, and lenient

Source: https://github.com/ysfkaya/filament-phone-input

Example usage of validateFor() with named arguments: country array ['US', 'GB'], type PhoneNumberType::MOBILE, and lenient false. Validation failures surface as normal Filament form errors on the field's state path; add a translation for the Laravel Phone rule to resources/lang/vendor/validation.php.

```php
use libphonenumber\PhoneNumberType;

PhoneInput::make('phone')
    ->validateFor(country: ['US', 'GB'], type: PhoneNumberType::MOBILE, lenient: false);

// Error handling: validation failures surface as normal Filament form errors
// on the field's state path; add a translation for the Laravel Phone rule to
// resources/lang/vendor/validation.php (see package README).
```

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

### Custom Container with customContainer

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Adds additional classes to the parent div.

```php
PhoneInput::make('phone')
    ->customContainer('w-full'),
```

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

### Publish commands for assets

Source: https://github.com/ysfkaya/filament-phone-input

Publish the bundled intl-tel-input flag/globe images to public/vendor/filament-phone-input. Both commands publish identical content; use either the asset-tag group or the standard public group.

```bash
php artisan vendor:publish --tag=filament-phone-input-assets
# or
php artisan vendor:publish --tag=public
```

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

### JavaScript Alpine component: phoneInputFormComponent

Source: https://github.com/ysfkaya/filament-phone-input

Documentation for the `phoneInputFormComponent` JavaScript Alpine component.

```APIDOC
## JavaScript Alpine component: `phoneInputFormComponent`

### Description
Documentation for the `phoneInputFormComponent` JavaScript Alpine component.

### Reference
See [JavaScript Alpine component: `phoneInputFormComponent`](api-reference/javascript-phoneinputformcomponent.md) for full details.
```

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

### PhoneInput::make

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Creates a new phone input field instance for Filament forms. This is the entry point for using the phone input component.

```APIDOC
## PhoneInput::make

### Description
Creates a new phone input field instance for Filament forms. This is the entry point for using the phone input component.

### Method
`PhoneInput::make`

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

### Return Value
Returns a new instance of the phone input component.

### Example
```php
PhoneInput::make('phone')
```
```

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

### Configure i18n with i18n

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Configures localization strings for the component. See intl-tel-input i18n documentation for more information.

```php
PhoneInput::make('phone')
    ->i18n([
        // Country names
        'fr' => "Frankreich",
        'de' => "Deutschland",
        'es' => "Spanien",
        'it' => "Italien",
        'ch' => "Schweiz",
        'nl' => "Niederlande",
        'at' => "Österreich",
        'dk' => "Dänemark",
        // Other plugin text
        "selectedCountryAriaLabel" =>'Ausgewähltes Land',
        "countryListAriaLabel" =>'Liste der Länder',
        "searchPlaceholder" =>'Suchen',
    ]),
```

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

### i18n

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Configures localization strings for the component.

```APIDOC
## i18n

### Description
Configures localization strings for the component.

### Method
`i18n`

### Parameters
- **translations** (array) - Required - Associative array of translation strings.

### Example
```php
PhoneInput::make('phone')
    ->i18n([
        // Country names
        'fr' => "Frankreich",
        'de' => "Deutschland",
        'es' => "Spanien",
        'it' => "Italien",
        'ch' => "Schweiz",
        'nl' => "Niederlande",
        'at' => "Österreich",
        'dk' => "Dänemark",
        // Other plugin text
        "selectedCountryAriaLabel" =>'Ausgewähltes Land',
        "countryListAriaLabel" =>'Liste der Länder',
        "searchPlaceholder" =>'Suchen',
    ]),
```
```

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

### Infolists: PhoneEntry

Source: https://github.com/ysfkaya/filament-phone-input

Documentation for the PhoneEntry infolist component.

```APIDOC
## Infolists: `PhoneEntry`

### Description
Documentation for the `PhoneEntry` infolist component.

### Reference
See [Infolists: `PhoneEntry`](api-reference/infolists-phoneentry.md) for full details.
```

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

### Set Auto Placeholder with autoPlaceholder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the auto placeholder type. Default is 'polite'.

```php
PhoneInput::make('phone')
    ->autoPlaceholder('aggressive'), // default is 'polite'
```

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

### handleLookup() method signature

Source: https://github.com/ysfkaya/filament-phone-input

Livewire-exposed RPC method invoked by the frontend JS geo-IP lookup via $wire.callSchemaComponentMethod($key, 'handleLookup'). Takes no arguments and returns array{country: string} when canPerformIpLookup() is true and performIpLookup() yields a non-empty country; otherwise returns null.

```php
#[ExposedLivewireMethod]
#[Renderless]
public function handleLookup()
```

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

### initialCountry

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the initial country for the phone input.

```APIDOC
## initialCountry

### Description
Sets the initial country for the phone input.

### Method
`initialCountry`

### Parameters
- **country** (string) - Required - The country code (e.g., 'us').

### Example
```php
PhoneInput::make('phone')
    ->initialCountry('us'),
```
```

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

### Set Initial Country with initialCountry

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the initial country for the phone input.

```php
PhoneInput::make('phone')
    ->initialCountry('us'),
```

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

### locale

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the locale for the component. Default is from `app()->getLocale()`.

```APIDOC
## locale

### Description
Sets the locale for the component. Default is from `app()->getLocale()`.

### Method
`locale`

### Parameters
- **locale** (string) - Required - The locale code (e.g., 'en').

### Example
```php
PhoneInput::make('phone')
    ->locale('en'),
```
```

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

### Class declaration of FilamentPhoneInputServiceProvider

Source: https://github.com/ysfkaya/filament-phone-input

Shows the service provider class extending PackageServiceProvider with two methods. The actual implementations are shown in separate snippets below.

```php
class FilamentPhoneInputServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void { ... }
    public function packageBooted(): void { ... }
}
```

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

### Format On Display with formatOnDisplay

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Controls whether the number is formatted on display.

```php
PhoneInput::make('phone')
    ->formatOnDisplay(false),
```

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

### Set Placeholder Number Type with placeholderNumberType

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the placeholder number type.

```php
PhoneInput::make('phone')
    ->placeholderNumberType('FIXED_LINE'),
```

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

### PhoneInput::customOptions

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets custom options for the underlying intl-tel-input library. This allows passing additional configuration options.

```APIDOC
## PhoneInput::customOptions

### Description
Sets custom options for the underlying intl-tel-input library. This allows passing additional configuration options.

### Method
`customOptions`

### Parameters
- **$value** (array | Closure) - Required - An array of custom options.

### Return Value
Returns the component instance for chaining.

### Example
```php
PhoneInput::make('phone')
    ->customOptions(['allowDropdown' => true])
```
```

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

### countryOrder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the order of countries in the dropdown.

```APIDOC
## countryOrder

### Description
Sets the order of countries in the dropdown.

### Method
`countryOrder`

### Parameters
- **countries** (array) - Required - Array of country codes in desired order.

### Example
```php
PhoneInput::make('phone')
    ->countryOrder(['us', 'gb', 'tr']),
```
```

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

### Set Country Order with countryOrder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the order of countries in the dropdown.

```php
PhoneInput::make('phone')
    ->countryOrder(['us', 'gb', 'tr']),
```

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

### ipLookup(Closure $callback): static / performIpLookup()

Source: https://github.com/ysfkaya/filament-phone-input

Stores a callback that resolves to a country code (ISO2) and runs it to perform an IP-based country lookup. The default callback hits `https://ipinfo.io/json`, falling back to `app()->getLocale()` on failure.

```APIDOC
## ipLookup(Closure $callback): static / performIpLookup()

### Description
`ipLookup()` stores a callback resolving to a country code (ISO2); `performIpLookup()` runs `$this->evaluate($this->ipLookupCallback)`. Default callback hits `https://ipinfo.io/json`, falling back to `app()->getLocale()` on failure.

### Parameters
- **$callback** (Closure) - Required - A callback that returns a country code (ISO2).

### Returns
- `ipLookup()`: `static` - The current instance for chaining.
- `performIpLookup()`: mixed - The result of the evaluated callback.

### Request Example
```php
PhoneInput::make('phone')
    ->ipLookup(fn () => rescue(Http::get('https://ipinfo.io/json')->json('country'), 'US', report: false));
```
```

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

### Blade layout with required scripts

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

A Blade layout that includes the necessary scripts for the PhoneInput to work outside of Filament. It includes the CSRF token meta tag and loads async-alpine and alpine-lazy-load-assets from CDNs.

```blade
{{-- views/components/layouts/app.blade.php --}}
<html>
<head>
    <meta name="csrf-token" content="{{ csrf_token() }}">

    <script
        src="https://cdn.jsdelivr.net/npm/async-alpine@1.x.x/dist/async-alpine.script.js"
        defer
    ></script>
    <script
        src="https://unpkg.com/alpine-lazy-load-assets@latest/dist/alpine-lazy-load-assets.cdn.js"
        defer
    ></script>
</head>
<body>
    {{ $slot }}

    @stack('scripts')
</body>
</html>
```

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

### placeholderNumberType

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the placeholder number type for the phone input.

```APIDOC
## placeholderNumberType

### Description
Sets the placeholder number type for the phone input.

### Method
`placeholderNumberType`

### Parameters
- **type** (string) - Required - The placeholder number type (e.g., 'FIXED_LINE').

### Example
```php
PhoneInput::make('phone')
    ->placeholderNumberType('FIXED_LINE'),
```
```

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

### autoPlaceholder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the auto placeholder type for the phone input. Default is 'polite'.

```APIDOC
## autoPlaceholder

### Description
Sets the auto placeholder type for the phone input. Default is 'polite'.

### Method
`autoPlaceholder`

### Parameters
- **type** (string) - Required - The placeholder type (e.g., 'aggressive').

### Example
```php
PhoneInput::make('phone')
    ->autoPlaceholder('aggressive'), // default is 'polite'
```
```

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

### Only Countries with onlyCountries

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Restricts the dropdown to only the specified countries.

```php
PhoneInput::make('phone')
    ->onlyCountries(['tr','us', 'gb']),
```

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

### PhoneInput configuration properties with defaults

Source: https://github.com/ysfkaya/filament-phone-input

Lists all protected configuration properties with their default values, resolved lazily via evaluate() so each may be a Closure. Defaults include displayNumberFormat = NATIONAL, inputNumberFormat = E164, and cookieName = 'intlTelInputSelectedCountry'.

```php
protected string | Closure | PhoneInputNumberType $displayNumberFormat = PhoneInputNumberType::NATIONAL;
protected string | Closure | PhoneInputNumberType $inputNumberFormat = PhoneInputNumberType::E164;
protected bool $hasExplicitInputNumberFormat = false;
protected string | false | Closure | PhoneInputNumberType $focusNumberFormat = false;
protected string | Closure $placeholderNumberType = 'MOBILE';
protected bool | Closure $allowDropdown = true;
protected string | Closure $autoPlaceholder = 'polite';
protected bool | Closure $countrySearch = true;
protected bool | Closure $formatAsYouType = true;
protected string | null | Closure $dropdownContainer = null;
protected array | Closure $excludeCountries = [];
protected bool | Closure $formatOnDisplay = true;
protected string | Closure $initialCountry = 'auto';
protected string | Closure $containerClass = '';
protected array | Closure $i18n = [];
protected bool | Closure $nationalMode = true;
protected bool | Closure $fixDropdownWidth = true;
protected array | Closure $onlyCountries = [];
protected array | null | Closure $countryOrder = null;
protected string | RawJs | Closure | null $customPlaceholder = null;
protected bool | Closure $showFlags = true;
protected bool | Closure $separateDialCode = false;
protected bool | Closure $useFullscreenPopup = false;
protected bool | Closure $isStrictMode = false;
protected array | Closure $customOptions = [];
protected string | Closure $cookieName = 'intlTelInputSelectedCountry';
protected ?Closure $ipLookupCallback = null;
protected bool | Closure $performIpLookup = true;
protected string | Closure | null $countryStatePath = null;
protected string | Closure | null $defaultCountry = null;
protected bool $countryStatePathIsAbsolute = false;
protected string | array $validatedCountry = [];
protected string | Closure | null $locale = null;
```

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

### PhoneInput::handleLookup() Livewire RPC method

Source: https://github.com/ysfkaya/filament-phone-input

Livewire-exposed RPC method invoked by the frontend via $wire.callSchemaComponentMethod(key, 'handleLookup'). Returns an array with 'country' (ISO2) on success, or null when canPerformIpLookup() is false or the lookup returns a falsy country. Guarded by canPerformIpLookup(); failures in the default callback are caught by rescue() and not surfaced.

```php
#[ExposedLivewireMethod]
#[Renderless]
public function handleLookup()
{
    if (! $this->canPerformIpLookup()) {
        return;
    }

    $country = $this->performIpLookup();

    if (! $country) {
        return;
    }

    return [
        'country' => $country,
    ];
}
```

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

### isAllowDropdown(): bool

Source: https://github.com/ysfkaya/filament-phone-input

Returns whether the country dropdown is allowed.

```APIDOC
## isAllowDropdown(): bool

### Description
Returns whether the country dropdown is allowed.

### Method
isAllowDropdown

### Returns
bool
```

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

### displayFormat(PhoneInputNumberType $format)

Source: https://github.com/ysfkaya/filament-phone-input

Sets the output format for the phone number using the propaganistas phone() helper. Supports NATIONAL, INTERNATIONAL, and RFC3966 formats; RFC3966 renders a clickable tel: link.

```APIDOC
## displayFormat(PhoneInputNumberType $format)

### Description
Sets the output format for the phone number using the propaganistas phone() helper. Supports NATIONAL, INTERNATIONAL, and RFC3966 formats; RFC3966 renders a clickable tel: link.

### Method
`displayFormat`

### Parameters
- **$format** (PhoneInputNumberType) - Required - Output format produced by the propaganistas phone() helper.

### Returns
`$this` (the formatStateUsing() fluent chain)

### Behavior
- Country resolution order: `$country = $this->getDefaultCountry() ?? [];` then, when `$countryColumn` is set, `$country = $entry->getCountryState();` — i.e. a country column overrides the default country.
- RFC3966 rendering: produces `<a href="tel:+90-530-111-11-11" dir="ltr">0530 111 11 11</a>` (national format shown as link text).
- Wraps phone() in try/catch (NumberParseException $e) and returns the raw $state unformatted on parse failure — formatting degradation is silent.

### Example
```php
PhoneEntry::make('phone')
    ->countryColumn('phone_country')
    ->displayFormat(PhoneInputNumberType::INTERNATIONAL);

// See also RFC3966 (clickable tel: link):
PhoneEntry::make('phone')->displayFormat(PhoneInputNumberType::RFC3966);
```
```

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

### strictMode

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Enables strict mode to ignore irrelevant characters as the user types.

```APIDOC
## strictMode

### Description
Enables strict mode to ignore irrelevant characters as the user types.

### Method
`strictMode`

### Parameters
None

### Example
```php
PhoneInput::make('phone')
    ->strictMode(),
```
```

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

### Enable Strict Mode with strictMode

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Ignores irrelevant characters as the user types. See intl-tel-input documentation for details.

```php
PhoneInput::make('phone')
    ->strictMode(),
```

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

### PhoneInput::customPlaceholder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets a custom placeholder for the input. This overrides the default placeholder.

```APIDOC
## PhoneInput::customPlaceholder

### Description
Sets a custom placeholder for the input. This overrides the default placeholder.

### Method
`customPlaceholder`

### Parameters
- **$value** (string | RawJs | Closure | null) - Required - The custom placeholder text or a RawJs expression.

### Return Value
Returns the component instance for chaining.

### Example
```php
PhoneInput::make('phone')
    ->customPlaceholder('Enter your phone number')
```
```

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

### Option setters/getters (intl-tel-input passthrough)

Source: https://github.com/ysfkaya/filament-phone-input

Lists all option setter and getter methods for the Filament PhoneInput component, each with its signature, default value, and line number. Setters accept a Closure for lazy evaluation; getters return the current value. Notable defaults: autoPlaceholder 'polite', countrySearch true, initialCountry 'auto', nationalMode true, showFlags true, separateDialCode false, strictMode false, cookieName 'intlTelInputSelectedCountry', locale falls back to app()->getLocale().

```php
public function autoPlaceholder(string | Closure $value): static   // line 368  |  default 'polite'
public function getAutoPlaceholder(): string                       // line 375

public function containerClass(string | Closure $value): static    // line 380  |  default ''
public function getContainerClass(): string                        // line 387

public function countryOrder(array | Closure | null $value): static // line 392  |  default null
public function getCountryOrder(): ?array                          // line 399

public function countrySearch(bool | Closure $value = true): static // line 404  |  default true
public function isCountrySearch(): bool                            // line 411

public function customPlaceholder(string | RawJs | Closure | null $value): static // line 416 | default null
public function getCustomPlaceholder(): ?RawJs                     // line 423

public function dropdownContainer(string | null | Closure $value): static // line 428 | default null
public function getDropdownContainer(): ?string                    // line 435

public function excludeCountries(array | Closure $value): static    // line 440  |  default []
public function getExcludeCountries(): array                       // line 447

public function fixDropdownWidth(bool | Closure $value = true): static // line 452 | default true
public function isFixDropdownWidth(): bool                         // line 459

public function formatAsYouType(bool | Closure $value = true): static // line 464 | default true
public function isFormatAsYouType(): bool                           // line 471

public function formatOnDisplay(bool | Closure $value = true): static // line 476 | default true
public function isFormatOnDisplay(): bool                           // line 483

public function i18n(array | Closure $value): static               // line 488  |  default []
public function getI18n(): array                                   // line 495

public function initialCountry(string | Closure $value): static    // line 500  |  default 'auto'
public function getInitialCountry(): string                        // line 507

public function nationalMode(bool | Closure $value = true): static  // line 512  |  default true
public function isNationalMode(): bool                              // line 519

public function onlyCountries(array | Closure $value): static       // line 524  |  default []
public function getOnlyCountries(): array                           // line 531

public function placeholderNumberType(string | Closure $value): static // line 536 | default 'MOBILE'
public function getPlaceholderNumberType(): string                 // line 543

public function showFlags(bool | Closure $value = true): static     // line 548  |  default true
public function isShowFlags(): bool                                 // line 555

public function separateDialCode(bool | Closure $value = true): static // line 560 | default false
public function isSeparateDialCode(): bool                         // line 567

public function useFullscreenPopup(bool | Closure $value = true): static // line 572 | default false
public function isUseFullscreenPopup(): bool                       // line 579

public function strictMode(bool | Closure $value = true): static    // line 584  |  default false
public function isStrictMode(): bool                                // line 591

public function cookieName(string | Closure $value): static         // line 596  |  default 'intlTelInputSelectedCountry'
public function getCookieName(): string                             // line 603

public function locale(string | Closure $value): static              // line 608  |  default null → app()->getLocale()
public function getLocale(): string                                 // line 615

public function customOptions(array | Closure $value): static        // line 620  |  default []
public function getCustomOptions(): array                           // line 627
```

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

### customContainer

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Adds additional CSS classes to the parent div of the phone input.

```APIDOC
## customContainer

### Description
Adds additional CSS classes to the parent div of the phone input.

### Method
`customContainer`

### Parameters
- **classes** (string) - Required - Additional CSS classes.

### Example
```php
PhoneInput::make('phone')
    ->customContainer('w-full'),
```
```

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

### containerClass / getContainerClass

Source: https://github.com/ysfkaya/filament-phone-input

Sets or retrieves the container class for the phone input. The default value is an empty string.

```APIDOC
## containerClass / getContainerClass

### Description
Sets or retrieves the container class for the phone input. The default value is an empty string.

### Method
setter/getter

### Signature
```php
public function containerClass(string | Closure $value): static
public function getContainerClass(): string
```

### Parameters
- `$value` (string | Closure) - Required - The container class, can be a string or a Closure for lazy evaluation.

### Returns
- `static` for the setter, `string` for the getter.
```

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

### Forms: PhoneInput

Source: https://github.com/ysfkaya/filament-phone-input

Documentation for the PhoneInput form component. It is version-sensitive and requires Filament v4/v5 APIs.

```APIDOC
## Forms: `PhoneInput`

### Description
Documentation for the `PhoneInput` form component. It is version-sensitive and requires Filament v4/v5 APIs.

### Reference
See [Forms: `PhoneInput`](api-reference/forms-phoneinput.md) for full details.
```

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

### countrySearch

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Enables or disables the country search feature. Default is active.

```APIDOC
## countrySearch

### Description
Enables or disables the country search feature. Default is active.

### Method
`countrySearch`

### Parameters
- **enabled** (bool) - Required - Set to `false` to disable search.

### Example
```php
PhoneInput::make('phone')
    ->countrySearch(false),
```
```

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

### ipLookup

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets a custom geoIp lookup function to determine the initial country.

```APIDOC
## ipLookup

### Description
Sets a custom geoIp lookup function to determine the initial country.

### Method
`ipLookup`

### Parameters
- **callback** (callable) - Required - A function that returns the country code.

### Example
```php
PhoneInput::make('phone')
    ->ipLookup(function () {
        return rescue(fn () => Http::get('https://ipinfo.io/json')->json('country'), app()->getLocale(), report: false);
    })
```
```

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

### Set Locale with locale

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the locale for the component. Default is from app()->getLocale().

```php
PhoneInput::make('phone')
    ->locale('en'),
```

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

### PhoneInput::autoPlaceholder

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Sets the auto placeholder mode. This controls how the placeholder is automatically generated.

```APIDOC
## PhoneInput::autoPlaceholder

### Description
Sets the auto placeholder mode. This controls how the placeholder is automatically generated.

### Method
`autoPlaceholder`

### Parameters
- **$value** (string) - Optional - The auto placeholder mode. Default is 'polite'.

### Return Value
Returns the component instance for chaining.

### Example
```php
PhoneInput::make('phone')
    ->autoPlaceholder('aggressive')
```
```

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

### Livewire component using PhoneInput

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

A Livewire component that integrates the PhoneInput form field outside of Filament. It uses the InteractsWithForms trait, defines a form with a PhoneInput field, and fills the form on mount.

```php
<?php

use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Forms\Contracts\HasForms;
use Filament\Forms\Form;
use Illuminate\Support\Facades\View;
use Livewire\Component as Livewire;
use Ysfkaya\FilamentPhoneInput\Forms\PhoneInput;

class Component extends Livewire implements HasForms
{
    use InteractsWithForms;

    public array $data = [];

    public function mount()
    {
        // Do not forget to fill the form
        $this->form->fill();
    }

    public function form(Form $form): Form
    {
        return $form
            ->schema([
                PhoneInput::make('phone'),
            ])->statePath('data');
    }

    public function render()
    {
        return view('livewire.component');
    }
}
```

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

### displayFormat method implementation

Source: https://github.com/ysfkaya/filament-phone-input

Formats the phone state using the phone() helper, wraps output in HtmlString, and disables column click for RFC3966 format.

```php
public function displayFormat(PhoneInputNumberType $format)
{
    return $this->formatStateUsing(function (PhoneColumn $column, $state) use ($format) {
        $formatted = phone(
            number: $state,
            country: $country,
            format: $format
        );

        if ($format === PhoneNumberFormat::RFC3966) {
            // <a href="$formatted" dir="ltr">$national</a>
        } else {
            // <span dir="ltr">$formatted</span>
        }

        return new HtmlString($html);
    })->when(
        $format === PhoneInputNumberType::RFC3966,
        fn (PhoneColumn $column) => $column->disabledClick()
    );
}
```

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

### formatAsYouType

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Controls automatic formatting of the number as the user types.

```APIDOC
## formatAsYouType

### Description
Controls automatic formatting of the number as the user types.

### Method
`formatAsYouType`

### Parameters
- **enabled** (bool) - Required - Set to `false` to disable formatting.

### Example
```php
PhoneInput::make('phone')
    ->formatAsYouType(false),
```
```

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

### Number format method signatures (inputNumberFormat, displayNumberFormat, focusNumberFormat)

Source: https://github.com/ysfkaya/filament-phone-input

Lists the public method signatures for configuring number formats in the Filament phone input field. The inputNumberFormat() method also sets hasExplicitInputNumberFormat to true, which affects dehydrate behavior when a country state path is used. Note that displayNumberFormat() and focusNumberFormat() dereference $format->value unconditionally, so passing a Closure raises an Error at call time despite the union type; prefer passing the enum directly.

```php
public function inputNumberFormat(PhoneInputNumberType | Closure $format): static   // line 297
public function hasExplicitInputNumberFormat(): bool                               // line 305
public function getInputNumberFormat(): string                                     // line 310
public function displayNumberFormat(PhoneInputNumberType | Closure $format): static // line 317
public function getDisplayNumberFormat(): string                                   // line 324
public function focusNumberFormat(PhoneInputNumberType | false | Closure $format): static // line 331
public function getFocusNumberFormat(): string | false                             // line 342
```

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

### Separate Country Code - Infolist Entry

Source: https://github.com/ysfkaya/filament-phone-input/blob/main/README.md

Use `countryColumn` on PhoneEntry to display the country code from a separate column.

```php
PhoneEntry::make('phone')
    ->countryColumn('phone_country')
```

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

### showFlags / isShowFlags

Source: https://github.com/ysfkaya/filament-phone-input

Sets or retrieves the showFlags option. The default value is true.

```APIDOC
## showFlags / isShowFlags

### Description
Sets or retrieves the showFlags option. The default value is true.

### Method
setter/getter

### Signature
```php
public function showFlags(bool | Closure $value = true): static
public function isShowFlags(): bool
```

### Parameters
- `$value` (bool | Closure) - Optional - The showFlags flag, defaults to true. Can be a bool or a Closure.

### Returns
- `static` for the setter, `bool` for the getter.
```
Tokens:
Raw