useSortV2

React API

Parametrit

• data

  Pakollinen

  Järjestettävä data.

  Tyyppi: Array<T>

• options

  Hookille annettavat asetukset.

  Tyyppi: UseSortV2Options<T, K>

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  collatorOptions	Intl.CollatorOptions	{ numeric: true, ignorePunctuation: true }
  compare	UseSortV2Compare	-
  defaultSort	UseSortV2Config<K>	-
  fields	Partial<Record<K, UseSortV2FieldConfig<T>>>	-
  getValue	UseSortV2GetGlobalValue<T, K>	-
  locale	string	fi
  nullishOrder	"auto" | "first" | "last"	auto
  onChange	(sort: UseSortV2Config<K>) => void	-
  sort	UseSortV2Config<K>	-

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: UseSortV2Order

• requestSort

  Funktio, joka järjestää datan automaattisesti valmiin järjestyksen (ei järjestystä → laskeva järjestys → nouseva järjestys → ei järjestystä) mukaisesti.

  Tyyppi: (key: string) => void

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  key *pakollinen	string	-

• setSort

  Funktio, joka järjestää datan annetun avaimen ja järjestyksen mukaisesti.

  Tyyppi: (key: string, order: UseSortV2Order) => void

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  key *pakollinen	string	-
  order *pakollinen	UseSortV2Order	-

• clearSort

  Funktio, joka nollaa järjestyksen.

  Tyyppi: () => void