Siirry sisältöön
Luonnos

useMode

React Hook ulkoasuteeman tilan vaihtamiseen.

API

Parametrit

  • defaultMode

    Pakollinen

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

    Ulkoasun oletustila

  • storeFn

    Tyyppi: (currentMode) => void

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

  • element

    Tyyppi: HTMLElement

    Oletusarvo: document.documentElement

    Elementti, johon tumman tilan css-luokka halutaan asettaa

  • additionalClassName

    Tyyppi: string

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

Paluuarvot

  • mode

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

    Asetettu ulkoasutila

  • functionalMode

    Tyyppi: "light" | "dark"

    Toiminnallinen ulkoasutila

  • setMode

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

    Asettaa halutun ulkoasutilan