Skip to main content
Version: v3.6.0

@rooks/use-geolocation

A hook to provide the geolocation info on client side.

Build Status

Installation

npm install --save @rooks/use-geolocation

Importing the hook

import useGeolocation from "@rooks/use-geolocation";

Usage

1. Getting geolocation in a component

function App() {
const geoObj = useGeolocation();

return (
<div
style={{
display: "flex",
alignItems: "center",
flexDirection: "column"
}}
>
<p>{geoObj && JSON.stringify(geoObj)}</p>
</div>
);
}
render(<App />);

1. Getting geolocation in a component on some condition

function App() {
const [when, setWhen] = React.useState(false);

const geoObj = useGeolocation({
when
});

return (
<div
style={{
display: "flex",
alignItems: "center",
flexDirection: "column"
}}
>
<button
onClick={() => {
setWhen(true);
}}
>
Get Geolocation
</button>
<p>{geoObj && JSON.stringify(geoObj)}</p>
</div>
);
}
render(<App />);