usePagination

API

Parametrit

• initialPage

  Tyyppi: number

  Oletusarvo: 1

  Oletuksena aktiivinen sivutuksen sivu.

• itemsPerPage

  Tyyppi: number

  Oletusarvo: 10

  Määrittää montako tulosta yhdellä sivulla näytetään.

• middlePages

  Tyyppi: number

  Oletusarvo: 7

  Määrittää montako sivua [...]-elementtien välissä näytetään, kun more = true. Luku sisältää [...]-elementit.

• totalItems

  Tyyppi: number

  Oletusarvo: undefined

  Määrittää montako tulosta jaetaan sivuihin. Käytetään sivujen määrän laskemiseen.

• more

  Tyyppi: boolean

  Oletusarvo: true

  Näytetäänkö [...]-elementit sivunumeroiden sijasta, jos hakutuloksia on paljon.

Paluuarvot

• pages

  Tyyppi: { page: number; more?: boolean }[]

  Sivutuksessa näytettävät sivut.

• totalPages

  Tyyppi: number

  Sivujen lukumäärä yhteensä.

• currentPage

  Tyyppi: number

  Nykyinen sivu.

• changePage

  Tyyppi: (page: number) => void

  Funktio, joka vaihtaa sivua.

• nextPage

  Tyyppi: number

  Seuraava sivu.

• previousPage

  Tyyppi: number

  Edellinen sivu.

• isPrevious

  Tyyppi: boolean

  Kertoo onko edellistä sivua.

• isNext

  Tyyppi: boolean

  Kertoo onko seuraavaa sivua.

• resultsFrom

  Tyyppi: number

  Kertoo mistä alkaen tuloksia näytetään.

• resultsTo

  Tyyppi: number

  Kertoo mihin asti tuloksia näytetään.