API overview

Locator

In a nutshell, locators represent a way to find element on a page or within a test element.

Available locators

Locator	Description

| byDataTestId(dataTestId) | Locate by data-testid attribute. | | byRole(role) | Locate by the value of role attribute. | | byCssSelector(selector) | Locate by CSS selector. | | byCssClass(className) | Locate by CSS class name. Locate by CSS class is not recommended because it is not reliable and can be changed easily. | | byAttribute(name, value) | Locate element by attribute | | byTagName(tagName) | Locate by HTML tag name (not recommended). | | byValue(value) | Locate by the value of value attribute | | byInputType(type) | Locate by input element by its type, such as text, radio, checkbox etc. | | byName(name) | Locate by the value of name attribute. | | byLinkedElement() | (Experimental) Locate an element by matching attributes from another element | | byChecked(checked) | Locate checkbox which is checked, usually it can be chained with checkbox locator |

Component Drivers

Raw HTML components

Component list

Package: @atomic-testing/component-driver-html

Driver	Description
HTMLAnchorDriver	Driver for <a> elements
HTMLButtonDriver	Driver for <button> or any clickable elements
HTMLCheckboxDriver	Driver for <input type="checkbox"> elements
HTMLCheckboxGroupDriver	Driver for a group of HTML checkboxes, ideal for multiselection
HTMLElementDriver	Driver for any HTML element
HTMLHiddenInputDriver	Driver for <input type="hidden"> elements
HTMLOptionDriver	Driver for <option> elements
HTMLRadioButtonGroupDriver	Driver for a group of HTML radio buttons
HTMLSelectDriver	Driver for <select> element, support both single and multiple selection
HTMLTextInputDriver	Driver for <input type="text"> elements
HTMLTextAreaDriver	Driver for <textarea> elements

MUI V5 components

Component list

Package: @atomic-testing/component-driver-mui-v5

npm

npm install @atomic-testing/component-driver-mui-v5

yarn

yarn add @atomic-testing/component-driver-mui-v5

pnpm

pnpm add @atomic-testing/component-driver-mui-v5

Driver	Description
AccordionDriver	Driver for Accordion component
AlertDriver	Driver for Alert component
AutoCompleteDriver	Driver for Autocomplete component
BadgeDriver	Driver for Badge component
ButtonDriver	Driver for Button or any clickable component
CheckboxDriver	Driver for Checkbox component
ChipDriver	Driver for Chip component
DialogDriver	Driver for Dialog component
FabDriver	Driver for Floating Action Button component
InputDriver	Driver for Input component and its variants
ListDriver	Driver for List component
ListItemDriver	Driver for ListItem component
MenuDriver	Driver for Menu component
MenuItemDriver	Driver for MenuItem component
ProgressDriver	Driver for Progress component
RatingDriver	Driver for Rating component
SelectDriver	Driver for Select component
SliderDriver	Driver for Slider component
SnackbarDriver	Driver for Snackbar component
SwitchDriver	Driver for Switch component
TextFieldDriver	Driver for TextField component
ToggleButtonDriver	Driver for ToggleButton component
ToggleButtonGroupDriver	Driver for ToggleButtonGroup component
ExclusiveToggleButtonGroupDriver	Driver for ToggleButtonGroup with exclusive selection

MUI V6 components

Component list

Package: @atomic-testing/component-driver-mui-v6

Test examples can be found in the example folder under component-driver-mui-v6-test package

Driver	Description
AccordionDriver	Driver for Accordion component
AlertDriver	Driver for Alert component
AutoCompleteDriver	Driver for Autocomplete component (single selection only, multiple selection planned)
BadgeDriver	Driver for Badge component
ButtonDriver	Driver for Button or any clickable component
CheckboxDriver	Driver for Checkbox component
ChipDriver	Driver for Chip component
DialogDriver	Driver for Dialog component
FabDriver	Driver for Floating Action Button component
InputDriver	Driver for Input component and its variants
ListDriver	Driver for List component
ListItemDriver	Driver for ListItem component
MenuDriver	Driver for Menu component
MenuItemDriver	Driver for MenuItem component
ProgressDriver	Driver for Progress component
RatingDriver	Driver for Rating component
SelectDriver	Driver for Select component
SliderDriver	Driver for Slider component
SnackbarDriver	Driver for Snackbar component
SwitchDriver	Driver for Switch component
TextFieldDriver	Driver for TextField component, supports single-line, multiline and selection TextField variants
ToggleButtonDriver	Driver for ToggleButton component
ToggleButtonGroupDriver	Driver for ToggleButtonGroup component
ExclusiveToggleButtonGroupDriver	Driver for ToggleButtonGroup with exclusive selection
DataGridProDriver	Driver for DataGrid/DataGridPro component
DataGridHeaderRowDriver	Driver for header rows in DataGrid
DataGridDataRowDriver	Driver for data rows in DataGrid

