useBackToTop

API

Parametrit

• className

  Tyyppi: string

  Oletusarvo: kds-fixed kds-z-back-to-top

  Ylikirjoittaa painikkeelle annettavat CSS-luokat, jotka asemoivat painikkeen.

• enabled

  Tyyppi: boolean

  Oletusarvo: true

  Määrittää onko takaisin ylös -toiminto käytössä. Arvo false myös piilottaa painikkeen.

• minPages

  Tyyppi: number

  Oletusarvo: 2

  Määrittää montako vieritettävää "sivua" sivulla tulee olla, jotta takaisin ylös -toiminto aktivoidaan.

• offset

  Tyyppi: { bottom: string; right: string }

  Oletusarvo: { bottom: "1rem", right: "1rem" }

  Määrittää kuinka kaukana takaisin ylös -painike sijaitsee sivun oikeasta alareunasta.

• scrollDelay

  Tyyppi: number

  Oletusarvo: 200

  Rajoittaa vieritystapahtuman (scroll) funktiokutsun suorituksen tapahtumaan vain kerran annetun ajan sisällä, suorituskyvyn parantamiseksi.

• threshold

  Tyyppi: { top: number; bottom: number; scroll: number }

  Oletusarvo: { top: 200, bottom: 200, scroll: 200 }

  Kynnysarvot takaisin ylös -painikkeen piilottamiseen ja näyttämiseen, kun käyttäjä vierittää sivua.

Paluuarvot

• props

  Tyyppi: { className: string; isVisible: boolean; style: CSSProperties; }

  Palauttaa props-objektin, jonka voi välittää BackToTop-komponentille.