mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-21 23:59:33 -05:00
Jennifer Mann
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
---
|
|
title: submit
|
|
comments: true
|
|
description: ''
|
|
---
|
|
|
|
Submits the DOM element from the previous command if it is a form. Submit can only be called on a single form.
|
|
|
|
**The following events are fired during submit:** `submit`
|
|
|
|
| | |
|
|
|--- | --- |
|
|
| **Returns** | the new DOM element(s) found by the command. |
|
|
| **Timeout** | `cy.submit` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). |
|
|
|
|
# [cy.submit()](#usage)
|
|
|
|
Submit a form.
|
|
|
|
# Options
|
|
|
|
Pass in an options object to change the default behavior of `cy.submit`.
|
|
|
|
**cy.submit( *options* )**
|
|
|
|
Option | Default | Notes
|
|
--- | --- | ---
|
|
`log` | `true` | whether to display command in command log
|
|
|
|
# Usage
|
|
|
|
## Submit a form
|
|
|
|
```html
|
|
<form id="contact">
|
|
<input type="text" name="message">
|
|
<button type="submit">Send</button>
|
|
</form>
|
|
```
|
|
|
|
```javascript
|
|
// submits the form and performs all default actions
|
|
// returns <form> for further chaining
|
|
cy.get("#contact").submit()
|
|
```
|
|
|
|
# Command Log
|
|
|
|
## Submit a form
|
|
|
|
```javascript
|
|
cy.route("POST", /users/, "fixture:user").as("userSuccess")
|
|
cy.get("form").submit()
|
|
```
|
|
|
|
The commands above will display in the command log as:
|
|
|
|
<img width="594" alt="screen shot 2015-11-29 at 1 21 43 pm" src="https://cloud.githubusercontent.com/assets/1271364/11459081/3149d9e6-969c-11e5-85b2-ba57638f02df.png">
|
|
|
|
When clicking on `submit` within the command log, the console outputs the following:
|
|
|
|
|
|
|
|
# Related
|
|
|
|
- [click](https://on.cypress.io/api/click)
|