Appearance

Appearance exposes information about the preferred color scheme (light or dark).

Types

t

Returned from the getColorScheme method or useColorScheme hook, wrapped in Js.Null.t to handle the allowed value null, which is returned when no preference has been indicated. Other allowed values are "dark" and "light", encapsulated as

Appearance.dark
Appearance.light

These values may be compared against what is returned by the method or hook, as in the below example:

Appearance.getColorScheme() === Js.Null.return(Appearance.dark)

Methods

getColorScheme

To query the current preferred color scheme. Note that the preference may be updated later, either through user action or automatically (e.g. on a schedule based on the time of day).

getColorScheme: unit => Js.Null(t)

useColorScheme

To query the current preferred color scheme and subscribe to color scheme updates.

useColorScheme: unit => Js.Null(t)