useSort

React API

Parametrit

• data

  Pakollinen

  Järjestettävä data.

  Tyyppi: Array<T>

• options

  Hookille annettavat asetukset.

  Tyyppi: UseSortOptions

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  locale	string	fi
  options	Intl.CollatorOptions	{ numeric: true, ignorePunctuation: true }
  defaultOrder	{ key: string; order: UseSortOrder }	-

Paluuarvot

• data

  Järjestetty data.

  Tyyppi: Array<T>

• sortKey

  Avain jonka mukaan data on järjestetty.

  Tyyppi: string

• sortOrder

  Järjestyksen suunta ("ascending" | "descending" | "none")

  Tyyppi: UseSortOrder

• requestSort

  Funktio, joka järjestää datan automaattisesti. Anna parametriksi objekteissa oleva avain (string), jonka mukaan data järjestetään. Anna parametrina `sortFunction` muita kuin `string`-muotoisia arvoja varten. Anna parametrina `valueFunction` kun käytetään muuta kuin objektin avaimella löytyvää arvoa.

  Tyyppi: (key, sortFunction, valueFunction) => void

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  key *pakollinen	string	-
  sortFunction	UseSortSortFunction	-
  valueFunction	UseSortValueFunction	-

• setSort

  Funktio, joka järjestää datan annettujen parametrien perusteella. Anna parametriksi objekteissa oleva avain (string) ja järjestys ("ascending" | "descending" | "none"), jonka mukaan data järjestetään. Anna parametrina `sortFunction` muita kuin `string`-muotoisia arvoja varten. Anna parametrina `valueFunction` kun käytetään muuta kuin objektin avaimella löytyvää arvoa.

  Tyyppi: (key, order, sortFunction, valueFunction) => void

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  key *pakollinen	string	-
  order *pakollinen	UseSortOrder	-
  sortFunction	UseSortSortFunction	-
  valueFunction	UseSortValueFunction	-