README

A Google Map addon for Statamic V4 for creating and displaying Google Maps on your website.

Installation

Require it using Composer.

composer require jezzdk/statamic-google-maps

Publish the assets

php artisan vendor:publish --provider="Jezzdk\StatamicGoogleMaps\ServiceProvider"

Add an environment variable, since this library uses Google Maps under the hood for displaying maps.

GOOGLE_MAPS_API_KEY=""

Lastly, insert this tag in the header in order to load the Google Map JavaScript on the frontend:

{{ map_script }}

*Disclaimer* You will need a billing account on Google if you want to create a Google Maps API key. There are plenty of guides on how to set that up if you ask Google.

Usage

This addon provides a Google Map fieldtype. You can use that in your blueprints which will enable your users to dynamically insert maps onto your website.

There is also a tag that you can use directly in your Antlers template. I'll explain both use cases below.

Map Tag

The simplest way to insert a map is by inserting the tag with latitude and longitude:

{{ map lat="12.1234" lng="52.1234" }}

This will insert a map centered on the given coordinates, with a zoom level of 16 and using the roadmap type. The Map tag supports the following attributes:

Google Map Field (Pro feature)

Simply select the fieldtype when creating a blueprint. When a user pans around the map, changes zoom level or changes the map type, the settings are saved and the output will display the same view as selected in the control panel.

The field has a few settings:

Initial map type - choose which map type should be selected when the map is loaded initially in the control panel
Initial zoom level - choose the zoom level when the map is loaded initially in the control panel
Enable maptype selector - Allow the user to select the map type
Enable marker creation - The user can create and remove a marker on the map
Enable Geocoder - This adds a search field above the map, enabling the user to search for an address (The Geocoder API must be enabled in Google Cloud Console for this to work!)

When using markers, the script will look for an icon at /public/assets/marker.png. If it exist it will be used, otherwise it will use the default Google Map pin.

Styles (Pro feature)

The map can be styled using a JSON array of styles. You can generate the style JSON for free at https://mapstyle.withgoogle.com/ (use the old wizard) or at https://snazzymaps.com/.

The fieldtype has a button that reveals a textarea where the style JSON can be inserted, and the map tag has a style attribute for the same purpose.

jezzdk / statamic-google-maps

Maintainers