useBattery

A React Hook for monitoring battery status using the Battery Status API.

Installation

npm install @plenty-hooks/use-battery

Usage

import useBattery from '@plenty-hooks/use-battery';

function BatteryIndicator() {
  const battery = useBattery();

  if (!battery) return <div>Battery info unavailable</div>;

  return (
    <div>
      <p>Battery Level: {(battery.level * 100).toFixed(0)}%</p>
      <p>Charging: {battery.charging ? 'Yes' : 'No'}</p>
    </div>
  );
}

API

useBattery() → BatteryState | null

Returns

Battery state object or null if not supported:

• charging (boolean): Whether the battery is currently charging
• chargingTime (number): Time in seconds until fully charged
• dischargingTime (number): Time in seconds until fully discharged
• level (number): Battery level between 0 and 1