uncheck.md

title
uncheck

Uncheck checkbox(es).

Syntax

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

Usage

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

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

{% fa fa-exclamation-triangle red %} Incorrect 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	Description
log	true	{% usage_options log %}
force	false	{% usage_options force uncheck %}
timeout	{% url defaultCommandTimeout configuration#Timeouts %}	{% usage_options timeout .uncheck %}

Yields {% helper_icon yields %}

{% yields same_subject .uncheck %}

Examples

No Args

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'])

Notes

Actionability

The element must first reach actionability

.uncheck() is an "action command" that follows all the rules {% url 'defined here' interacting-with-elements %}.

Rules

Requirements {% helper_icon requirements %}

{% requirements uncheckability .uncheck %}

Assertions {% helper_icon assertions %}

{% assertions actions .uncheck %}

Timeouts {% helper_icon timeout %}

{% timeouts actions .uncheck %}

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:

{% imgTag /img/api/uncheck/test-unchecking-a-checkbox.png "Command Log uncheck" %}

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

{% imgTag /img/api/uncheck/console-shows-events-from-clicking-the-checkbox.png "Console Log uncheck" %}

{% history %} {% url "0.6.12" changelog#0-6-12 %} | Added option force {% url "0.3.3" changelog#0-3-3 %} | .uncheck() command added {% endhistory %}

See also

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