Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fast-buses-push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"tiny-hooks": minor
---

Add new `useBatteryStatus` hook
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export { useBatteryStatus } from "./useBatteryStatus";
export { useBoolean } from "./useBoolean";
export { useBrowserCapabilities } from "./useBrowserCapabilities";
export { useClickAnywhere } from "./useClickAnywhere";
Expand Down
2 changes: 2 additions & 0 deletions src/useBatteryStatus/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export type { BatteryStatus } from "./types";
export { useBatteryStatus } from "./useBatteryStatus";
7 changes: 7 additions & 0 deletions src/useBatteryStatus/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface BatteryStatus {
supported: boolean;
charging?: boolean;
level?: number;
chargingTime?: number;
dischargingTime?: number;
}
75 changes: 75 additions & 0 deletions src/useBatteryStatus/useBatteryStatus.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { beforeEach, describe, expect, it, vi } from "bun:test";
import { act, renderHook, waitFor } from "@testing-library/react";
import { useBatteryStatus } from "./useBatteryStatus";

const createMockBattery = (overrides = {}) => ({
charging: true,
level: 0.85,
chargingTime: 1200,
dischargingTime: 3600,
addEventListener: vi.fn(),
removeEventListener: vi.fn(),
...overrides,
});

describe("useBatteryStatus", () => {
beforeEach(() => {
vi.restoreAllMocks();
});

it("should return supported=false if Battery API not available", async () => {
const originalNavigator = global.navigator;
// @ts-expect-error
globalThis.navigator = {};

const { result } = renderHook(() => useBatteryStatus());

await waitFor(() => {
expect(result.current.supported).toBe(false);
});

globalThis.navigator = originalNavigator;
});

it("should return initial battery data if Battery API is available", async () => {
const mockBattery = createMockBattery();
// @ts-expect-error
global.navigator.getBattery = vi.fn().mockResolvedValue(mockBattery);

const { result } = renderHook(() => useBatteryStatus());

await waitFor(() => {
expect(result.current.supported).toBe(true);
expect(result.current.charging).toBe(true);
expect(result.current.level).toBe(0.85);
expect(result.current.chargingTime).toBe(1200);
expect(result.current.dischargingTime).toBe(3600);
});
});

it("should update state when battery events fire", async () => {
let changeHandler: (() => void) | undefined;

const mockBattery = createMockBattery({
addEventListener: vi.fn((event, handler) => {
if (event === "levelchange") changeHandler = handler;
}),
});
// @ts-expect-error
global.navigator.getBattery = vi.fn().mockResolvedValue(mockBattery);

const { result } = renderHook(() => useBatteryStatus());

await waitFor(() => expect(result.current.supported).toBe(true));

mockBattery.level = 0.5;

act(() => {
changeHandler?.();
});

await waitFor(() => {
expect(result.current.level).toBe(0.5);
});
});
});
68 changes: 68 additions & 0 deletions src/useBatteryStatus/useBatteryStatus.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import { useEffect, useState } from "react";
import { assertClient } from "../utils/assertClient.ts";
import type { BatteryStatus } from "./types.ts";

export function useBatteryStatus(): BatteryStatus {
assertClient();
const [battery, setBattery] = useState<BatteryStatus>({
supported: true,
charging: undefined,
level: undefined,
chargingTime: undefined,
dischargingTime: undefined,
});

useEffect(() => {
// biome-ignore lint/suspicious/noExplicitAny: TS ist dumb
let batteryManager: any;

const handleChange = () => {
if (batteryManager) {
setBattery({
supported: true,
charging: batteryManager.charging,
level: batteryManager.level,
chargingTime: batteryManager.chargingTime,
dischargingTime: batteryManager.dischargingTime,
});
}
};

const setup = async () => {
try {
// biome-ignore lint/suspicious/noExplicitAny: TS ist dumb
const nav = navigator as any;
if (typeof nav.getBattery !== "function") {
setBattery({ supported: false });
return;
}

batteryManager = await nav.getBattery();
handleChange();

batteryManager.addEventListener("chargingchange", handleChange);
batteryManager.addEventListener("levelchange", handleChange);
batteryManager.addEventListener("chargingtimechange", handleChange);
batteryManager.addEventListener("dischargingtimechange", handleChange);
} catch {
setBattery({ supported: false });
}
};

setup();

return () => {
if (batteryManager) {
batteryManager.removeEventListener("chargingchange", handleChange);
batteryManager.removeEventListener("levelchange", handleChange);
batteryManager.removeEventListener("chargingtimechange", handleChange);
batteryManager.removeEventListener(
"dischargingtimechange",
handleChange,
);
}
};
}, []);

return battery;
}