JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11066
  • Score
    100M100P100Q144490F
  • License MIT

React hook for determining the preferred color scheme

Package Exports

  • use-prefers-color-scheme
  • use-prefers-color-scheme/dist/index.cjs.js
  • use-prefers-color-scheme/dist/index.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (use-prefers-color-scheme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

use-prefers-color-scheme

React hook for determining the preferred color scheme

NPM JavaScript Style Guide

Features:

  • SSR support
  • Written in Typescript

Install

npm install --save use-prefers-color-scheme

Usage

Tip When rendered in node (SSR) the hook returns no-preference.

import React from 'react'

import usePrefersColorScheme from 'use-prefers-color-scheme'

const App = () => {
  const prefersColorScheme = usePrefersColorScheme()
  const isDarkMode = prefersColorScheme === 'dark'

  return (
    <div>You are using {isDarkMode ? 'Dark Mode 🌚' : 'Light Mode 🌞'}!</div>
  )
}

Online Demo

Open Codesanbox

License

MIT © rfoel