feat: allow selecting options by nodes

[dougbacelar]

What:
Allow selection of combobox options by html nodes. e.g.

render(
    <select>
      <option value="1">first option</option>
    </select>,
  )
userEvent.selectOptions(screen.getByRole('combobox'), screen.getByText('first option'))

Why:

Since users don't directly interact with option values, this should allow for testing in a more user-like way.

How:
In addition to checking for the option.value string, now it also checks if the node itself is in the given array.

Checklist:

• Documentation
• Tests
• Typings
• Ready to be merged
  

---

Comments:
Ideally, I think userEvent.selectOptions should receive option text instead of option values, and warn if it can't find the given option.text.

Since that would be a breaking change, I think this PR could be a good first step towards that direction.

Related to:

• selectOptions by option content #203
• Add ops.target to selectOptions #155

[codecov]

Codecov Report

Merging #297 into master will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #297   +/-   ##
=======================================
  Coverage   98.90%   98.90%           
=======================================
  Files           1        1           
  Lines         182      182           
  Branches       55       56    +1     
=======================================
  Hits          180      180           
  Misses          2        2           

Impacted Files	Coverage Δ
src/index.js	98.90% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6239c3a...18f1021. Read the comment docs.

[kentcdodds]

Totally reasonable 👍

[kentcdodds]

@all-contributors please add @dougbacelar for code and tests

[allcontributors]

@kentcdodds

I've put up a pull request to add @dougbacelar! 🎉

[kentcdodds]

🎉 This PR is included in version 10.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[jsphstls]

Thank you @dougbacelar !

[bullishgopher]

This is cool. Thank you @dougbacelar !