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

react-geolocation-hook

v1.0.1

Published

A React hook to track or get the user's geolocation with loading and error handling

Downloads

2

Readme

react-geolocation-hook

A React hook to track / get the user's geolocation with loading and error handling

Installation

npm install react-geolocation-hook

Usage

import { useGeolocation } from 'use-geolocation-hook';

const MyGeolocationComponent = () => {
  const { coordinates, isLoading, error } = useGeolocation();

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error: {error}</div>;

  return <div>Coordinates: {coordinates[0]}, {coordinates[1]}</div>;
};

API

const { coordinates, error, isLoading, isSuccess, isFetched } = useGeolocation();

Returns an object with the following properties

  • coordinates: [number, number] | null: The latitude and longitude of the user's current position, or null if not available.
  • error: string | null: Any error encountered while fetching the geolocation, or null if no error occurred
  • isLoading: boolean: Whether the geolocation request is in progress.
  • isSuccess: boolean: Whether the geolocation request is resolved.
  • isFetched: boolean: Whether the geolocation request is complete, can be resolved or rejected.

Options

const geoLocation = useGeolocation({
  watchPosition: true,
  enableHighAccuracy: true,
  timeout: 5000,
  maximumAge: 0,
})

An optional object including the following parameters:

  • maximumAge (optional): A positive long value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to Infinity the device must return a cached position regardless of its age. Default: 0.
  • timeout (optional): A positive long value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. The default value is Infinity, meaning that getCurrentPosition() won't return until the position is available.
  • enableHighAccuracy (optional): A boolean value that indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false, the device can take the liberty to save resources by responding more quickly and/or using less power. Default: false.
  • watchPosition (optional): Updates coordinates automatically each time the position of the device changes.