Skip to main content

Google Maps widget for address fields in Wagtail

Project description

wagtailgmaps PyPI

Simple Google Maps address formatter and LatLng provider for Wagtail fields.

Check out Awesome Wagtail for more awesome packages and resources from the Wagtail community.

Wagtailgmaps screenshot

Quickstart

Setting Up Your Google API Key

  1. Follow the instructions to get a key
  2. Enable the following services under API Restrictions:

Google_API_Screenshot

Installing and Configuration the Python Package

  1. Install with pip install wagtailgmaps

  2. Add wagtailgmaps to your settings.py INSTALLED_APPS section.

  3. Add some configuration in your settings.py file:

    # Mandatory
    WAGTAIL_ADDRESS_MAP_CENTER = 'Wellington, New Zealand'  # It must be a properly formatted address
    WAGTAIL_ADDRESS_MAP_KEY = 'xxx'
    
    # Optional
    WAGTAIL_ADDRESS_MAP_ZOOM = 8  # See https://developers.google.com/maps/documentation/javascript/tutorial#MapOptions for more information.
    WAGTAIL_ADDRESS_MAP_LANGUAGE = 'ru'  # See https://developers.google.com/maps/faq#languagesupport for supported languages.
    
  4. Use it:

    # myapp/models.py
    from django.db import models
    from wagtail.wagtailcore.models import Page
    from wagtailgmaps.edit_handlers import MapFieldPanel
    
    class MapPage(Page):
        # Wagtailgmaps expects a `CharField` (or any other field that renders as a text input)
        formatted_address = models.CharField(max_length=255)
        latlng_address = models.CharField(max_length=255)
    
        # Use the `MapFieldPanel` just like you would use a `FieldPanel`
        content_panels = Page.content_panels + [
            MapFieldPanel('formatted_address'),
            MapFieldPanel('latlng_address', latlngMode=True),
        ]
    
    # myapp/templates/myapp/map_page.html
    <a href="http://maps.google.com/?q={{ self.formatted_address }}">Open map (Formatted Address)</a>
    <a href="http://maps.google.com/?q={{ self.latlng_address }}">Open map (Lat/Long Address)</a>
    

Additional information

MapFieldPanel options

  • heading - A custom heading in the admin, defaults to "Location"
  • classname - Add extra css classes to the field
  • latlng - Field returns a LatLng instead of an address
  • centre - A custom override for this field
  • zoom - A custom override for this field

How the address option works under the hook

If using the address option, the field gets updated according to the Google Geocoding Service each time:

  • The map marker gets dragged and dropped into a location (dragend JS event).
  • Click happens somewhere in the map (click JS event).
  • Return key is pressed after editing the field (enterKey JS event for return key only).

Troubleshooting

When editing the model from the admin interface the affected field shows up with a map, like the screenshot above. If it doesn't, check your browser console to make sure that there is no error related to your API key.

Development

Releases

  • Make a new branch for the release of the new version.
  • Update the CHANGELOG.
  • Update the version number in wagtailgmaps/__init__.py, following semver.
  • Make a PR and squash merge it.
  • Back on master with the PR merged, use make publish (confirm, and enter your password).
  • Finally, go to GitHub and create a release and a tag for the new version.
  • Done!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtailgmaps-2.0.1.tar.gz (15.4 kB view details)

Uploaded Source

File details

Details for the file wagtailgmaps-2.0.1.tar.gz.

File metadata

  • Download URL: wagtailgmaps-2.0.1.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for wagtailgmaps-2.0.1.tar.gz
Algorithm Hash digest
SHA256 3fa6e6f86f50262f2a454b0de0faa53e5df62aecb7b4ee00deb6341f770af167
MD5 ccaf5e6f46c9832eaeafbfd795d894e8
BLAKE2b-256 dd3e19bcb631f8313d1763d8a56d7349b36bbe697e95383d7138ad923cc800af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page