PHPackages tapp/filament-google-autocomplete-field - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. tapp/filament-google-autocomplete-field ActiveLibrary[Utility & Helpers](/categories/utility) tapp/filament-google-autocomplete-field ======================================= Filament plugin that provides a Google Autocomplete field v4.0.8(2mo ago)3098.1k↓22.4%28[2 issues](https://github.com/TappNetwork/filament-google-autocomplete-field/issues)[6 PRs](https://github.com/TappNetwork/filament-google-autocomplete-field/pulls)MITPHPPHP ^8.2 Since Jul 14Pushed 1mo ago4 watchersCompare [ Source](https://github.com/TappNetwork/filament-google-autocomplete-field)[ Packagist](https://packagist.org/packages/tapp/filament-google-autocomplete-field)[ Docs](https://github.com/tapp/filament-google-autocomplete-field)[ GitHub Sponsors](https://github.com/TappNetwork)[ RSS](/packages/tapp-filament-google-autocomplete-field/feed)WikiDiscussions 4.x Synced 1mo ago READMEChangelog (10)Dependencies (32)Versions (35)Used By (0) Filament Google Autocomplete Field ================================== [](#filament-google-autocomplete-field) [![Latest Version on Packagist](https://camo.githubusercontent.com/22ff3746dab958d4b51fff67ac1b469b6b1ed1bba75b6e3033b88b7049eb29e9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f746170702f66696c616d656e742d676f6f676c652d6175746f636f6d706c6574652d6669656c642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tapp/filament-google-autocomplete-field)[![GitHub Tests Action Status](https://github.com/TappNetwork/filament-google-autocomplete-field/actions/workflows/run-tests.yml/badge.svg)](https://github.com/TappNetwork/filament-google-autocomplete-field/actions/workflows/run-tests.yml/badge.svg)[![GitHub Code Style Action Status](https://github.com/TappNetwork/filament-google-autocomplete-field/actions/workflows/fix-php-code-style-issues.yml/badge.svg)](https://github.com/TappNetwork/filament-google-autocomplete-field/actions/workflows/fix-php-code-style-issues.yml/badge.svg)[![Total Downloads](https://camo.githubusercontent.com/90b71b0c256fd9e37715b57e2b2c477e62cce02310f37422cdbc2f794f1cda9c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f746170702f66696c616d656e742d676f6f676c652d6175746f636f6d706c6574652d6669656c642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tapp/filament-google-autocomplete-field) This plugin provides an address autocomplete using [Google Place autocomplete API](https://developers.google.com/maps/documentation/places/web-service/autocomplete), with fully customizable address fields. Note The [Google Places API package](https://github.com/SachinAgarwal1337/google-places-api) is used to make API requests to Google Places. Version Compatibility --------------------- [](#version-compatibility) FilamentFilament Google Autocomplete FieldDocumentation4.x/5.x4.xCurrent3.x1.x[Check the docs](https://github.com/TappNetwork/filament-google-autocomplete-field/tree/1.x)Installation ------------ [](#installation) You can install the package via Composer: ``` composer require tapp/filament-google-autocomplete-field:"^4.0" ``` You can publish the config file with: ``` php artisan vendor:publish --tag="filament-google-autocomplete-field-config" ``` This is the contents of the published config file: ``` return [ 'api-key' => env('GOOGLE_PLACES_API_KEY', ''), 'verify-ssl' => true, 'throw-on-errors' => false, ]; ``` Optionally, you can publish the translation files with: ``` php artisan vendor:publish --tag="filament-google-autocomplete-field-translations" ``` Setup ----- [](#setup) On [Google console](https://console.cloud.google.com/apis/dashboard), create an application and enable the Places API. 1. Click on "ENABLE APIS AND SERVICES" 2. Search for "Places api" 3. Click to enable it 4. Get the API key In your Laravel application, add the Google API key to `GOOGLE_PLACES_API_KEY` in your `.env` file: ``` GOOGLE_PLACES_API_KEY=your_google_place_api_key_here ``` Appareance ---------- [](#appareance) [![Filament Google Autcomplete Field](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete02.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete02.png) [![Filament Google Autcomplete Field](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete03.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete03.png) [![Filament Google Autcomplete Field](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete04.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete04.png) [![Filament Google Autcomplete Field](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete05.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete05.png) [![Filament Google Autcomplete Field](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete06.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/autocomplete06.png) Usage ----- [](#usage) Add the `GoogleAutocomplete` field to your form: ``` use Tapp\FilamentGoogleAutocomplete\Forms\Components\GoogleAutocomplete; GoogleAutocomplete::make('google_search'), ``` This will use the default address fields and Google API options. You can also customize the address fields and Google Place API options. See all the options available on [`Available options`](#available-options) item below. For example: ``` use Tapp\FilamentGoogleAutocomplete\Forms\Components\GoogleAutocomplete; GoogleAutocomplete::make('google_search') ->label('Google look-up') ->countries([ 'US', 'AU', ]) ->language('pt-BR') ->withFields([ Forms\Components\TextInput::make('address') ->extraInputAttributes([ 'data-google-field' => '{street_number} {route}, {sublocality_level_1}', ]), Forms\Components\TextInput::make('country'), Forms\Components\TextInput::make('coordinates') ->extraInputAttributes([ 'data-google-field' => '{latitude}, {longitude}', ]), ]), ``` ### Using form layouts [](#using-form-layouts) The Google autocomplete fields can be wrapped in a Form layout like `Fieldset` or `Section`: ``` Forms\Components\Fieldset::make('Google Search') ->schema([ GoogleAutocomplete::make('google_search_field') // ... ]), ``` [![Fieldset Layout](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/fieldset_layout.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/fieldset_layout.png) ``` Forms\Components\Section::make('Google Search') ->schema([ GoogleAutocomplete::make('google_search_field') // ... ]), ``` [![Section Layout](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/section_layout.png)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/section_layout.png) Places API (original) and Places API (New) ------------------------------------------ [](#places-api-original-and-places-api-new) Both the **[Places API (original)](https://developers.google.com/maps/documentation/places/web-service/autocomplete)** and the **[Places API (New)](https://developers.google.com/maps/documentation/places/web-service/place-autocomplete)** are supported. By default, the Places API (original) it's used. To use the Places API (New) instead, add the `->placesApiNew()` method, like so: ``` GoogleAutocomplete::make('google_search') ->placesApiNew() ``` Available Options ----------------- [](#available-options) ### Autocompleted Fields [](#autocompleted-fields) You can use the `withFields` method to define the fields that will be autocompleted. By default the following fields are set if this method isn't provided: ``` Forms\Components\TextInput::make('address') ->extraInputAttributes([ 'data-google-field' => '{street_number} {route}, {sublocality_level_1}', ]), Forms\Components\TextInput::make('city') ->extraInputAttributes([ 'data-google-field' => 'locality', ]), Forms\Components\TextInput::make('country'), Forms\Components\TextInput::make('zip') ->extraInputAttributes([ 'data-google-field' => 'postal_code', ]), ``` You can override these default fields by passing an array of Filament form fields to `withFields` method: ``` GoogleAutocompleteFields::make('google_search') ->withFields([ Forms\Components\TextInput::make('address') ->extraInputAttributes([ 'data-google-field' => '{street_number} {route}, {sublocality_level_1}', ]), Forms\Components\TextInput::make('city') ->extraInputAttributes([ 'data-google-field' => 'locality', ]), ]), ``` #### Combining Fields [](#combining-fields) You can combine multiple fields returned by Google API in one field using curly braces `{}` to wrap the fields in `'data-google-field'` extra input attribute. For example, the `address` field below will contain the `street_number`, `route`, and `sublocality_level_1` and the `coordinates` field will contain the `latitude` and `longitude` fields: ``` Forms\Components\TextInput::make('address') ->extraInputAttributes([ 'data-google-field' => '{street_number} {route}, {sublocality_level_1}', ]), Forms\Components\TextInput::make('coordinates') ->extraInputAttributes([ 'data-google-field' => '{latitude},{longitude}', ]), ``` #### Field Name [](#field-name) If your database field have a different name than the Google field (for example you DB field is `zip` and you want to use the Google's `postal_code` value returned by API), you can tie the API field to the DB field by passing your DB field name to `'data-google-field'` on `extraInputAttributes` method like so: ``` Forms\Components\TextInput::make('zip') ->extraInputAttributes([ 'data-google-field' => 'postal_code', ]) ``` These are the names of the Google metadata fields available to use: ``` street_number, route, locality, sublocality_level_1, administrative_area_level_2, administrative_area_level_1, country, postal_code, place_id, formatted_address, formatted_phone_number, international_phone_number, name, website, latitude, longitude, ``` #### long\_name and short\_name [](#long_name-and-short_name) Google's Places API returns `long_name` and `short_name` values for address fields. You can choose which one to display by passing it to the `'data-google-value'` on `extraInputAttributes` method: ``` Forms\Components\TextInput::make('country') ->extraInputAttributes([ 'data-google-value' => 'short_name', ]) ``` E.g. of `long_name` and `short_name` data returned by Google's API: ``` "street_number" => [ "long_name" => "1535" "short_name" => "1535" ] "route" => [ "long_name" => "Broadway" "short_name" => "Broadway" ] "locality" => [ "long_name" => "New York" "short_name" => "New York" ] "sublocality_level_1" => [ "long_name" => "Manhattan" "short_name" => "Manhattan" ] "administrative_area_level_2" => [ "long_name" => "New York County" "short_name" => "New York County" ] "administrative_area_level_1" => [ "long_name" => "New York" "short_name" => "NY" ] "country" => [ "long_name" => "United States" "short_name" => "US" ] "postal_code" => [ "long_name" => "10036" "short_name" => "10036" ] ``` ### Autocomplete Field Column Span [](#autocomplete-field-column-span) The default column span for autcomplete select field is `'full'`. You can define other value (same as supported by Filament's `columnSpan()`) using the `autocompleteFieldColumnSpan` method: ``` GoogleAutocomplete::make('google_search') ->autocompleteFieldColumnSpan(1) ``` ### Autocomplete Field Search Debounce [](#autocomplete-field-search-debounce) The default search debounce is 2 seconds to avoid too many requests to Google Places API. You can define other value using `autocompleteSearchDebounce` method: ``` GoogleAutocomplete::make('google_search') ->autocompleteSearchDebounce(1000) // 1 second ``` ### Autocomplete Label [](#autocomplete-label) The label of the autocomplete select field can be modified using the `->autocompleteLabel()` method: ``` GoogleAutocomplete::make('google_search') ->autocompleteLabel('Select a location') ``` ### Autocomplete Placeholder [](#autocomplete-placeholder) The placeholder can be modified using the `->autocompletePlaceholder()` method: ``` GoogleAutocomplete::make('google_search') ->autocompletePlaceholder('Select a location') ``` Example with modified `label`, `autocompleteLabel`, and `autocompletePlaceholder`: ``` GoogleAutocomplete::make('google_search') ->autocompleteLabel('Select a location') ->autocompletePlaceholder('Click here to search') ->label('Searching on Google...') ->countries([ 'us', 'au', ]) ->placeTypes([ 'book_store', 'cafe', ]) ->withFields([ Forms\Components\TextInput::make('address') ->extraInputAttributes([ 'data-google-field' => '{street_number} {route}, {sublocality_level_1}', ]), Forms\Components\TextInput::make('city') ->extraInputAttributes([ 'data-google-field' => 'locality', ]), ]), ``` [![Example with modified label, autocompleteLabel, and autocompletePlaceholder](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/label_placeholder.jpg)](https://raw.githubusercontent.com/TappNetwork/filament-google-autocomplete-field/4.x/docs/label_placeholder.jpg) Google API Options ------------------ [](#google-api-options) These following **Google API options** can be passed to the `GoogleAutocomplete` field: ### OPTIONS FOR BOTH APIs [](#options-for-both-apis) ### PlaceTypes [](#placetypes) Restrict the results to be of a certain type. Pass the [available types](https://developers.google.com/maps/documentation/places/web-service/supported_types) as an array: ``` GoogleAutocomplete::make('google_search') ->placeTypes([ 'lodging', 'book_store', 'florist', ]) ``` Please refer to the [Google Places API original documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#types) and [Google Places API New documentation](https://developers.google.com/maps/documentation/places/web-service/place-autocomplete#includedPrimaryTypes) to a detailed description of this option. ### Language [](#language) The language which results should be returned. These are the [supported language codes](https://developers.google.com/maps/faq#languagesupport). ``` GoogleAutocomplete::make('google_search') ->language('pt-BR') ``` ### Offset [](#offset) The position, in the input term, of the last character that the service uses to match predictions. For example, if the input is Google and the offset is 3, the service will match on Goo. ``` GoogleAutocomplete::make('google_search') ->offset(5) ``` ### LocationBias [](#locationbias) Prefer results in a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. If this parameter is not specified, the API uses IP address biasing by default. Please refer to the [Google Places API original documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#locationbias) and [Google Places API New](https://developers.google.com/maps/documentation/places/web-service/place-autocomplete#location-bias-restriction) to a detailed description of this option. ``` GoogleAutocomplete::make('google_search') ->locationBias( [ "circle" => [ "center" => [ "latitude" => 37.7937, "longitude" => -122.3965 ], "radius" => 500.0 ] ] ) ``` ### LocationRestriction [](#locationrestriction) Restrict results to a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. Please refer to the [Google Places API original documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#locationrestriction) and [Google Places API New](https://developers.google.com/maps/documentation/places/web-service/place-autocomplete#location-bias-restriction) to a detailed description of this option. ### Origin [](#origin) The origin point as `latitude,longitude` from which to calculate straight-line distance to the destination specified. Please refer to the [Google documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#origin) to a detailed description of this option. ``` GoogleAutocomplete::make('google_search') ->origin(40.7585862,-73.9858202) ``` ### Region [](#region) The region code used to format the response, specified as a [country code top-level domain (ccTLD)](https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains) two-character value. ``` GoogleAutocomplete::make('google_search') ->region('uk') ``` ### SessionToken [](#sessiontoken) Random string which identifies an autocomplete session for billing purposes. Please refer to the [Google documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#sessiontoken) to a detailed description of this option. ### OPTIONS ONLY FOR PLACES API (ORIGINAL) [](#options-only-for-places-api-original) ### Countries [](#countries) Add the `countries` method to restrict the countries that should be used for autocomplete search. The countries must be passed as a two character ISO 3166-1 Alpha-2 compatible country code. You can find the country codes available at [Wikipedia: List of ISO 3166 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). ``` GoogleAutocomplete::make('google_search') ->countries([ 'US', 'AU', ]) ``` ### Location [](#location) The point around which to retrieve place information as `latitude,longitude`. Please refer to the [Google documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#location) to a detailed description of this option. ``` GoogleAutocomplete::make('google_search') ->location(40.7585862,-73.9858202) ``` ### Radius [](#radius) The distance in meters within which to return place results. Please refer to the [Google documentation](https://developers.google.com/maps/documentation/places/web-service/autocomplete#radius) to a detailed description of this option. ``` GoogleAutocomplete::make('google_search') ->radius(10) ``` ### OPTIONS ONLY FOR PLACES API (NEW) [](#options-only-for-places-api-new) ### IncludePureServiceAreaBusinesses [](#includepureserviceareabusinesses) `true` - includes businesses that visit or deliver to customers directly, but don't have a physical business location. `false` - returns only businesses with a physical business location. ``` GoogleAutocomplete::make('google_search') ->includePureServiceAreaBusinesses(true) ``` ### IncludedRegionCodes [](#includedregioncodes) Only include results from the list of specified regions, specified as an array of up to 15 ccTLD ("top-level domain") two-character values. When omitted, no restrictions are applied to the response. ``` GoogleAutocomplete::make('google_search') ->includedRegionCodes([ "de", "fr", ]) ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Tapp Network](https://github.com/TappNetwork) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 58 — FairBetter than 98% of packages Maintenance86 Actively maintained with recent releases Popularity46 Moderate usage in the ecosystem Community24 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 75.2% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~18 days Recently: every ~12 days Total 34 Last Release 70d ago Major Versions v1.0.17 → v4.0.42025-10-17 v1.0.19 → v4.0.52025-11-03 v1.0.21 → v4.0.62025-11-16 v1.0.22 → v4.0.72026-01-22 1.x-dev → v4.0.82026-03-09 ### Community Maintainers ![](https://www.gravatar.com/avatar/d72a8c345b7f4205dc1edaff8d05ce78f7fe1ec93dce0e52d29f18e885508d4f?d=identicon)[tapp](/maintainers/tapp) ![](https://www.gravatar.com/avatar/5d0402fb770bca016dd6ee6a925501e0224783f1e5907788aee0ba7bc31c01ee?d=identicon)[andreiabohner](/maintainers/andreiabohner) --- Top Contributors [![andreia](https://avatars.githubusercontent.com/u/38911?v=4)](https://github.com/andreia "andreia (82 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (6 commits)")[![trippo](https://avatars.githubusercontent.com/u/497169?v=4)](https://github.com/trippo "trippo (3 commits)")[![swilla](https://avatars.githubusercontent.com/u/304159?v=4)](https://github.com/swilla "swilla (3 commits)")[![alexb34n](https://avatars.githubusercontent.com/u/118002075?v=4)](https://github.com/alexb34n "alexb34n (1 commits)")[![AlexandreCConcept](https://avatars.githubusercontent.com/u/75247625?v=4)](https://github.com/AlexandreCConcept "AlexandreCConcept (1 commits)")[![gladjanus43](https://avatars.githubusercontent.com/u/37533884?v=4)](https://github.com/gladjanus43 "gladjanus43 (1 commits)")[![JacobDelcroix](https://avatars.githubusercontent.com/u/1562662?v=4)](https://github.com/JacobDelcroix "JacobDelcroix (1 commits)")[![matteodvlp](https://avatars.githubusercontent.com/u/132575178?v=4)](https://github.com/matteodvlp "matteodvlp (1 commits)")[![aghayeff](https://avatars.githubusercontent.com/u/7493431?v=4)](https://github.com/aghayeff "aghayeff (1 commits)")[![bcash](https://avatars.githubusercontent.com/u/570976?v=4)](https://github.com/bcash "bcash (1 commits)") --- Tags addressfilamentgoogle-autocompletephppluginphplaraveladdressfilamentGoogle Places Apitapp networkGoogle Autocompletefilament-google-autocomplete-field ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/tapp-filament-google-autocomplete-field/health.svg) ``` [![Health](https://phpackages.com/badges/tapp-filament-google-autocomplete-field/health.svg)](https://phpackages.com/packages/tapp-filament-google-autocomplete-field) ``` ### Alternatives [pboivin/filament-peek Full-screen page preview modal for Filament 253319.6k12](/packages/pboivin-filament-peek)[dotswan/filament-map-picker Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications. 124139.3k2](/packages/dotswan-filament-map-picker)[creagia/filament-code-field A Filamentphp input field to edit or view code data. 58289.3k3](/packages/creagia-filament-code-field)[swisnl/filament-backgrounds Beautiful backgrounds for Filament auth pages 54149.2k6](/packages/swisnl-filament-backgrounds)[tapp/filament-auditing Filament Laravel Auditing plugin. 113379.4k2](/packages/tapp-filament-auditing)[jibaymcs/filament-tour Bring the power of DriverJs to your Filament panels and start a tour ! 12247.8k](/packages/jibaymcs-filament-tour) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)