useMode

React API

Parametrit

• defaultMode

  Pakollinen

  Ulkoasun oletustila.

  Tyyppi: "light" | "dark" | "system"

• storeFn

  Funktio, jolla ulkoasutilan arvo voidaan tallentaa. Saa parametrina valitun ulkoasutilan.

  Tyyppi: (currentMode) => void

• element

  Elementti, johon tumman tilan css-luokka halutaan asettaa.

  Tyyppi: HTMLElement

  Oletusarvo: document.documentElement

• additionalClassName

  CSS-luokka, joka voidaan asettaa KDS:n tumman teeman oletusluokan lisäksi.

  Tyyppi: string

Paluuarvot

• mode

  Asetettu ulkoasutila.

  Tyyppi: "light" | "dark" | "system"

• functionalMode

  Toiminnallinen ulkoasutila.

  Tyyppi: "light" | "dark"

• setMode

  Funktio ulkoasutilan asettamiseen.

  Tyyppi: (mode: "light" | "dark" | "system") => void