/angular-google-maps

A brilliant solution for using Google Maps in Angular.

Primary LanguageTypeScriptMIT LicenseMIT

npm (scoped) npm bundle size (scoped) GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) Contributor Covenant GitHub npm

@bespunky/angular-google-maps

A brilliant solution for using Google Maps in Angular.

โœจ Getting Started | ๐Ÿ™Œ Official Site & Live Demo | ๐ŸŽ What's in the library?

Pre-release. It is suggested not to use it for production yet.

This library brings Google Maps API to angular, providing a set of components, directives, services and other tools to facilitate the creation and workflow with Google Maps.

You may use the library as you like, with any app, under the MIT license.

Installation

npm install @bespunky/angular-google-maps

What's So Cool About It

Here are some of the benefits:

โœ” Plug & Play ๐Ÿ”Œ

โœ” No previous Google Maps knowledge needed ๐Ÿคฏ

โœ” Powerful & flexible tooling ๐Ÿ’ช

โœ” Tree-shakable ๐ŸŒณ

โœ” Angular Universal ready ๐ŸŒŽ

โœ” Extendable ๐Ÿงฉ

โœ” Testable ๐Ÿงช

โœ” Scalable โ†—

โœ” Magical automated native wrapping โœจ

โœ” Open-source! ๐Ÿคฉ

More details in the official site.

Motivation

There are a few Angular libraries out there for Google Maps. So why develop a new one?

Flexibility and quick response time

I'm working on a project where the map is the heart of the app. I can't afford an "oh shut... their library doesn't support this. Now what do I do??" moment. Fork it? Make a pull request? File an issue and hope for the best?...

Facilitating map functionality

Maybe they wanted to reduce package size, or maybe it was simply a lack of initiative, but having used Google Maps API in different contexts in the last few years, I've always found that it lacks some basic functionality. I would like my library to take care of stuff for me. No manual map related labour in the app itself.

Usage and code style

We all have preferences as developers. I want my library to work a certain way and provide me with a certain API. I've always had some nice ideas regarding how it should be used. It was time to implement.

The challenge

Of course ๐Ÿ˜

Versions

The library was generated using Angular 7 and has been gradually updated and tested up to Angular 10. Compatibility with older versions is possible but not guaranteed.

Full change log

Issues & Requests

Issues, suggestions and pull requests are welcome. Please follow the contrubution guidelines.

Other Packages by @bespunky

๐Ÿ“ฆ @bespunky/angular-zen

๐Ÿšง (soon) @bespunky/angular-zen-ux will help you with simple UX tasks.

๐Ÿšง (soon) @bespunky/angular-zen-seo will help you with metadata and SEO related tasks.

References


---

The Workspace

Build status

This angular workspace provides:

  • The @bespunky/angular-google-maps library containing a set of ๐ŸŒณ tree-shakable tools to work with Google Maps API.
  • The app for the official site.

๐Ÿ“– Documentation

All modules / components / services are documented within the code. Some might have their own Readme.md file accessible at their folder.

The complete documentation is found in the wiki folder, and is also accessible online at angular-google-maps wiki.