Material组件库中提供了输入框组件TextField和表单组件Form。下面我们分别介绍一下。
- 组件 - TextField
- 表单Form
1. 组件 - TextField
TextField用于文本输入
属性包括:
controller:编辑框的控制器,通过它可以设置/获取编辑框的内容、选择编辑内容、监听编辑文本改变事件。大多数情况下我们都需要显式提供一个controller来与文本框交互。如果没有提供controller,则TextField内部会自动创建一个。
focusNode:用于控制TextField是否占有当前键盘的输入焦点。它是我们和键盘交互的一个句柄 (handle)。
InputDecoration:用于控制TextField的外观显示,如提示文本、背景颜色、边框等。
- labelText: "用户名",
- hintText: "用户名或邮箱",
- prefixIcon: Icon(Icons.person)
- // 未获得焦点下划线设为灰色
enabledBorder: UnderlineInputBorder(
borderSide: BorderSide(color: Colors.grey),
),
- //获得焦点下划线设为蓝色
focusedBorder: UnderlineInputBorder(
borderSide: BorderSide(color: Colors.blue),
),
- keyboardType:用于设置该输入框默认的键盘输入类型,取值如下:
- text 文本输入键盘
- multiline 多行文本,需和maxLines配合使用(设为null或大于1)
- number 数字;会弹出数字键盘
- phone 优化后的电话号码输入键盘;会弹出数字键盘并显示“* #”
- datetime 优化后的日期输入键盘;Android上会显示“: -”
- emailAddress 优化后的电子邮件地址;会显示“@ .”
- url 优化后的url输入键盘; 会显示“/ .”
textInputAction:键盘动作按钮图标(即回车键位图标)
style:正在编辑的文本样式。
textAlign: 输入框内编辑文本在水平方向的对齐方式。
autofocus: 是否自动获取焦点。
obscureText:是否隐藏正在编辑的文本,如用于输入密码的场景等,文本内容会用“•”替换。
maxLines:输入框的最大行数,默认为1;如果为null,则无行数限制。
maxLength和maxLengthEnforced :maxLength代表输入框文本的最大长度,设置后输入框右下角会显示输入的文本计数。
maxLengthEnforced决定当输入文本长度超过maxLength时是否阻止输入,为true时会阻止输入,为false时不会阻止输入但输入框会变红。onChange:输入框内容改变时的回调函数;注:内容改变事件也可以通过controller来监听。
onEditingComplete和onSubmitted:这两个回调都是在输入框输入完成时触发,比如按了键盘的完成键(对号图标)或搜索键(🔍图标)。不同的是两个回调签名不同,onSubmitted回调是ValueChanged<String>类型,它接收当前输入内容做为参数,而onEditingComplete不接收参数。
inputFormatters:用于指定输入格式;当用户输入内容改变时,会根据指定的格式来校验。
enable:如果为false,则输入框会被禁用,禁用状态不接收输入和事件,同时显示禁用态样式(在其- decoration中定义)。
cursorWidth、cursorRadius和cursorColor:这三个属性是用于自定义输入框光标宽度、圆角和颜色的。
当获取一个文本框输入的值时,代码示例
// 定一个controller
TextEditingController _textController= TextEditingController();
TextField(
autofocus: true,
controller: _textController, //设置controller
...
)
// 获取输入框内容
_textController.text
2. 表单Form
Flutter提供了一个Form 组件,它可以对输入框进行分组,然后进行一些统一操作,如输入内容校验、输入框重置以及输入内容保存。
Form继承自StatefulWidget对象,它对应的状态类为FormState。我们先看看Form类的定义:
Form({
Key key,
@required this.child,
this.autovalidate = false,
this.onWillPop,
this.onChanged,
})
key: 通过key属性,来获取表单对象。
child: 是表单里的一些布局,结合TextFormField组件来实现表单的验证。
autovalidate:是否自动校验输入内容;当为true时,每一个子FormField内容发生变化时都会自动校验合法性,并直接显示错误信息。否则,需要通过调用FormState.validate()来手动校验。
onWillPop:决定Form所在的路由是否可以直接返回(如点击返回按钮),该回调返回一个Future对象,如果Future的最终结果是false,则当前路由不会返回;如果为true,则会返回到上一个路由。此属性通常用于拦截返回按钮。
onChanged:Form的任意一个子FormField内容发生变化时会触发此回调。
示例代码如下:
class FormTest extends StatefulWidget {
@override
_FormTestState createState() => new _FormTestState();
}
class _FormTestState extends State<FormTest> {
TextEditingController _unameController = new TextEditingController();
TextEditingController _pwdController = new TextEditingController();
GlobalKey _formKey= new GlobalKey<FormState>();
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title:Text("Form Test"),
),
body: Padding(
padding: const EdgeInsets.symmetric(vertical: 16.0, horizontal: 24.0),
child: Form(
key: _formKey, //设置globalKey,用于后面获取FormState
autovalidate: true, //开启自动校验
child: Column(
children: <Widget>[
TextFormField(
autofocus: true,
controller: _unameController,
decoration: InputDecoration(
labelText: "用户名",
hintText: "用户名或邮箱",
icon: Icon(Icons.person)
),
// 校验用户名
validator: (v) {
return v.trim().length > 0 ? null : "用户名不能为空";
}
),
TextFormField(
controller: _pwdController,
decoration: InputDecoration(
labelText: "密码",
hintText: "您的登录密码",
icon: Icon(Icons.lock)
),
obscureText: true,
//校验密码
validator: (v) {
return v.trim().length > 5 ? null : "密码不能少于6位";
}
),
// 登录按钮
Padding(
padding: const EdgeInsets.only(top: 28.0),
child: Row(
children: <Widget>[
Expanded(
child: RaisedButton(
padding: EdgeInsets.all(15.0),
child: Text("登录"),
color: Theme.of(context).primaryColor,
textColor: Colors.white,
onPressed: () {
// 通过_formKey.currentState 获取FormState后,
// 调用validate()方法校验用户名密码是否合法,校验
// 通过后再提交数据。
if((_formKey.currentState as FormState).validate()){
//验证通过提交数据
}
},
),
),
],
),
)
],
),
),
),
);
}
}
还可以通过Form.of(context)来验证表单提交,如果直接在 onPressed 方法中获取,是不可行的,因为获取到的上下文context为 FormTest的context,而FormState是在FormTest的子树中, 所以需要通过Builder来构建按钮,Builder会将widget节点的context作为回调参数,代码示例如下:
Expanded(
child:Builder(builder: (context){
return RaisedButton(
onPressed: () {
if(Form.of(context).validate()){
//验证通过提交数据
}
},
);
})
)