焦点和文本字段

当文本字段被选中并接受输入时,据说它具有“焦点”。通常,用户通过点击将焦点转移到文本字段,而开发人员通过使用本食谱中描述的工具以编程方式将焦点转移到文本字段。

管理焦点是创建具有直观流程的表单的基本工具。例如,假设您有一个带有文本字段的搜索屏幕。当用户导航到搜索屏幕时,您可以将焦点设置为搜索词的文本字段。这允许用户在屏幕可见时立即开始输入,而无需手动点击文本字段。

在本食谱中,了解如何使文本字段在可见时立即获得焦点,以及如何在点击按钮时使文本字段获得焦点。

文本字段可见时立即获取焦点

#

要使文本字段在可见时立即获得焦点,请使用 autofocus 属性。

飞镖
TextField(
  autofocus: true,
);

有关处理输入和创建文本字段的更多信息,请参阅食谱的表单部分。

点击按钮时获取文本字段焦点

#

您可能不需要立即将焦点转移到特定的文本字段,而是在稍后的时间点将焦点赋予文本字段。在现实世界中,您可能还需要响应 API 调用或验证错误将焦点赋予特定的文本字段。在本例中,请使用以下步骤在用户按下按钮后将焦点赋予文本字段。

  1. 创建一个FocusNode
  2. FocusNode传递给TextField
  3. 当按钮被点击时,将焦点赋予TextField

1. 创建一个FocusNode

#

首先,创建一个FocusNode。使用FocusNode在 Flutter 的“焦点树”中识别特定的TextField。这允许您在接下来的步骤中将焦点赋予TextField

由于焦点节点是长生命周期的对象,因此使用State对象管理生命周期。使用以下说明在State类的initState()方法中创建一个FocusNode实例,并在dispose()方法中清理它。

飞镖
// Define a custom Form widget.
class MyCustomForm extends StatefulWidget {
  const MyCustomForm({super.key});

  @override
  State<MyCustomForm> createState() => _MyCustomFormState();
}

// Define a corresponding State class.
// This class holds data related to the form.
class _MyCustomFormState extends State<MyCustomForm> {
  // Define the focus node. To manage the lifecycle, create the FocusNode in
  // the initState method, and clean it up in the dispose method.
  late FocusNode myFocusNode;

  @override
  void initState() {
    super.initState();

    myFocusNode = FocusNode();
  }

  @override
  void dispose() {
    // Clean up the focus node when the Form is disposed.
    myFocusNode.dispose();

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    // Fill this out in the next step.
  }
}

2. 将FocusNode传递给TextField

#

现在您已经有了FocusNode,请在build()方法中将其传递给特定的TextField

飞镖
@override
Widget build(BuildContext context) {
  return TextField(
    focusNode: myFocusNode,
  );
}

3. 当按钮被点击时,将焦点赋予TextField

#

最后,当用户点击浮动操作按钮时,将焦点设置到文本字段。使用requestFocus()方法执行此任务。

飞镖
FloatingActionButton(
  // When the button is pressed,
  // give focus to the text field using myFocusNode.
  onPressed: () => myFocusNode.requestFocus(),
),

交互式示例

#
import 'package:flutter/material.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Text Field Focus',
      home: MyCustomForm(),
    );
  }
}

// Define a custom Form widget.
class MyCustomForm extends StatefulWidget {
  const MyCustomForm({super.key});

  @override
  State<MyCustomForm> createState() => _MyCustomFormState();
}

// Define a corresponding State class.
// This class holds data related to the form.
class _MyCustomFormState extends State<MyCustomForm> {
  // Define the focus node. To manage the lifecycle, create the FocusNode in
  // the initState method, and clean it up in the dispose method.
  late FocusNode myFocusNode;

  @override
  void initState() {
    super.initState();

    myFocusNode = FocusNode();
  }

  @override
  void dispose() {
    // Clean up the focus node when the Form is disposed.
    myFocusNode.dispose();

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Text Field Focus'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16),
        child: Column(
          children: [
            // The first text field is focused on as soon as the app starts.
            const TextField(
              autofocus: true,
            ),
            // The second text field is focused on when a user taps the
            // FloatingActionButton.
            TextField(
              focusNode: myFocusNode,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        // When the button is pressed,
        // give focus to the text field using myFocusNode.
        onPressed: () => myFocusNode.requestFocus(),
        tooltip: 'Focus Second Text Field',
        child: const Icon(Icons.edit),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}