use-color-scheme

Detect user system color scheme with window.matchMedia API

Import

Source

View source code

Docs

Edit this page

Package

@asuikit/hooks

Usage

use-color-scheme returns color scheme value i.e. either dark or light:

Your system color scheme is light

import { Badge } from '@asuikit/core';
import { useColorScheme } from '@asuikit/hooks';

function Demo() {
  const colorScheme = useColorScheme();

  return (
    <Badge color={colorScheme === 'dark' ? 'blue' : 'teal'} variant="filled">
      Your system color scheme is {colorScheme}
    </Badge>
  );
}

Hook uses use-media-query hook under the hood. Hook relies on window.matchMedia() API and will always return light if the api is not available (e.g. during server side rendering) unless initial value is provided in first argument.

Definition

function useColorScheme(
  initialValue?: 'dark' | 'light',
  options?: {
    getInitialValueInEffect: boolean;
  }
): 'dark' | 'light';

Go back

use-click-outside – @asuikit/hooks

Up next

use-element-size – @asuikit/hooks

Build fully functional accessible web applications faster than ever

About

Contribute About Mantine Changelog Releases

Community

Chat on Discord Follow on Twitter Follow on GitHub GitHub discussions

Project

Mantine UI Documentation GitHub organization npm organization

Built by Vitaly Rtishchev and these awesome people

Join Discord community

Follow Mantine on Twitter