feat: add useBattery hook #1667
Open
+344
−1
Conversation
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
Implements useBattery hook that tracks device battery state using the Battery Status API. - Returns isSupported, fetched, charging, chargingTime, dischargingTime, level - Subscribes to battery change events (chargingchange, chargingtimechange, dischargingtimechange, levelchange) - SSR-safe with proper cleanup on unmount - Includes DOM and SSR tests Closes react-hookz#33 (partial - sensor hooks)
There was a problem hiding this comment.
Pull request overview
This PR adds a new useBattery hook that tracks device battery state using the Battery Status API. The hook provides battery charge level, charging status, and time estimates, with proper SSR safety and event subscription handling.
Changes:
- Adds
useBatteryhook with support for tracking battery charging state, level, and time estimates - Includes comprehensive test coverage with 8 DOM tests and 5 SSR tests
- Adds Battery API mock setup for testing environment
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/useBattery/index.ts | Core hook implementation that subscribes to Battery Status API events and returns battery state |
| src/useBattery/index.dom.test.ts | DOM environment tests covering hook behavior, event subscriptions, and state updates |
| src/useBattery/index.ssr.test.ts | SSR tests verifying safe fallback behavior when Battery API is unavailable |
| src/util/testing/setup/battery.test.ts | Test setup file that mocks the Battery Status API for vitest |
| vitest.config.ts | Configuration update to include battery test setup |
| src/index.ts | Exports the new useBattery hook under the Navigator section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
samithahansaka
force-pushed
the
feat/use-battery
branch
from
82a966f to
d2afe76
Compare
- Add mounted flag to prevent state updates after unmount
- Prevent event listener registration if component unmounts before
getBattery() resolves
- Add .catch() handler to gracefully handle promise rejections
- Fix misleading comment for fetched field
samithahansaka
force-pushed
the
feat/use-battery
branch
from
d2afe76 to
11be20c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
useBatteryhook that tracks device battery state using the Battery Status API{ isSupported, fetched, charging, chargingTime, dischargingTime, level }Test plan
Partial implementation of #33 (sensor hooks from react-use)