MUI V7 components

Component list

Package: @atomic-testing/component-driver-mui-v7

npm

npm install @atomic-testing/component-driver-mui-v7

yarn

yarn add @atomic-testing/component-driver-mui-v7

pnpm

pnpm add @atomic-testing/component-driver-mui-v7

Driver	Description
AccordionDriver	Driver for Accordion component
AlertDriver	Driver for Alert component
AutoCompleteDriver	Driver for Autocomplete component
BadgeDriver	Driver for Badge component
ButtonDriver	Driver for Button or any clickable component
CheckboxDriver	Driver for Checkbox component
ChipDriver	Driver for Chip component
DialogDriver	Driver for Dialog component
FabDriver	Driver for Floating Action Button component
InputDriver	Driver for Input component and its variants
ListDriver	Driver for List component
ListItemDriver	Driver for ListItem component
MenuDriver	Driver for Menu component
MenuItemDriver	Driver for MenuItem component
ProgressDriver	Driver for Progress component
RatingDriver	Driver for Rating component
SelectDriver	Driver for Select component
SliderDriver	Driver for Slider component
SnackbarDriver	Driver for Snackbar component
SwitchDriver	Driver for Switch component
TextFieldDriver	Driver for TextField component
ToggleButtonDriver	Driver for ToggleButton component
ToggleButtonGroupDriver	Driver for ToggleButtonGroup component
ExclusiveToggleButtonGroupDriver	Driver for ToggleButtonGroup with exclusive selection

MUI X V5 components

Component list

Package: @atomic-testing/component-driver-mui-x-v5

npm

npm install @atomic-testing/component-driver-mui-x-v5

yarn

yarn add @atomic-testing/component-driver-mui-x-v5

pnpm

pnpm add @atomic-testing/component-driver-mui-x-v5

Driver	Description
DataGridProDriver	Driver for DataGrid/DataGridPro component
DataGridHeaderRowDriver	Driver for header rows in DataGrid
DataGridDataRowDriver	Driver for data rows in DataGrid
DateRangePickerDriver	Driver for DateRangePicker component
DateTimePickerDriver	Driver for DateTimePicker component
DesktopDatePickerDriver	Driver for DesktopDatePicker component
MobileDatePickerDialogDriver	Driver for MobileDatePicker's dialog component
MobileDatePickerDriver	Driver for MobileDatePicker component
TimePickerDriver	Driver for TimePicker component

MUI X V6 components

Component list

Package: @atomic-testing/component-driver-mui-x-v6

npm

npm install @atomic-testing/component-driver-mui-x-v6

yarn

yarn add @atomic-testing/component-driver-mui-x-v6

pnpm

pnpm add @atomic-testing/component-driver-mui-x-v6

Driver	Description
DataGridProDriver	Driver for DataGrid/DataGridPro component
DataGridHeaderRowDriver	Driver for header rows in DataGrid
DataGridDataRowDriver	Driver for data rows in DataGrid

MUI X V7 components

Component list

Package: @atomic-testing/component-driver-mui-x-v7

npm

npm install @atomic-testing/component-driver-mui-x-v7

yarn

yarn add @atomic-testing/component-driver-mui-x-v7

pnpm

pnpm add @atomic-testing/component-driver-mui-x-v7

Driver	Description
DataGridProDriver	Driver for DataGrid/DataGridPro component
DataGridHeaderRowDriver	Driver for header rows in DataGrid
DataGridDataRowDriver	Driver for data rows in DataGrid

MUI X V8 components

Component list

Package: @atomic-testing/component-driver-mui-x-v8

npm

npm install @atomic-testing/component-driver-mui-x-v8

yarn

yarn add @atomic-testing/component-driver-mui-x-v8

pnpm

pnpm add @atomic-testing/component-driver-mui-x-v8

Driver	Description
DataGridProDriver	Driver for DataGrid/DataGridPro component
DataGridHeaderRowDriver	Driver for header rows in DataGrid
DataGridDataRowDriver	Driver for data rows in DataGrid