use-geo v1.0.0

use-geo

Make use of browser geo location API

Install

npm install --save use-geo

Usage

Manual position request

import * as React from 'react';

import { useGeo } from 'use-geo';
// Or import useGeo from 'use-geo';

const stringifyResults = (status, position, error) => {
  if (error) return `Error(${error.message})`;
  if (position) return `{\n  lat: ${position.coords.latitude},\n  long: ${position.coords.longitude}\n}`;
  return status;
};

export default () => {
  const { status, position, error, request } = useGeo(/* immediate flag (boolean) or PositionOptions object */);

  return (
    <div>
      <input
        type="button"
        value="reload"
        onClick={request}
        disabled={status === Status.PENDING}
      />
      <pre>useGeo(): {stringifyResults(status, position, error)}</pre>
    </div>
  );
};

Watching position changes

import * as React from 'react';

import { useGeoWatch } from 'use-geo';

const stringifyResults = (position, error) => {
  if (error) return `Error(${error.message})`;
  if (position) return `{\n  lat: ${position.coords.latitude},\n  long: ${position.coords.longitude}\n}`;
  return 'No results';
};

export default () => {
  const { position, error, watching, watch, unwatch } = useGeoWatch(/* immediate flag (boolean) or PositionOptions object */);

  return (
    <div>
      {watching ? 'watching' : 'not watching'}
      <input
        type="button"
        value={watching ? 'stop' : 'start'}
        onClick={watching ? unwatch : watch}
      />
      <pre>useGeo(): {stringifyResults(position, error)}</pre>
    </div>
  );
};

License

MIT © termosa

This hook is created using create-react-hook.