useSort

API

Parametrit

• data

  Pakollinen

  Tyyppi: Array<{ [key: string]: any }>

  Järjestettävä data.

• locale

  Tyyppi: string

  Oletusarvo: fi

  Järjestämiseen käytetty locale.

• options

  Tyyppi: Intl.CollatorOptions

  Oletusarvo: { numeric: true, ignorePunctuation: true }

  Intl.Collator-rakentajan options-objekti, jolla järjestyksen toimintaa voi hienosäätää.

• defaultOrder

  Tyyppi: { key: string; order: SortOrder }

  Oletusarvo: -

  Oletusjärjestyksen asetukset.

Paluuarvot

• data

  Tyyppi: Array<{ [key: string]: any }>

  Järjestetty data.

• sortKey

  Tyyppi: string

  Avain jonka mukaan data on järjestetty.

• sortOrder

  Tyyppi: string

  Järjestyksen suunta ["none", "asceding, "descending"]

• requestSort

  Tyyppi: (key: string, sortFunction?: SortFunction, valueFunction?: ValueFunction) => void

  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.

• setSort

  Tyyppi: (key: string, order: SortOrder, sortFunction?: SortFunction, valueFunction?: ValueFunction) => void

  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.