cypress/docs/source/api/commands/uncheck.md

title, comments

title	comments
uncheck	true

Uncheck checkbox(es).

Syntax

.uncheck()
.uncheck(value)
.uncheck(values)
.uncheck(options)
.uncheck(value, options)
.uncheck(values, options)

Usage

.uncheck() requires being chained off another cy command that yields a DOM element of type checkbox.

{% fa fa-check-circle green %} Valid Usage

cy.get('[type="checkbox"]').uncheck()   // Unchecks checkbox element

{% fa fa-exclamation-triangle red %} Invalid Usage

cy.uncheck('[type="checkbox"]') // Errors, cannot be chained off 'cy'
cy.get('p:first').uncheck()     // Errors, '.get()' does not yield checkbox

Arguments

{% fa fa-angle-right %} value (String)

Value of checkbox that should be unchecked.

{% fa fa-angle-right %} values (Array)

Values of checkboxes that should be unchecked.

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of .uncheck().

Option	Default	Notes
force	false	Forces check, disables error checking prior to check
interval	16	Interval which to retry a check
log	true	Whether to display command in Command Log
timeout	defaultCommandTimeout	Total time to retry the check

Examples

Uncheck

Uncheck all checkboxes

cy.get(':checkbox').uncheck()

Uncheck element with the id 'saveUserName'

cy.get('#saveUserName').uncheck()

Value

Uncheck the checkbox with the value of 'ga'

cy.get('input[type="checkbox"]').uncheck(['ga'])

Values

Uncheck the checkboxes with the values 'ga' and 'ca'

cy.get('[type="checkbox"]').uncheck(['ga', 'ca'])

Command Log

Uncheck the first checkbox

cy
  .get('[data-js="choose-all"]').click()
  .find('input[type="checkbox"]').first().uncheck()

The commands above will display in the command log as:

When clicking on uncheck within the command log, the console outputs the following:

See also

• {% url .check() check %}
• {% url .click() click %}