This adds multiline text widget support. #12120

gspencergoog · 2017-09-15T22:14:36Z

This adds support for multi-line text widgets, making a new TextInputAction.newline enum, and supporting a new TextInputType.multiline enum value.

There are still some issues with cursor placement in multi-line input, but those may go away when we switch to a non-Blink text renderer.

Fixes #8028

Hixie · 2017-09-20T21:33:34Z

packages/flutter/lib/src/services/text_input.dart

@@ -56,6 +63,9 @@ enum TextInputType {
 enum TextInputAction {
  /// Complete the text input operation.
  done,
+  /// The action to take when the enter button is pressed in a multi-line


nit: missing newline

Hixie · 2017-09-20T21:34:40Z

packages/flutter/lib/src/services/text_input.dart

@@ -93,13 +106,17 @@ class TextInputConfiguration {
  /// What text to display in the text input control's action button.
  final String actionLabel;

+  /// What kind of action to request for the action button on the IME.
+  final TextInputAction inputAction;
+
  /// Returns a representation of this object as a JSON object.
  Map<String, dynamic> toJSON() {


this isn't a JSON object, it's a Map...

(no need to fix this unless you want to go on a rampage and fix all of them)

I think I'll leave that for another rampage. But I agree with you.

Hixie · 2017-09-20T21:35:09Z

packages/flutter/lib/src/services/text_input.dart

@@ -276,6 +293,8 @@ class TextInputConnection {

 TextInputAction _toTextInputAction(String action) {
  switch (action) {
+    case 'TextInputAction.newline':
+      return TextInputAction.newline;
    case 'TextInputAction.done':
      return TextInputAction.done;


you should keep the switch and the enum definition in the same order unless the order matters

Hixie · 2017-09-20T21:36:06Z

packages/flutter/lib/src/widgets/editable_text.dart

-  /// the number of lines. By default, it is 1, meaning this is a single-line
-  /// text field. If it is not null, it must be greater than zero.
+  /// the number of lines. By default, it is one, meaning this is a single-line
+  /// text field. [maxLines] must not be set to zero.


According to your change here, it's now allowed to be negative, which I doubt is what you intended.

Yikes. Yes, you're correct. Fixed.

Hixie · 2017-09-20T21:36:17Z

packages/flutter/lib/src/widgets/editable_text.dart

-  /// The [controller], [focusNode], [style], [cursorColor], and [textAlign]
-  /// arguments must not be null.
+  /// If [maxLines] is not one, then [keyboardType] will be ignored, and the
+  /// keyboard type [TextInputType.multiline] will be used.


I think it'd be cleaner if the default for keyboardType depended on maxLines, but if it was set, it was honoured regardless.

+1. I can't imagine much use for a multi-line phone number, but it does seem fair that if someone adds a multi-line text field and request a phone keyboard, that we give them one.

OK, I'll honor the setting then. Each of our existing keyboard types is for single-line input, so it didn't seem to make sense for multiline fields to use a single-line keyboard, but I guess they should get what they ask for.

Note that if I do it this way, then it won't assert if they pass an explicit null for keyboardType, it'll just use the default value (since I have to use null to tell if we are in a default state or not).

Hixie · 2017-09-20T21:37:34Z

packages/flutter/lib/src/widgets/editable_text.dart

@@ -194,7 +199,7 @@ class EditableText extends StatefulWidget {
  /// Defaults to false.
  final bool obscureText;

-  /// Whether to enable autocorrection.
+  /// Whether to enable auto-correction.


Wikipedia says "autocorrection" is correct.

Hixie · 2017-09-20T21:38:31Z

packages/flutter/lib/src/widgets/editable_text.dart

+              inputAction: widget.keyboardType == TextInputType.multiline
+                  ? TextInputAction.newline
+                  : TextInputAction.done
+          ))


the formatting is off somehow here. There's two closing parens on the same line, but I don't see any lines with two opening parens.

OK, I think I fixed it.

Hixie · 2017-09-20T21:38:52Z

packages/flutter_test/lib/src/test_text_input.dart

@@ -28,6 +28,9 @@ class TestTextInput {

  int _client = 0;

+  /// Arguments supplied to setCient.


Hixie · 2017-09-20T21:40:01Z

modulo comments

cbracken · 2017-09-20T23:31:51Z

packages/flutter/lib/src/services/text_input.dart

+  /// Requests the default platform keyboard, but accepts newlines when the
+  /// enter key is pressed. This is the input type used for all multi-line text
+  /// fields.
+  multiline,


Would multilineText be better, or just more pedantic?

I think it would be redundant. I like multiline because we're already talking about "TextInputType", so it's already clear that it's text.

cbracken · 2017-09-20T23:32:39Z

packages/flutter/lib/src/services/text_input.dart

@@ -56,6 +63,9 @@ enum TextInputType {
 enum TextInputAction {
  /// Complete the text input operation.
  done,
+  /// The action to take when the enter button is pressed in a multi-line


nit: s/button/key/ also covers physical keyboards.

Funny, I chose 'button' because I felt it covered both, whereas 'key' just covered physical keyboards. Mind if I keep it as 'button'?

cbracken · 2017-09-20T23:41:56Z