Skip to content

check.md

Latest commit

 

History

History
170 lines (111 loc) · 3.64 KB

check.md

File metadata and controls

170 lines (111 loc) · 3.64 KB
title check

Check checkbox(es) or radio(s).

{% note warning %} This element must be an <input> with type checkbox or radio. {% endnote %}

Syntax

.check()
.check(value)
.check(values)
.check(options)
.check(value, options)
.check(values, options)

Usage

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

cy.get('[type="checkbox"]').check()       // Check checkbox element
cy.get('[type="radio"]').first().check()  // Check first radio element

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

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

Arguments

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

Value of checkbox or radio that should be checked.

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

Values of checkboxes or radios that should be checked.

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

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

Option Default Description
log true {% usage_options log %}
force false {% usage_options force check %}
timeout {% url defaultCommandTimeout configuration#Timeouts %} {% usage_options timeout .check %}

Yields {% helper_icon yields %}

{% yields same_subject .check %}

Examples

No Args

Check all checkboxes

cy.get('[type="checkbox"]').check()

Select all radios

cy.get('[type="radio"]').check()

Check the element with id of 'saveUserName'

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

Value

Select the radio with the value of 'US'

<form>
  <input type="radio" id="ca-country" value="CA">
  <label for="ca-country">Canada</label>
  <input type="radio" id="us-country" value="US">
  <label for="us-country">United States</label>
</form>
cy.get('[type="radio"]').check('US')

Values

Check the checkboxes with the values 'subscribe' and 'accept'

<form>
  <input type="checkbox" id="subscribe" value="subscribe">
  <label for="subscribe">Subscribe to newsletter?</label>
  <input type="checkbox" id="acceptTerms" value="accept">
  <label for="acceptTerms">Accept terms and conditions.</label>
</form>
cy.get('form input').check(['subscribe', 'accept'])

Options

Check an invisible checkbox

You can ignore Cypress' default behavior of checking that the element is visible, clickable and not disabled by setting force to true in the options.

cy.get('.action-checkboxes').should('not.be.visible') // Passes
  .check({ force: true }).should('be.checked')        // Passes

Notes

Actionability

The element must first reach actionability

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

Rules

Requirements {% helper_icon requirements %}

{% requirements checkability .check %}

Assertions {% helper_icon assertions %}

{% assertions actions .check %}

Timeouts {% helper_icon timeout %}

{% timeouts actions .check %}

Command Log

check the element with name of 'emailUser'

cy.get('form').find('[name="emailUser"]').check()

The commands above will display in the Command Log as:

{% imgTag /img/api/check/check-checkbox-in-cypress.png "Command log for check" %}

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

{% imgTag /img/api/check/console-showing-events-on-check.png "console.log for check" %}

See also

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