npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gocrisp/store-locator

v0.5.8

Published

Store locator widget, intended for use with the Crisp GeoJSON connector.

Downloads

99

Readme

@gocrisp/store-locator

Package Version MIT License

A store locator component for use on any website. Intended for use with the Crisp GeoJSON connector.

This uses the Google Maps JavaScript API to easily create a simple store locator from any GeoJSON source.

This package is intended to be framework-agnostic. We are using microbundle to create a package that supports many formats (CJS, UMD, ESM). Since we like to use TypeScript, types are available (but not required). And since we love React, we have also published a React Component version.

Please refer to our example page to see this package in action and for more advanced usage examples. The steps below will provide the minimum for creating a store locator.

Create a Store Locator

Set up services

First, go set up a GeoJSON outbound connector on https://platform.gocrisp.com/. It will give you a URL to use later.

Create a Google Maps API Key with the following APIs enabled:

  • Maps JavaScript API
  • Places API
  • Distance Matrix API.
  • Street View Static API

Simple Implementation

Install this package:

yarn add @gocrisp/store-locator

or

npm install @gocrisp/store-locator --save

Include the styles: We have some minimal styles included as plain css in @gocrisp/store-locator/dist/store-locator.css. You will need to pull this into your site however you are including styles. We've kept the definitions as minimal as possible so that you can easily override or recreate the styles yourself. And every class is namespaced with the map_ prefix to avoid collisions.

Then, wherever you want to include the store locator map, insert this snippet:

import { createStoreLocatorMap } from '@gocrisp/store-locator';

createStoreLocatorMap({
  component: document.getElementById('store-locator-map'),
  geoJson: '<URL from the GeoJSON connector>',
  loaderOptions: { apiKey: '<your Google Maps API key>' },
});

Most of the Google Maps JavaScript API options and objects are available for customization as well. More details are available in the examples and documentation.

Run the Example App Locally

You should add a .env.local file that contains a GOOGLE_MAPS_API_KEY, otherwise the Google Maps will be limited.

To run the example app locally, you need to build the npm package into dist and then run the example app. You can either run the store-locator code with yarn dev to watch for changes or build it once with yarn build, but with the former you will need to run dev and example simultaneously.

yarn install
yarn start