useMode

React API

Parametrit

• additionalClassName

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

  Tyyppi: string

• defaultMode

  Pakollinen

  Ulkoasun oletustila.

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

• mode

  Pakollinen

  Ulkoasun tila, kun hookkia käytetään kontrolloidusti.

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

• element

  Elementti, johon tumman tilan CSS-luokka halutaan asettaa.

  Tyyppi: HTMLElement

  Oletusarvo: document.documentElement

• onChange

  Funktio, jota kutsutaan ulkoasutilan vaihtuessa. Saa parametrina valitun ulkoasutilan. Käytetään esimerkiksi ulkoasutilan tallentamiseen.

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

• storeFn

  Funktio, jota kutsutaan ulkoasutilan vaihtuessa. Saa parametrina valitun ulkoasutilan. Käytetään esimerkiksi ulkoasutilan tallentamiseen. Poistuu käytöstä versiossa 19.0.0. Siirry käyttämään onChange-proppia.

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

• autoDetect

  Määrittää vaihtuuko ulkoasutila automaattisesti, jos käyttöjärjestelmän asetuksia muutetaan.

  Tyyppi: boolean | "initial" | "system"

  Oletusarvo: initial

• shouldCleanup

  Määrittää siivotaanko hookin lisäämät CSS-luokat pois DOM:sta.

  Tyyppi: boolean

  Oletusarvo: false

Paluuarvot

• mode

  Asetettu ulkoasutila.

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

• functionalMode

  Toiminnallinen ulkoasutila.

  Tyyppi: "light" | "dark"

• setMode

  Funktio ulkoasutilan asettamiseen.

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