TextField

使用 TextField 组件获取客户的文本输入。

预览

TextField.jpg

示例代码

render('Checkout::Dynamic::Render', () => {
return <TextField label="Last name" />;
});

TextFieldProps

提示

标注 ? 的属性为可选,未标注 ? 的属性为必选。

label

string

字段标签,当字段为空时也用作占位符。


id?

string

用于标识当前组件的唯一标识符。如果未设置 ID,则会使用全局唯一值,全局唯一值为组件内部自行创建的 ID。


icon?

IconSource

在字段开头或结尾渲染的图标。


name?

string

当前组件的名称标识。


accessibilityDescription?

string

设置该组件的标签,将用于屏幕阅读器中帮助客户理解组件的功能。更多内容可见 Accessible description


value?

T

字段的当前值。如果省略,该字段将为空。


type?

text email number telephone 默认值:text

客户将输入到字段中的内容类型。


required?

boolean 默认值:false

字段是否需要值。true 为需要,false 为不需要。该字段旨在添加语义值,不会自动出现错误提示。如果要在该字段为空时显示错误,可以使用 error 属性。


error?

string

向客户展示的错误信息。若配置该传参,组件将会标红显示,并展示错误信息。


multiline?

number | boolean

字段是否支持多行输入。设置数字以定义输入的默认行数。


autocomplete?

boolean | Autocomplete

控制字段内容的提示是否显示。当设置为 true 时,表示该字段使用浏览器记录的内容进行自动填充。当设置为 false 时,表示永远不保存内容。注意在某些浏览器下自动填充功能无法保证默认关闭状态,因此不要过度依赖不传值时的默认表现。或者,你可以提供一个 Autocomplete 对象,配置你希望在此字段中输入的特定数据。


disabled?

boolean 默认值:false

字段是否可以修改。true 为不可修改,false 为可修改。


readonly?

boolean 默认值:false

字段是否只读。true 为只读,false 为可编辑。


maxLength?

number

指定允许的最大字符数。


onFocus?

() => void

获得焦点时的回调。


onBlur?

() => void

移除焦点时的回调。


onChange?

(value: T) => void

当客户完成编辑字段时的回调。


onInput?

(value: T) => void

当客户在字段中进行任何更改时的回调。


类型说明

Autocomplete

{group?: AutocompleteGroup, field: AutocompleteField}

AutocompleteGroup

shipping billing location

AutocompleteField

参考 autofill field


这篇文章对你有帮助吗?