Cypress应用

uncheck

取消勾选复选框。

在 .uncheck() 之后继续链式调用依赖该主题的命令是不安全的。

语法

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

用法

正确用法

cy.get('[type="checkbox"]').uncheck() // 取消勾选复选框元素

错误用法

cy.uncheck('[type="checkbox"]') // 错误，不能链式调用 'cy'
cy.get('p:first').uncheck() // 错误，'.get()' 不返回复选框

参数

value (String)

应取消勾选的复选框的值。

values (Array)

应取消勾选的复选框的值数组。

options (Object)

传入一个选项对象以更改 .uncheck() 的默认行为。

选项	默认值	描述
animationDistanceThreshold	animationDistanceThreshold	元素随时间必须超过的像素距离，以被视为正在动画。
force	false	强制执行操作，禁用等待可操作性
log	true	在命令日志中显示命令
scrollBehavior	scrollBehavior	执行命令前元素应滚动到的视口位置
timeout	defaultCommandTimeout	等待 .uncheck() 解析的超时时间，超过则超时
waitForAnimations	waitForAnimations	执行命令前是否等待元素完成动画。

生成结果

• .uncheck() 返回与给定主题相同的主题。
• 在 .uncheck() 之后继续链式调用依赖该主题的命令是不安全的。

示例

无参数

取消勾选所有复选框

cy.get(':checkbox').uncheck()

取消勾选 ID 为 'saveUserName' 的元素

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

值

取消勾选值为 'ga' 的复选框

cy.get('input[type="checkbox"]').uncheck(['ga'])

值数组

取消勾选值为 'ga' 和 'ca' 的复选框

cy.get('[type="checkbox"]').uncheck(['ga', 'ca'])

注意事项

可操作性

元素必须首先达到可操作状态

.uncheck() 是一个“操作命令”，遵循可操作性的所有规则。

规则

要求

• .uncheck() 需要链式调用返回 DOM 元素的命令。
• .uncheck() 要求元素的类型为 checkbox。

断言

• .uncheck() 会自动等待元素达到可操作状态。
• .uncheck() 会自动重试，直到所有链式断言通过。

超时设置

• .uncheck() 可能会因等待元素达到可操作状态而超时。
• .uncheck() 可能会因等待添加的断言通过而超时。

命令日志

取消勾选第一个复选框

cy.get('[data-js="choose-all"]')
  .click()
  .find('input[type="checkbox"]')
  .first()
  .uncheck()

上述命令将在命令日志中显示为：

当点击命令日志中的 uncheck 时，控制台会输出以下内容：

历史版本

版本	变更
6.1.0	添加选项 scrollBehavior
0.6.12	添加选项 force
0.3.3	添加 .uncheck() 命令

另请参阅

• .check()
• .click()