Documentation

usePrefersColorScheme

Detect system dark/light mode preference.

Installation

pnpm add @rouf-dev/pantheon-ui

Usage

"use client";

import { usePrefersColorScheme } from "@rouf-dev/pantheon-ui";

export function ThemeDetector() {
  const colorScheme = usePrefersColorScheme();

  return (
    <div>
      <p>System prefers: {colorScheme}</p>
      {colorScheme === 'dark' && <p>Dark mode detected</p>}
      {colorScheme === 'light' && <p>Light mode detected</p>}
    </div>
  );
}

Return Value

'light' | 'dark': System color scheme preference