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

@zxzxlch/store-locator

v0.1.2

Published

Add a mobile responsive store locator to any page.

Downloads

3

Readme

Store Locator

Add a mobile responsive store locator to your React web app.

Installation

Here's a quick summary of the steps.

  1. Install the @zxzxlch/store-locator package.
  2. Install the Google API.
  3. Import the StoreLocator component.
  4. Map your data to the store items.

1. Install the package

npm install --save @zxzxlch/store-locator

2. Install the Google API

Include this script tag in your HTML file. This will load the places and geometry libraries from Google Maps JavaScript API.

<script type="text/javascript" src="https://maps.googleapis.com/maps/api/js?key=_____YOUR_API_KEY_____&libraries=places,geometry"></script>

Remember to replace with your API key.

3. Import the StoreLocator component

Import the StoreLocator component and add it to your app. Import the default CSS file too so everything looks right.

For example,

import StoreLocator from "@zxzxlch/store-locator";
import "@zxzxlch/store-locator/dist/main.css";

class App extends Component {
  render() {
    return (
      <div className="App">
        <StoreLocator />
      </div>
    );
  }
}

4. Map your data to the store items.

To display your data in the StoreLocator component without extra configuration, your data has to match this structure:

[
  {
    "index": 1,
    "title": "Woodlands Primary School",
    "description": "Fernvale Link",
    "accessory": "3 km",
    "location": { "lat": 1.39807105477126, "lng": 103.877933381804 }
  },
  // more items...
]

Otherwise, you have to use a mapping function to transform your data. For example,

function mapPlacesToStoreItems(places, filters) {
  // Get the user-input search location so we can calculate proximity for each place
  const { currentLocation } = filters;

  // Parse each place into the right format
  return places.map(place => {
    const {
      id: index,
      name: title,
      address,
      lat,
      lng
    } = place;

    const description = address.join(', ');

    // Calculate proximity distance and set accessory text
    var accessory;
    var distance;

    if (currentLocation) {
      // Calculate distance
      distance = calculateDistance({ lat, lng }, currentLocation);
      accessory = distanceToHumanString(distance);
    }

    return {
      index,
      title,
      description,
      accessory,
      location: { lat, lng },
      distance
    };
  });
}

...

<StoreLocator
  data={data}
  mapPlacesToStoreItems={mapPlacesToStoreItems}
/>

calculateDistance and distanceToHumanString are helper functions that are included with the package. To import the functions together with the component, for example,

import { default as StoreLocator, calculateDistance, distanceToHumanString } from "@zxzxlch/store-locator";