blur

Improve this doc

Blur a focused element.

This element must currently be in focus. If you want to ensure an element is focused before blurring, try using .focus() before .blur().

Syntax

.blur()
.blur(options)

Usage

Correct Usage

cy.get('[type="email"]').type('[email protected]').blur() // Blur email input
cy.get('[tabindex="1"]').focus().blur()              // Blur el with tabindex

Incorrect Usage

cy.blur('input')              // Errors, cannot be chained off 'cy'
cy.window().blur()            // Errors, 'window' does not yield DOM element

Arguments

options (Object)

Pass in an options object to change the default behavior of .blur.

Option Default Description
log true Displays the command in the Command log
force false Forces the action, disables checking if element is focused
timeout defaultCommandTimeout Time to wait for .blur() to resolve before timing out

Yields

  • .blur() yields the same subject it was given from the previous command.

Examples

No Args

Blur the comment input.

cy.get('[name="comment"]').type('Nice Product!').blur()

Options

Blur the first input

Setting force to true in the options disables checking whether the input is focusable or currently has focus.

cy.get('input:first').blur({ force: true })

Notes

Actionability

Blur is not an action command

.blur() is not implemented like other action commands, and does not follow the same rules of waiting for actionability.

.blur() is just a helpful command which is a simple shortcut. Normally there’s no way for a user to simply “blur” an element. Typically the user would have to perform another action like clicking or tabbing to a different element. Needing to perform a separate action like this is very indirect.

Therefore it’s oftentimes much easier and simpler to test the blur behavior directly with .blur().

Timeouts

.blur() can time out because your browser did not receive any blur events.

If you see this error, you may want to ensure that the main browser window is currently focused. This means not being focused in debugger or any other window when the command is run.

Internally Cypress does account for this, and will polyfill the blur events when necessary to replicate what the browser does. Unfortunately the browser will still behave differently when not in focus - for instance it may throttle async events. Your best bet here is to keep Cypress focused when working on a test.

Rules

Requirements

  • .blur() requires being chained off a command that yields DOM element(s).

  • .blur() requires the element to currently have focus.

  • .blur() requires the element to be able to receive focus.

Assertions

  • .blur() will automatically wait for assertions you've chained to pass.

Timeouts

  • .blur() can time out waiting for assertions you've added to pass.

Command Log

Blur a textarea after typing.

cy.get('[name="comment"]').focus().type('Nice Product!').blur()

The commands above will display in the Command Log as:

command log for blur

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

console.log for blur

See also