4.6.100 • Published 12 months ago

@patrtorg/sed-veritatis-placeat v4.6.100

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

npm version Build Status Coverage report code style: prettier

Install

npm install --save-dev react-select-event

Import react-select-event in your unit tests:

import selectEvent from "react-select-event";
// or
const selectEvent = require("react-select-event");

Supported versions of react-select

This library is tested against all versions of react-select starting from 4.0.0.

API

Every helper exported by react-select-event takes a handle on the react-select input field as its first argument. For instance, this can be: getByLabelText("Your label name").

select(input: HTMLElement, optionOrOptions: Matcher | Array<Matcher>, config?: object): Promise<void>

The optionOrOptions parameter can be any valid dom-testing-library TextMatch object (eg. string, regex, function, number).

Select one or more values in a react-select dropdown.

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Select options={OPTIONS} name="food" inputId="food" isMulti />
  </form>
);
expect(getByRole("form")).toHaveFormValues({ food: "" });

await selectEvent.select(getByLabelText("Food"), ["Strawberry", "Mango"]);
expect(getByRole("form")).toHaveFormValues({ food: ["strawberry", "mango"] });

await selectEvent.select(getByLabelText("Food"), "Chocolate");
expect(getByRole("form")).toHaveFormValues({
  food: ["strawberry", "mango", "chocolate"],
});

This also works for async selects:

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Async
      options={[]}
      loadOptions={fetchTheOptions}
      name="food"
      inputId="food"
      isMulti
    />
  </form>
);
expect(getByRole("form")).toHaveFormValues({ food: "" });

// start typing to trigger the `loadOptions`
userEvent.type(getByLabelText("Food"), "Choc");
await selectEvent.select(getByLabelText("Food"), "Chocolate");
expect(getByRole("form")).toHaveFormValues({
  food: ["chocolate"],
});

select also accepts an optional config parameter. config.container can be used to specify a custom container to use when the react-select dropdown is rendered in a portal using menuPortalTarget:

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Select
      options={OPTIONS}
      name="food"
      inputId="food"
      isMulti
      menuPortalTarget={document.body}
    />
  </form>
);
await selectEvent.select(getByLabelText("Food"), ["Strawberry", "Mango"], {
  container: document.body,
});
expect(getByRole("form")).toHaveFormValues({ food: ["strawberry", "mango"] });

The container can also be passed in as a function if it needs to be lazily evaluated:

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Select
      options={OPTIONS}
      name="food"
      inputId="food"
      isMulti
      menuPortalTarget={document.body}
    />
  </form>
);
await selectEvent.select(getByLabelText("Food"), ["Strawberry", "Mango"], {
  container: () => document.body.querySelector("[class$=-menu]"),
});
expect(getByRole("form")).toHaveFormValues({ food: ["strawberry", "mango"] });

create(input: HTMLElement, option: string, config?: object): Promise<void> }

Creates and selects a new item. Only applicable to react-select Creatable elements.

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Creatable options={OPTIONS} name="food" inputId="food" />
  </form>
);
expect(getByRole("form")).toHaveFormValues({ food: "" });
await selectEvent.create(getByLabelText("Food"), "papaya");
expect(getByRole("form")).toHaveFormValues({ food: "papaya" });

create take an optional config parameter:

clearFirst(input: HTMLElement): Promise<void>

Clears the first value in the dropdown.

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Creatable
      defaultValue={OPTIONS[0]}
      options={OPTIONS}
      name="food"
      inputId="food"
      isMulti
    />
  </form>
);
expect(getByRole("form")).toHaveFormValues({ food: "chocolate" });
await selectEvent.clearFirst(getByLabelText("Food"));
expect(getByRole("form")).toHaveFormValues({ food: "" });

clearAll(input: HTMLElement): Promise<void>

Clears all values in the dropdown.

const { getByRole, getByLabelText } = render(
  <form role="form">
    <label htmlFor="food">Food</label>
    <Creatable
      defaultValue={[OPTIONS[0], OPTIONS[1], OPTIONS[2]]}
      options={OPTIONS}
      name="food"
      inputId="food"
      isMulti
    />
  </form>
);
expect(getByRole("form")).toHaveFormValues({
  food: ["chocolate", "vanilla", "strawberry"],
});
await selectEvent.clearAll(getByLabelText("Food"));
expect(getByRole("form")).toHaveFormValues({ food: "" });

openMenu(input: HTMLElement): void

Opens the select dropdown menu by focusing the input and simulating a down arrow keypress.

const { getByLabelText, queryByText } = render(
  <form>
    <label htmlFor="food">Food</label>
    <Select options={[{ label: "Pizza", value: 1 }]} inputId="food" />
  </form>
);
expect(queryByText("Pizza")).toBeNull();
selectEvent.openMenu(getByLabelText("Food"));
expect(getByText("Pizza")).toBeInTheDocument();

Credits

All the credit goes to Daniel and his StackOverflow answer: https://stackoverflow.com/a/56085734.

