Skip to content

字段标签

@astryxdesign/core v0.7.1 · FieldLabel

属性 ​

属性类型默认值说明
labelstring—标签文字。必填。
inputIdstring—这个标签对应的控件 id。会变成 for 属性,也是生成标签 id 和说明 id 的基础。必填。
labelIdstring`${inputId}-label`放在标签元素本身的 id。控件不是真正的 label 时,用控件的 aria-labelledby 指向它。
descriptionstring—标签下面那行说明。点它会聚焦控件,除非是分组标签或者已经禁用。
descriptionIdstring`${inputId}-description`放在说明上的 id。用控件的 aria-describedby 指向它。
isGroupLabelbooleanfalse把标签渲染成不带 for 的 span,用于一组控件而不是单个输入框。
isLabelHiddenbooleanfalse标签在视觉上隐藏,读屏仍然能读到。
isDisabledbooleanfalse标签变淡,同时点说明也不会再聚焦控件。
isOptionalbooleanfalse显示可选标记。和 isRequired 同时写时以它为准。
isRequiredbooleanfalse显示必填标记。放在 defaultOptionality="required" 的 FormLayout 里时不再显示,因为必填就是默认。
labelIconIconName | Component—标签文字前面的图标,放在 16px 的框里。外层是 aria-hidden,所以图标本身不该单独承载信息。
labelTooltipstring—标签行末尾那个提示按钮的文字。
optionalLabelstring'Optional'可选标记的文字。要本地化就改它。
requiredLabelstring'Required'必填标记的文字。要本地化就改它。

插槽 ​

  • labelIcon:标签文字前面的图标,位置和 labelIcon 属性一样,两个都写时用插槽。

暴露 ​

  • element:渲染出来的标签元素。