-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: Testing docs #9164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: Testing docs #9164
Conversation
…ack to the visual
| export {installMouseEvent, installPointerEvent} from './testSetup'; | ||
| export {pointerMap} from './userEventMaps'; | ||
| export {User} from './user'; | ||
| export type {CheckboxGroupTester} from './checkboxgroup'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this won't have been released yet either, does that matter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah this I'm not going to put into the docs deploy. But in the final release these new testers will be made available so I'll merge that in then
|
This is DNM until the upcoming docs deploy is done |
|
Build successful! 🎉 |
|
Build successful! 🎉 |
## API Changes
@react-aria/test-utils/@react-aria/test-utils:CheckboxGroupTester+CheckboxGroupTester {
+ checkboxes: Array<HTMLElement>
+ checkboxgroup: HTMLElement
+ constructor: (CheckboxGroupTesterOpts) => void
+ findCheckbox: ({
+ checkboxIndexOrText: number | string
+}) => HTMLElement
+ selectedCheckboxes: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleCheckbox: (TriggerCheckboxOptions) => Promise<void>
+}/@react-aria/test-utils:ComboBoxTester+ComboBoxTester {
+ close: () => Promise<void>
+ combobox: HTMLElement
+ constructor: (ComboBoxTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ focusedOption: HTMLElement | null
+ listbox: HTMLElement | null
+ open: (ComboBoxOpenOpts) => Promise<void>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (ComboBoxSelectOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-aria/test-utils:DialogTester+DialogTester {
+ close: () => Promise<void>
+ constructor: (DialogTesterOpts) => void
+ dialog: HTMLElement | null
+ open: (DialogOpenOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-aria/test-utils:GridListTester+GridListTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ constructor: (GridListTesterOpts) => void
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ gridlist: HTMLElement
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleRowSelection: (GridListToggleRowOpts) => Promise<void>
+ triggerRowAction: (GridListRowActionOpts) => Promise<void>
+}/@react-aria/test-utils:ListBoxTester+ListBoxTester {
+ constructor: (ListBoxTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ listbox: HTMLElement
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectedOptions: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleOptionSelection: (ListBoxToggleOptionOpts) => Promise<void>
+ triggerOptionAction: (ListBoxOptionActionOpts) => Promise<void>
+}/@react-aria/test-utils:MenuTester+MenuTester {
+ close: () => Promise<void>
+ constructor: (MenuTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ menu: HTMLElement | null
+ open: (MenuOpenOpts) => Promise<void>
+ openSubmenu: (MenuOpenSubmenuOpts) => Promise<MenuTester | null>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (MenuSelectOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ submenuTriggers: Array<HTMLElement>
+ trigger: HTMLElement
+}/@react-aria/test-utils:RadioGroupTester+RadioGroupTester {
+ constructor: (RadioGroupTesterOpts) => void
+ findRadio: ({
+ radioIndexOrText: number | string
+}) => HTMLElement
+ radiogroup: HTMLElement
+ radios: Array<HTMLElement>
+ selectedRadio: HTMLElement | null
+ setInteractionType: (UserOpts['interactionType']) => void
+ triggerRadio: (TriggerRadioOptions) => Promise<void>
+}/@react-aria/test-utils:SelectTester+SelectTester {
+ close: () => Promise<void>
+ constructor: (SelectTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ listbox: HTMLElement | null
+ open: (SelectOpenOpts) => Promise<void>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (SelectTriggerOptionOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-aria/test-utils:TableTester+TableTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ columns: Array<HTMLElement>
+ constructor: (TableTesterOpts) => void
+ findCell: ({
+ text: string
+}) => HTMLElement
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ rowGroups: Array<HTMLElement>
+ rowHeaders: Array<HTMLElement>
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ table: HTMLElement
+ toggleRowSelection: (TableToggleRowOpts) => Promise<void>
+ toggleSelectAll: ({
+ interactionType?: UserOpts['interactionType']
+}) => Promise<void>
+ toggleSort: (TableToggleSortOpts) => Promise<void>
+ triggerColumnHeaderAction: (TableColumnHeaderActionOpts) => Promise<void>
+ triggerRowAction: (TableRowActionOpts) => Promise<void>
+}/@react-aria/test-utils:TabsTester+TabsTester {
+ activeTabpanel: HTMLElement | null
+ constructor: (TabsTesterOpts) => void
+ findTab: ({
+ tabIndexOrText: number | string
+}) => HTMLElement
+ selectedTab: HTMLElement | null
+ setInteractionType: (UserOpts['interactionType']) => void
+ tablist: HTMLElement
+ tabpanels: Array<HTMLElement>
+ tabs: Array<HTMLElement>
+ triggerTab: (TriggerTabOptions) => Promise<void>
+}/@react-aria/test-utils:TreeTester+TreeTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ constructor: (TreeTesterOpts) => void
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleRowExpansion: (TreeToggleExpansionOpts) => Promise<void>
+ toggleRowSelection: (TreeToggleRowOpts) => Promise<void>
+ tree: HTMLElement
+ triggerRowAction: (TreeRowActionOpts) => Promise<void>
+}@react-spectrum/test-utils/@react-spectrum/test-utils:CheckboxGroupTester+CheckboxGroupTester {
+ checkboxes: Array<HTMLElement>
+ checkboxgroup: HTMLElement
+ constructor: (CheckboxGroupTesterOpts) => void
+ findCheckbox: ({
+ checkboxIndexOrText: number | string
+}) => HTMLElement
+ selectedCheckboxes: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleCheckbox: (TriggerCheckboxOptions) => Promise<void>
+}/@react-spectrum/test-utils:ComboBoxTester+ComboBoxTester {
+ close: () => Promise<void>
+ combobox: HTMLElement
+ constructor: (ComboBoxTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ focusedOption: HTMLElement | null
+ listbox: HTMLElement | null
+ open: (ComboBoxOpenOpts) => Promise<void>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (ComboBoxSelectOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-spectrum/test-utils:DialogTester+DialogTester {
+ close: () => Promise<void>
+ constructor: (DialogTesterOpts) => void
+ dialog: HTMLElement | null
+ open: (DialogOpenOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-spectrum/test-utils:GridListTester+GridListTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ constructor: (GridListTesterOpts) => void
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ gridlist: HTMLElement
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleRowSelection: (GridListToggleRowOpts) => Promise<void>
+ triggerRowAction: (GridListRowActionOpts) => Promise<void>
+}/@react-spectrum/test-utils:ListBoxTester+ListBoxTester {
+ constructor: (ListBoxTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ listbox: HTMLElement
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectedOptions: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleOptionSelection: (ListBoxToggleOptionOpts) => Promise<void>
+ triggerOptionAction: (ListBoxOptionActionOpts) => Promise<void>
+}/@react-spectrum/test-utils:MenuTester+MenuTester {
+ close: () => Promise<void>
+ constructor: (MenuTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ menu: HTMLElement | null
+ open: (MenuOpenOpts) => Promise<void>
+ openSubmenu: (MenuOpenSubmenuOpts) => Promise<MenuTester | null>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (MenuSelectOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ submenuTriggers: Array<HTMLElement>
+ trigger: HTMLElement
+}/@react-spectrum/test-utils:RadioGroupTester+RadioGroupTester {
+ constructor: (RadioGroupTesterOpts) => void
+ findRadio: ({
+ radioIndexOrText: number | string
+}) => HTMLElement
+ radiogroup: HTMLElement
+ radios: Array<HTMLElement>
+ selectedRadio: HTMLElement | null
+ setInteractionType: (UserOpts['interactionType']) => void
+ triggerRadio: (TriggerRadioOptions) => Promise<void>
+}/@react-spectrum/test-utils:SelectTester+SelectTester {
+ close: () => Promise<void>
+ constructor: (SelectTesterOpts) => void
+ findOption: ({
+ optionIndexOrText: number | string
+}) => HTMLElement
+ listbox: HTMLElement | null
+ open: (SelectOpenOpts) => Promise<void>
+ options: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ sections: Array<HTMLElement>
+ selectOption: (SelectTriggerOptionOpts) => Promise<void>
+ setInteractionType: (UserOpts['interactionType']) => void
+ trigger: HTMLElement
+}/@react-spectrum/test-utils:TableTester+TableTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ columns: Array<HTMLElement>
+ constructor: (TableTesterOpts) => void
+ findCell: ({
+ text: string
+}) => HTMLElement
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ rowGroups: Array<HTMLElement>
+ rowHeaders: Array<HTMLElement>
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ table: HTMLElement
+ toggleRowSelection: (TableToggleRowOpts) => Promise<void>
+ toggleSelectAll: ({
+ interactionType?: UserOpts['interactionType']
+}) => Promise<void>
+ toggleSort: (TableToggleSortOpts) => Promise<void>
+ triggerColumnHeaderAction: (TableColumnHeaderActionOpts) => Promise<void>
+ triggerRowAction: (TableRowActionOpts) => Promise<void>
+}/@react-spectrum/test-utils:TabsTester+TabsTester {
+ activeTabpanel: HTMLElement | null
+ constructor: (TabsTesterOpts) => void
+ findTab: ({
+ tabIndexOrText: number | string
+}) => HTMLElement
+ selectedTab: HTMLElement | null
+ setInteractionType: (UserOpts['interactionType']) => void
+ tablist: HTMLElement
+ tabpanels: Array<HTMLElement>
+ tabs: Array<HTMLElement>
+ triggerTab: (TriggerTabOptions) => Promise<void>
+}/@react-spectrum/test-utils:TreeTester+TreeTester {
+ cells: ({
+ element?: HTMLElement
+}) => Array<HTMLElement>
+ constructor: (TreeTesterOpts) => void
+ findRow: ({
+ rowIndexOrText: number | string
+}) => HTMLElement
+ rows: Array<HTMLElement>
+ selectedRows: Array<HTMLElement>
+ setInteractionType: (UserOpts['interactionType']) => void
+ toggleRowExpansion: (TreeToggleExpansionOpts) => Promise<void>
+ toggleRowSelection: (TreeToggleRowOpts) => Promise<void>
+ tree: HTMLElement
+ triggerRowAction: (TreeRowActionOpts) => Promise<void>
+} |
same content as #9029, I pulled it out of the docs release since it refers to test utils that haven't been released yet
✅ Pull Request Checklist:
📝 Test Instructions:
🧢 Your Project:
RSP