not
Filter DOM element(s) from a set of DOM elements.
Opposite of
.filter()
The querying behavior of this command matches exactly how
.not()
works in jQuery.
Syntax
.not(selector)
.not(selector, options)
Usage
Correct Usage
cy.get('input').not('.required') // Yield all inputs without class '.required'
Incorrect Usage
cy.not('.icon') // Errors, cannot be chained off 'cy'
cy.location().not() // Errors, 'location' does not yield DOM element
Arguments
selector (String selector)
A selector used to remove matching DOM elements.
options (Object)
Pass in an options object to change the default behavior of .not()
.
Option | Default | Description |
---|---|---|
log |
true |
Displays the command in the Command log |
timeout |
defaultCommandTimeout |
Time to wait for .not() to resolve before timing out
|
Yields
-
.not()
yields the new DOM element(s) it found.
Examples
Selector
Yield the elements that do not have class active
<ul>
<li>Home</li>
<li class="active">About</li>
<li>Services</li>
<li>Pricing</li>
<li>Contact</li>
</ul>
cy.get('ul>li').not('.active').should('have.length', 4) // true
Rules
Requirements
-
.not()
requires being chained off a command that yields DOM element(s).
Assertions
-
.not()
will automatically retry until the element(s) exist in the DOM -
.not()
will automatically retry until all chained assertions have passed
Timeouts
-
.not()
can time out waiting for the element(s) to exist in the DOM . -
.not()
can time out waiting for assertions you've added to pass.
Command Log
Find all buttons that are not of type submit
cy.get('form').find('button').not('[type="submit"]')
The commands above will display in the Command Log as:
When clicking on not
within the command log, the console outputs the following:
See also
© 2017 Cypress.io
Licensed under the MIT License.
https://docs.cypress.io/api/commands/not