SortBy

Properties

Name	Type	Description
activeRule	SortByRuleDefinition | undefined	If no sort rule has been set, the first rule in the stack will be considered active.
sortDirection	'asc'|'desc'
userHasSetSortDirection	boolean	Determine if the user has changed the value away from the initial rule.
rules	SortByRuleDefinition[]	All rules, active or not. Useful for building controls.

Methods

cycleSortDirection

Cycle between the active rule's default sort, desc, and asc.

finder.sortBy.cycleSortDirection(): void

isRuleActive

Test a rule to see if it is the currently active rule. Useful for building controls.

finder.sortBy.isRuleActive(id: SortByRuleDefinition | string): boolean;

reset

Reset to the initial sort rule and direction.

finder.sortBy.reset(): void

set

finder.sortBy.set(id: SortByRuleDefinition | string, direction?: 'asc' | 'desc'): void

setSortDirection

finder.sortBy.setSortDirection(direction: 'asc' | 'desc'): void

toggleSortDirection

Flip between desc and asc.

finder.sortBy.toggleSortDirection(): void

The Sortby api can be accessed from finder.sortBy.

Example Usage

function SortByControls() {
    const finder = useFinder();
    return (
        <select onChange={(e) => finder.sortBy.set(e.currentTarget.value)}>
            {finder.sortBy.rules.map((rule) => (
                <option value={rule.id} key={rule.id}>
                    {rule.label}
                </option>
            ))}
        </select>
    );
}

Ye Olde Banana Stand

Snowpea
Expires: Wed, May 27

$0.65

Raspberry
Expires: Wed, May 27

$9.55

Fingerlime
Expires: Thu, May 28

$1.73

Papaw
Expires: Fri, May 29

$4.92

Grape
Expires: Fri, May 29

$7.82

Sultana
Expires: Fri, May 29

$3.35

Kiwi fruit
Expires: Fri, May 29

$5.04

Peach
Expires: Sat, May 30

$6.21

Avocado
Expires: Sun, May 31

$2.99

Longan
Expires: Sun, May 31

$6.64

Custard apple
Expires: Sun, May 31

$8.58

Butternut pumpkin
Expires: Sun, May 31

$6.90

Nashi pear
Expires: Sun, May 31

$3.02

Guava
Expires: Mon, Jun 1

$8.60

Papaya
Expires: Mon, Jun 1

$9.63

Kiwiberry
Expires: Mon, Jun 1

$9.54

Kiwiberry
Expires: Tue, Jun 2

$7.72

Mandarin
Expires: Wed, Jun 3

$8.01

Pear
Expires: Thu, Jun 4

$1.86

Dried apricot
Expires: Thu, Jun 4

$2.36

Custard apple
Expires: Thu, Jun 4

$2.16

Banana
Expires: Fri, Jun 5

$2.69

Bush tomato
Expires: Fri, Jun 5

$9.90

Loquat
Expires: Sat, Jun 6

$7.24

Sultana
Expires: Sat, Jun 6

$0.56

Feijoa
Expires: Sat, Jun 6

$9.30

Date
Expires: Sat, Jun 6

$5.21

Mangosteen
Expires: Sun, Jun 7

$7.12

Custard apples daikon
Expires: Sun, Jun 7

$1.07

Custard apple
Expires: Sun, Jun 7

$4.73

Incaberry
Expires: Sun, Jun 7

$0.86

Pineapple
Expires: Mon, Jun 8

$7.75

Prune
Expires: Tue, Jun 9

$2.94

Aubergine
Expires: Tue, Jun 9

$1.53

Cumquat
Expires: Tue, Jun 9

$8.73

Dragonfruit
Expires: Tue, Jun 9

$6.79

Dragonfruit
Expires: Tue, Jun 9

$9.97

Blackberry
Expires: Tue, Jun 9

$6.06

Snowpea
Expires: Thu, Jun 11

$8.96

Corella pear
Expires: Thu, Jun 11

$1.14

Guava
Expires: Thu, Jun 11

$1.23

Banana
Expires: Fri, Jun 12

$2.34

Prune
Expires: Fri, Jun 12

$1.30

Berry
Expires: Sat, Jun 13

$1.26

Butternut pumpkin
Expires: Sat, Jun 13

$1.88

Peach
Expires: Sat, Jun 13

$4.22

Peach
Expires: Sat, Jun 13

$7.00

Cumquat
Expires: Sun, Jun 14

$4.23

Cavalo
Expires: Sun, Jun 14

$9.22

Lychee
Expires: Mon, Jun 15

$2.78

Avocado
Expires: Mon, Jun 15

$1.81

Elderberry
Expires: Mon, Jun 15

$6.44

Fingerlime
Expires: Mon, Jun 15

$2.63

Sultana
Expires: Tue, Jun 16

$8.61

Grapefruit
Expires: Tue, Jun 16

$4.83

Peach
Expires: Tue, Jun 16

$7.88

Berry
Expires: Tue, Jun 16

$9.44

Nashi pear
Expires: Wed, Jun 17

$9.44

Pomegranate
Expires: Wed, Jun 17

$1.05

Fig
Expires: Wed, Jun 17

$5.73

Rockmelon
Expires: Wed, Jun 17

$7.08

Cherry
Expires: Thu, Jun 18

$1.08

Cherry
Expires: Thu, Jun 18

$9.60

Sultana
Expires: Fri, Jun 19

$0.76

Sprout
Expires: Fri, Jun 19

$2.88

Fig
Expires: Fri, Jun 19

$5.14

Pear
Expires: Fri, Jun 19

$9.63

Date
Expires: Fri, Jun 19

$1.24

Pear
Expires: Sat, Jun 20

$2.07

Peach
Expires: Sun, Jun 21

$3.55

Watermelon
Expires: Sun, Jun 21

$4.41

Tomato
Expires: Sun, Jun 21

$5.36

Custard apples daikon
Expires: Sun, Jun 21

$7.84

Prune
Expires: Sun, Jun 21

$0.55

Cranberry
Expires: Sun, Jun 21

$0.84

Currant
Expires: Mon, Jun 22

$5.13

Rockmelon
Expires: Mon, Jun 22

$1.77

Mandarin
Expires: Mon, Jun 22

$2.57

Berry
Expires: Mon, Jun 22

$5.87

Peach
Expires: Tue, Jun 23

$3.88

Mulberry
Expires: Tue, Jun 23

$6.12

Dried apricot
Expires: Tue, Jun 23

$3.79

Kiwiberry
Expires: Wed, Jun 24

$0.83

Loquat
Expires: Thu, Jun 25

$6.04

Snowpea
Expires: Thu, Jun 25

$6.23

Guava
Expires: Fri, Jun 26

$9.14

Banana
Expires: Fri, Jun 26

$5.01

Elderberry
Expires: Sat, Jun 27

$3.17

Berry
Expires: Sat, Jun 27

$2.07

Loquat
Expires: Sun, Jun 28

$3.03

Incaberry
Expires: Sun, Jun 28

$6.86

Loquat
Expires: Sun, Jun 28

$6.28

Prune
Expires: Sun, Jun 28

$4.34

Dried apricot
Expires: Mon, Jun 29

$7.15

Mandarin
Expires: Mon, Jun 29

$1.55

Nectarine
Expires: Mon, Jun 29

$4.55

Melon
Expires: Tue, Jun 30

$4.34

Pomegranate
Expires: Wed, Jul 1

$2.59

Nashi pear
Expires: Wed, Jul 1

$4.63

Apple
Expires: Thu, Jul 2

$7.57

Assets from https://ninjikin.itch.io/fruit