feat(hooks): add useGeolocation hook#238
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new useGeolocation hook that wraps the browser's Geolocation API to provide a simple and unified interface for retrieving and tracking the user's location.
- Added a new hook implementation with customizable mount behaviors for one-time location fetch or continuous tracking.
- Provided comprehensive tests for different usage scenarios and error handling.
- Updated the module export to include useGeolocation in the public API.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/index.ts | Exports the new useGeolocation hook. |
| src/hooks/useGeolocation/useGeolocation.ts | Implements the hook with error handling, tracking functions, and corresponding options. |
| src/hooks/useGeolocation/useGeolocation.spec.ts | Adds comprehensive tests covering location fetching, error handling, automatic behaviors, and state updates. |
| src/hooks/useGeolocation/index.ts | Re-exports the hook for better module organization. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #238 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 34 35 +1
Lines 865 988 +123
Branches 265 301 +36
==========================================
+ Hits 865 988 +123 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
A new
useGeolocationhook that wraps the browser'sGeolocation API. Provides a simple interface for accessing and tracking the user's location.Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?