Skip to content

README.md

Latest commit

 

History

History
94 lines (65 loc) · 4.07 KB

README.md

File metadata and controls

94 lines (65 loc) · 4.07 KB

Our.Umbraco.GMaps - Google Maps for Umbraco

Our.Umbraco.GMaps Logo

Google Maps with autocomplete property editor for Umbraco including property value converter.

Our.Umbraco.GMaps - CI Our.Umbraco.GMaps - Release

Package NuGet
Our.Umbraco.GMaps NuGet NuGet downloads
  • For Umbraco 10 to 13, use version 3.0.5

Change Log Summary

  • 17.0.1: Now using new Google Places API, and includes ufm components for Block Elements
  • 17.0.0: Umbraco 17 release - release version aligned to Umbraco
  • 5.0.0: Rebuilt to target Umbraco 16 Management Apis and uUI framework now an RCL (See breaking changes below)
  • 4.0.0: Rebuilt with Umbraco's uUI targetting Umbraco 15+
  • 3.0.0: Removed support for Umbraco 8 & 9, allowing us to cleanup the codebase. Now a Razor Class Library.
  • 2.1.3: Better support for installation on Umbraco 11.
  • 2.1.0: Breaking change - MapConfig.Zoom is now an int as it should be (was a string).
  • 2.0.7: Added ability to re-center the map via Editor Actions and can now directly input a set of coordinates.

Breaking Changes

  • As of version 5, the Our.Umbraco.GMaps.Core package is no longer, and any references to Our.Umbraco.GMaps.Core should be replaced with just Our.Umbraco.GMaps.

Features

  • Search for address using autocomplete and place marker
  • Enter coordinates in place marker
  • Click on exact location on map to place marker
  • Drag marker around
  • Set default location & zoomlevel on Data Type settings
  • Zoomlevel is saved on the property to use the same zoomlevel on your website
  • Centerpoint is saved on the property to use the same centerpoint on your website different than the marker.
  • MapType is saved on the property to use the same maptype on your website
  • Use your SnazzyMaps API key to set mapstyles
  • Umbraco Formatted Markdown components

Install

Use NuGet to install Our.Umbraco.GMaps:

Install-Package Our.Umbraco.GMaps

Configuration

You can configure the API Key along with other settings directly in AppSettings as per below:

Add the following to your appsettings.json file or equivalent settings provider (Azure KeyVault, Environment, etc.):

  "GoogleMaps": {
    "ApiKey": "",
    "DefaultLocation": "",
    "ZoomLevel": 17
  }

These settings can be overridden by configuring the relevant properties of the Data Type prevalues.

Umbraco Formatted Markdown Components

Release 17.0.1 includes ufm components for rendering the Address and Coordinates in Block Data types:

  • Address: {gmp: singleMap.address}
  • Coordinates: {gmp: singleMap.coordinates}

Demo site Umbraco Backoffice Login Details

Username: admin@admin.com
Password: Password123

Special thanks and big #H5YR

Special thanks to:

  • ronaldbarendse for all his contributions to this project
  • prjseal for the Visual Studio project setup and included demo-site
  • robertjf for making the Umbraco 9 version a reality, and continuously accepting and testing PR's and setting up release automation #h5yr
  • arknu for migrating to Umbraco 15

Google maps icons created by Freepik - Flaticon