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

use-sort-cities-by-distance

v1.0.8

Published

Sorts an array of cities by proximity to a point

Downloads

13

Readme

useSortCitiesByDistance

npm version NPM version Build npm-typescript License

useSortCitiesByDistance is a simple react hook that enables you to sort an array of cities based on their proximity to a given point. The distance is calculated with a straight line or travel distance between the places.

Getting started

Installation

npm install use-sort-cities-by-distance
#or
yarn add use-sort-cities-by-distance

Import the 'useSortCitiesByDistance' hook from the package:

import { useSortCitiesByDistance } from 'use-sort-cities-by-distance'

Usage with JSON Data

Define your starting point, target destinations, and a .json list with coordinates of the possible targets:

import React, { useState } from 'react'
import { useSortCitiesByDistance } from 'use-sort-cities-by-distance'
import cities from './cities.json'

function YourComponent() {
  const [config, setConfig] = useState({
    list: cities, // List of possible cities
    start: 'London', // Starting point
    targets: ['London', 'Paris', 'New York', 'Barcelona'], // Array of target cities
    unit: 'km', // Optional, default is 'miles', enter 'km' if you need kilometers
  })

  const { sorted } = useSortCitiesByDistance(config)

  // Your component code
}

The list property should be an array of cities in the following .json format. A demo list can be found in the demo folder:

[
  { "city": "Los Angeles", "lat": 34.0522, "lng": -118.2437 },
  { "city": "London", "lat": 51.5074, "lng": -0.1278 },
  { "city": "Tokyo", "lat": 35.6895, "lng": 139.6917 }
]

Usage with Google Maps

Instead of a list, you can also use the hook with the Google Maps API. Just enter your key as the "key" property and omit the "list". The use of Google Maps allows the distance in travel distance.

const config = {
  key: '******', // Google Maps API key
  start: 'London',
  targets: ['London', 'Paris', 'New York', 'Barcelona'],
  travelDistance: true, // Optional, default is straight line
}

Possible errors are displayed in an error object, which you retain from the hook:

const { sorted, error } = useSortCitiesByDistance(config)

Contributing

Contributions, issues, and feature requests are welcome!

License

This project is licensed under the MIT License