usePagination

React API

Parametrit

• initialPage

  Oletuksena aktiivinen sivutuksen sivu.

  Tyyppi: number

  Oletusarvo: 1

• itemsPerPage

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

  Tyyppi: number

  Oletusarvo: 10

• middlePages

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

  Tyyppi: number

  Oletusarvo: 7

• totalItems

  Pakollinen

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

  Tyyppi: number

  Oletusarvo: undefined

• more

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

  Tyyppi: boolean

  Oletusarvo: true

Paluuarvot

• pages

  Sivutuksessa näytettävät sivut.

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

• totalPages

  Sivujen lukumäärä yhteensä.

  Tyyppi: number

• currentPage

  Nykyinen sivu.

  Tyyppi: number

• changePage

  Funktio, joka vaihtaa sivua.

  Tyyppi: (page: number) => void

• nextPage

  Seuraava sivu.

  Tyyppi: number

• previousPage

  Edellinen sivu.

  Tyyppi: number

• isPrevious

  Kertoo onko edellistä sivua.

  Tyyppi: boolean

• isNext

  Kertoo onko seuraavaa sivua.

  Tyyppi: boolean

• resultsFrom

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

  Tyyppi: number

• resultsTo

  Kertoo mihin asti tuloksia näytetään.

  Tyyppi: number