https://github.com/buraksakalli/konum

A simple browser location hook for React
https://github.com/buraksakalli/konum

react-browser-location react-location react-location-picker

Last synced: 10 months ago
JSON representation

A simple browser location hook for React

• Host: GitHub
• URL: https://github.com/buraksakalli/konum
• Owner: buraksakalli
• Created: 2022-04-25T18:49:23.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-20T15:50:59.000Z (over 3 years ago)
• Last Synced: 2025-06-30T15:04:48.998Z (11 months ago)
• Topics: react-browser-location, react-location, react-location-picker
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/konum
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Konum

[![npm version](https://badge.fury.io/js/konum.svg)](https://badge.fury.io/js/konum)

![konum](https://user-images.githubusercontent.com/10114716/196001630-56f438ed-2e09-4e9f-872d-628a2ee3e238.gif)

Konum (means location in Turkish) is a primary browser location provider for React.

## Installation

```bash

yarn add konum

#or

npm i konum

```

## Usage

```tsx

import { useKonum } from "konum";

const { data, isAllowed, error } = useKonum();

```

## Props

| Props         | Type    | Description                                       |

| ------------- | ------- | ------------------------------------------------- |

| **data**      | object  | It returns two attributes longitude and latitude. |

| **isAllowed** | boolean | It changes based on user's allow.                 |

| **error**     | string  | It returns error message                          |

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.