fix!: remove focusTrap option

[ph-fritsche]

What:

Remove focusTrap option from userEvent.tab

Why:

The focusTrap option was introduced so that userEvent.tab could be used with the focus-trap-react package. See #193

If there was an issue with this, it has been resolved.
The following test passes (no codesandbox because focus-trap-react does not work with the jsdom version used by codesandbox):

import React from 'react'
import FocusTrap from 'focus-trap-react'
import { render, screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'

test('focus-trap-react traps focus', () => {
    render(<div>
      <FocusTrap>
        <div>
          <button>A</button>
          <button>B</button>
        </div>
      </FocusTrap>
      <div>
        <button>C</button>
      </div>
    </div>)
  userEvent.keyboard('[Tab]')
  expect(screen.getByText('A')).toHaveFocus()
  userEvent.keyboard('[Tab]')
  expect(screen.getByText('B')).toHaveFocus()
  userEvent.keyboard('[Tab]')
  expect(screen.getByText('A')).toHaveFocus()
})

How:

Without the option and by using the implementation in #767
userEvent.tab could be boiled down to be a small convenience wrapper around userEvent.keyboard.

tab() is equal to keyboard('{Tab}')
tab({shift: true}) is equal to keyboard('{Shift>}{Tab}{/Shift}')
tab({shift: false}) is equal to keyboard('[/ShiftLeft][/ShiftRight]{Tab}')

Checklist:

• Documentation
• Tests
• Ready to be merged

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 482079e:

Sandbox	Source
userEvent-PR-template	Configuration

[codecov]

Codecov Report

Merging #772 (482079e) into alpha (e39177e) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##             alpha      #772   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           65        64    -1     
  Lines         1320      1303   -17     
  Branches       508       504    -4     
=========================================
- Hits          1320      1303   -17     

Impacted Files	Coverage Δ
src/setup.ts	100.00% <ø> (ø)
src/keyboard/plugins/functional.ts	100.00% <100.00%> (ø)
src/tab.ts	100.00% <100.00%> (ø)
src/utils/focus/getTabDestination.ts	100.00% <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 e39177e...482079e. Read the comment docs.

[github-actions]

🎉 This PR is included in version 14.0.0-alpha.5 🎉

The release is available on:

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

Your semantic-release bot 📦🚀