@pickme/review
    Preparing search index...

    Interface ColorModeProviderProps

    interface ColorModeProviderProps {
        attribute?: Attribute | Attribute[];
        children?: ReactNode;
        defaultTheme?: string;
        disableTransitionOnChange?: boolean;
        enableColorScheme?: boolean;
        enableSystem?: boolean;
        forcedTheme?: string;
        nonce?: string;
        scriptProps?: ScriptProps;
        storageKey?: string;
        themes?: string[];
        value?: ValueObject;
    }

    Hierarchy

    • ThemeProviderProps
      • ColorModeProviderProps
    Index

    Properties

    attribute? children? defaultTheme? disableTransitionOnChange? enableColorScheme? enableSystem? forcedTheme? nonce? scriptProps? storageKey? themes? value?

    Properties

    attribute?: Attribute | Attribute[]

    HTML attribute modified based on the active theme. Accepts class, data-* (meaning any data attribute, data-mode, data-color, etc.), or an array which could include both

    children?: ReactNode
    defaultTheme?: string

    Default theme name (for v0.0.12 and lower the default was light). If enableSystem is false, the default theme is light

    disableTransitionOnChange?: boolean

    Disable all CSS transitions when switching themes

    enableColorScheme?: boolean

    Whether to indicate to browsers which color scheme is used (dark or light) for built-in UI like inputs and buttons

    enableSystem?: boolean

    Whether to switch between dark and light themes based on prefers-color-scheme

    forcedTheme?: string

    Forced theme name for the current page

    nonce?: string

    Nonce string to pass to the inline script and style elements for CSP headers

    scriptProps?: ScriptProps

    Props to pass the inline script

    storageKey?: string

    Key used to store theme setting in localStorage

    themes?: string[]

    List of all available theme names

    value?: ValueObject

    Mapping of theme name to HTML attribute value. Object where key is the theme name and value is the attribute value

    Settings

    Member Visibility

    On This Page

    Properties