clibinariestoArrayinstallcopyphoneeslint-pluginsesfast-deep-copybufferECMAScript 2017typesafeestreeoffsetkinesispredictable6to5typeerrorStyleSheetyupstylingwhichoutputfastcloneHyBiconcatimportclientgdprcall-bindrandomwaapidirjshintgroupByvarscolumnsartspinnerlintcolumnstableasynclistenersimmutablemapreduceECMAScript 2021eslintfork.envECMAScript 2022form-validationObservableeventDispatchera11yWeakMapcloudwatchtrimStartcommand-linepathmatchesInt16Arraychanneluninstallpipegettertelephonechildwritablehas-ownerror-handlingregexenvironmentspoint-freecolorsremoveconfigurablevpceast-asian-widthfixed-widthasciihandlersinputargsArray.prototype.flattenbusyentriesdom-testing-libraryconstArray.prototype.containsownES2021termtransporttacitstatebyteOffsetArrayBuffer#slicefetchutil.inspectspawnsequenceautoprefixertoolsclonebootstrap cssless mixinstselasticacheArrayBuffer.prototype.slicees5astmergefullwidthsetImmediatereact-hookscreatepuremodulehelperWeakSetpackage.jsonpolyfillxtermmixinsflatwafconcatMapomitpreserve-symlinksobjES3unicodeworkerserializercurriednpmautoscalingclass-validatordefinestringcompileres-shimsiterationquotefullio-tsexpressmkdirrdsponyfillliveurlairbnbwaitloadingvalidprogressbannerfileenvironmentfpsArray.prototype.flatMapieshellkeyapilinkargumentnamesStreamshookformpreprocessorfnmatchajaxwalkeventsRFC-6455propertygetintrinsicArray.prototype.findLasttypedarrayvariablesclassnamedescriptorAsyncIteratorformsharedarraybufferrfc4122classesexecfilettyindicatorwindowresolvedeepcopytrimLeftstylesheetanimationignorevalidatorReflect.getPrototypeOfefficientdynamodbES2015tddUint8ClampedArrayglobal objectrequestglobal this valueisperformancenested csssyntaxerrorMicrosoftRegExp#flagscurlflagglobalsgradients csseventEmitterawesomesaucerapidsharedprettypopmotionjestnodepackageses6json-schema-validatorruntimeargvqueryagent.gitignorecryptoformatFloat32Arraycallboundserializationfast-copy[[Prototype]]lockfilegetOwnPropertyDescriptorinspectsigtermdefinePropertylanguagepositiveObject.keysfast-deep-cloneloggerspeedfastcopyarraywgetcompile lessglacierprefixansitc39groupchromiumfindLastIndexl10nbundleriteratorreadablecall-boundintrinsicreal-timeoptimizer3dcertificatesdeterministicutilsURLSearchParamsutilbyteLengthcensorauthES2023enumerabletranspileYAMLmove
4.6.100

12 months ago

4.6.99

12 months ago

4.6.98

12 months ago

4.6.97

12 months ago

4.6.96

12 months ago

4.6.95

12 months ago

4.6.94

1 year ago

4.6.93

1 year ago

4.6.92

1 year ago

4.5.92

1 year ago

4.5.91

1 year ago

4.5.90

1 year ago

4.5.89

1 year ago

4.5.88

1 year ago

4.5.87

1 year ago

4.5.86

1 year ago

4.5.85

1 year ago

4.5.84

1 year ago

4.5.83

1 year ago

4.4.83

1 year ago

4.4.82

1 year ago

4.4.81

1 year ago

4.4.80

1 year ago

4.4.79

1 year ago

4.4.78

1 year ago

3.4.78

1 year ago

3.4.77

1 year ago

3.4.76

1 year ago

3.4.75

1 year ago

3.4.74

1 year ago

3.4.73

1 year ago

3.4.72

1 year ago

3.4.71

1 year ago

3.4.70

1 year ago

2.4.70

1 year ago

2.4.69

1 year ago

2.4.68

1 year ago

2.4.67

1 year ago

2.4.66

1 year ago

2.4.65

1 year ago

2.4.64

1 year ago

2.4.63

1 year ago

2.4.62

1 year ago

2.4.61

1 year ago

2.4.60

1 year ago

2.4.59

1 year ago

2.4.58

1 year ago

2.4.57

1 year ago

2.4.56

1 year ago

2.4.55

1 year ago

2.4.54

1 year ago

2.4.53

1 year ago

2.4.52

1 year ago

2.4.51

1 year ago

2.4.50

1 year ago

2.4.49

1 year ago

2.4.48

1 year ago

2.4.47

1 year ago

2.4.46

1 year ago

2.4.45

1 year ago

2.3.45

1 year ago

2.3.44

1 year ago

1.3.44

1 year ago

1.2.44

1 year ago

1.2.43

1 year ago

1.2.42

1 year ago

1.2.41

1 year ago

1.2.40

1 year ago

1.2.39

1 year ago

1.2.38

1 year ago

1.2.37

1 year ago

1.2.36

1 year ago

1.2.35

1 year ago

1.2.34

1 year ago

1.2.33

1 year ago

1.2.32

1 year ago

1.2.31

1 year ago

1.2.30

1 year ago

1.2.29

1 year ago

1.2.28

1 year ago

1.2.27

1 year ago

1.2.26

1 year ago

1.2.25

1 year ago

1.2.24

1 year ago

1.2.23

1 year ago

1.2.22

1 year ago

1.2.21

1 year ago

1.2.20

1 year ago

1.1.20

1 year ago

1.1.19

1 year ago

1.1.18

1 year ago

1.1.17

1 year ago

1.1.16

1 year ago

1.1.15

1 year ago

1.1.14

1 year ago

1.1.13

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago