whitecube/nova-google-maps

A Laravel Nova field.

v0.0.1 2020-05-04 14:32 UTC

Requires

• php: >=7.1.0

MIT

• nova
• laravel

README

A laravel nova field to easily enter an address (uses the Algolia Places API) and show a preview in a Google Map. The result is stored in a json column and contains all the data sent by Algolia.

Installation

You can install the package via composer:

composer require whitecube/nova-google-maps

Usage

use Whitecube\NovaGoogleMaps\GoogleMaps;

/**
 * Get the fields displayed by the resource.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return array
 */
public function fields(Request $request)
{
    return [
        // ...

        GoogleMaps::make('Map')
            ->zoom(8) // Optionally set the zoom level
            ->defaultCoordinates($lat, $lng) // Optionally set the map's default center point
    ];
}

Storage

The field stores the JSON data sent back by Algolia (minus a few unneeded sub-objects). This gives you a lot of information on the selected place/address. Here is an example:

{
    "name": "Bruxelles", 
    "type": "city", 
    "query": "Bruxelles", 
    "value": "Bruxelles, Région de Bruxelles-Capitale - Brussels Hoofdstedelijk Gewest, Belgique", 
    "county": "Bruxelles-Capitale", 
    "latlng": {"lat": 50.8466, "lng": 4.3517}, 
    "country": "Belgique", 
    "postcode": "1000", 
    "countryCode": "be", 
    "administrative": "Région de Bruxelles-Capitale - Brussels Hoofdstedelijk Gewest"
}

Configuration

By default, you should reference your Google Maps API key in your .env file:

NOVA_GOOGLE_MAPS_API_KEY=your-api-key

Optionally, you can publish the config to change the API key location and the map's language by doing: php artisan vendor:publish --tag=nova-google-maps.

💖 Sponsorships

If you are reliant on this package in your production applications, consider sponsoring us! It is the best way to help us keep doing what we love to do: making great open source software.

Contributing

Feel free to suggest changes, ask for new features or fix bugs yourself. We're sure there are still a lot of improvements that could be made, and we would be very happy to merge useful pull requests.

Thanks!

Made with ❤️ for open source

At Whitecube we use a lot of open source software as part of our daily work. So when we have an opportunity to give something back, we're super excited!

We hope you will enjoy this small contribution from us and would love to hear from you if you find it useful in your projects. Follow us on Twitter for more updates!