Checkbox

维护者:
zamkovskaya
GitHub
size
content
checked
disabled
indeterminate
import {Checkbox} from '@gravity-ui/uikit';

Checkbox 组件允许用户选择或取消选择特定值。

国家

A Checkbox 可以有不同的状态:

  • 已选中:复选框已勾选。
  • 已禁用:该复选框不可用。
  • 不确定:该复选框处于处于选中和未勾选之间的中间状态。
<Checkbox size="l" checked={false}>Unchecked</Checkbox>
<Checkbox size="l" checked>Checked</Checkbox>
<Checkbox size="l" disabled>Disabled</Checkbox>
<Checkbox size="l" indeterminate>Indeterminate</Checkbox>

大小

使用该 size 属性来管理大 Checkbox 小。默认大小为 m

<Checkbox size="m">M Size</Checkbox>
<Checkbox size="l">L Size</Checkbox>

标签

您可以使用该 content 属性为分配标签,也可以将其作为子属性提供。 Checkbox

<div>
  <Checkbox content="Content" size="l" />
  <div
      style={{
          marginTop: 10,
      }}
  >
      <Checkbox size="l">
          <span>Content as children</span>
      </Checkbox>
  </div>
</div>

属性

姓名描述类型默认
儿童复选框内容(通常是标签)。ReactNode
内容复选框内容(儿童替代方案)。ReactNode
残疾的切换复选框的 disabled 状态。booleanfalse
已检查切换复选框的 checked 状态。booleanfalse
defaultChecked设置组件挂载时的初始检查状态。booleanfalse
onUpdate当用户更改复选框状态并将选中的值作为回调参数提供时触发。(checked: boolean) => void
onChange当用户更改复选框状态并将更改事件作为回调参数时触发。Function
onFocus复选框输入元素获得焦点时使用的事件处理程序。Function
onBlur复选框输入元素失去焦点时使用的事件处理程序。Function
尺寸确定复选框的大小。m lm
idid HTML 属性string
qadata-qa HTML 属性,用于测试string
风格style HTML 属性React.CSSProperties
classNameclass HTML 属性string
标题title HTML 属性string
名称name 输入元素的 HTML 属性。string
价值value 输入元素的 HTML 属性。string
不确定切换复选框的 indeterminate 状态。booleanfalse
controlProps底层输入元素的其他属性。react.inputhtmlAtributes<HTMLInputElement>
controlRef引用底层输入元素。React.Ref<HTMLInputElement>