Siirry sisältöön

14.5.0

useToggle

UseToggle-hookia käytetään boolean-tyyppisten tilojen luomiseen.

API

Parametrit

  • options

    Tyyppi: { multiple?: boolean, initialOpenIDs?: string[] }

    Oletusarvo: { multiple: true }

    Multiple sallii usean tai vain yhden arvon olla `true` samaan aikaan. Valinnaiseen initialOpenIDs-parametriin asetetaan ID:t, jotka ovat `true` oletuksena.

Paluuarvot

  • isToggleOn

    Tyyppi: (id: string) => boolean

    Palauttaa tiedon onko ID:n tila `true`. Parametrina ID (string).

  • setToggleOn

    Tyyppi: (id: string) => void

    Asettaa ID:n tilan arvoon `true`. Parametrina ID (string).

  • setToggleOff

    Tyyppi: (id: string) => void

    Asettaa ID:n tilan arvoon `false`. Parametrina ID (string).

  • flipToggle

    Tyyppi: (id: string) => void

    Kääntää ID:n tilan. Parametrina ID (string).

  • setAllOn

    Tyyppi: (selection: Array<string>) => void

    Asettaa kaikkien ID:iden tilan arvoon `true`. Parametrina joukko ID-arvoja (string).

  • setAllOff

    Tyyppi: (selection: Array<string>) => void

    Asettaa kaikkien ID:iden tilan arvoon `false`. Parametrina joukko ID-arvoja (string).

  • flipAll

    Tyyppi: (selection: Array<string>) => void

    Kääntää kaikkien ID:iden tilan. Parametrina joukko ID-arvoja (string).