-
Notifications
You must be signed in to change notification settings - Fork 58
feat(hooks): add useGeolocation hook #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
|
seungrodotlee
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! 👍
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?