Shift-Enter mode for TextField

Author: FeodorFitsner

client/lib/controls/textfield.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:flutter/services.dart';
 import 'package:flutter_redux/flutter_redux.dart';
 
 import '../actions.dart';
@@ -32,6 +33,22 @@ class _TextFieldControlState extends State<TextFieldControl> {
   bool _revealPassword = false;
   late TextEditingController _controller;
 
+  late final _focusNode = FocusNode(
+    onKey: (FocusNode node, RawKeyEvent evt) {
+      if (!evt.isShiftPressed && evt.logicalKey.keyLabel == 'Enter') {
+        if (evt is RawKeyDownEvent) {
+          ws.pageEventFromWeb(
+              eventTarget: widget.control.id,
+              eventName: "submit",
+              eventData: "");
+        }
+        return KeyEventResult.handled;
+      } else {
+        return KeyEventResult.ignored;
+      }
+    },
+  );
+
   @override
   void initState() {
     super.initState();
@@ -70,8 +87,10 @@ class _TextFieldControlState extends State<TextFieldControl> {
 
           bool readOnly = widget.control.attrBool("readOnly", false)!;
           bool password = widget.control.attrBool("password", false)!;
+          bool shiftEnter = widget.control.attrBool("shiftEnter", false)!;
           bool canRevealPassword =
               widget.control.attrBool("canRevealPassword", false)!;
+          bool onChange = widget.control.attrBool("onChange", false)!;
 
           Widget? revealPasswordIcon;
           if (password && canRevealPassword) {
@@ -116,6 +135,9 @@ class _TextFieldControlState extends State<TextFieldControl> {
               readOnly: readOnly,
               obscureText: password && !_revealPassword,
               controller: _controller,
+              focusNode: keyboardType == TextInputType.multiline && shiftEnter
+                  ? _focusNode
+                  : null,
               onChanged: (String value) {
                 debugPrint(value);
                 setState(() {
@@ -127,6 +149,12 @@ class _TextFieldControlState extends State<TextFieldControl> {
                 dispatch(UpdateControlPropsAction(
                     UpdateControlPropsPayload(props: props)));
                 ws.updateControlProps(props: props);
+                if (onChange) {
+                  ws.pageEventFromWeb(
+                      eventTarget: widget.control.id,
+                      eventName: "change",
+                      eventData: value);
+                }
               });
 
           return constrainedControl(textField, widget.parent, widget.control);

docs/roadmap.md

@@ -63,6 +63,7 @@
     * Complex embeddable values for `padding`, `marging`, etc, e.g. `.padding = { 'left': 10, 'right': 20 }`
     * Visual Density ([more](https://api.flutter.dev/flutter/material/VisualDensity-class.html))
     * Early detection of layout issues (like enabling scrolling in unbounded controls) with [Layout Builder](https://api.flutter.dev/flutter/widgets/LayoutBuilder-class.html).
+    * Scroll speed on Windows Desktop [The issue](https://github.com/flutter/flutter/issues/67985)
 
 * Flet Client
   * Web

sdk/python/flet/textfield.py

@@ -66,8 +66,10 @@ def __init__(
         password: bool = None,
         can_reveal_password: bool = None,
         read_only: bool = None,
+        shift_enter: bool = None,
         text_align: TextAlign = None,
         on_change=None,
+        on_submit=None,
     ):
         FormFieldControl.__init__(
             self,
@@ -104,9 +106,11 @@ def __init__(
         self.min_lines = min_lines
         self.max_lines = max_lines
         self.read_only = read_only
+        self.shift_enter = shift_enter
         self.password = password
         self.can_reveal_password = can_reveal_password
         self.on_change = on_change
+        self.on_submit = on_submit
 
     def _get_control_name(self):
         return "textfield"
@@ -170,6 +174,16 @@ def read_only(self):
     def read_only(self, value: Optional[bool]):
         self._set_attr("readOnly", value)
 
+    # shift_enter
+    @property
+    def shift_enter(self):
+        return self._get_attr("shiftEnter", data_type="bool", def_value=False)
+
+    @shift_enter.setter
+    @beartype
+    def shift_enter(self, value: Optional[bool]):
+        self._set_attr("shiftEnter", value)
+
     # password
     @property
     def password(self):
@@ -202,3 +216,12 @@ def on_change(self, handler):
             self._set_attr("onchange", True)
         else:
             self._set_attr("onchange", None)
+
+    # on_submit
+    @property
+    def on_submit(self):
+        return self._get_event_handler("submit")
+
+    @on_submit.setter
+    def on_submit(self, handler):
+        self._add_event_handler("submit", handler)

sdk/python/playground/textfield-test.py

@@ -39,7 +39,17 @@ def main(page: Page):
     page.theme_mode = "light"
     page.padding = padding.all(20)
 
-    results = Column(scroll="always", height=100)
+    def chat_submit(e):
+        print(f"Submit FieldText: {e.control.value}")
+        e.control.value = ""
+        page.update()
+
+    chat_input = TextField(
+        hint_text="Say something...",
+        min_lines=1,
+        shift_enter=True,
+        on_submit=chat_submit,
+    )
 
     page.add(
         Column(
@@ -66,6 +76,11 @@ def main(page: Page):
                     filled=True,
                     min_lines=1,
                 ),
+                Text(
+                    "New line - Shift + Enter and submit on Enter",
+                    style="headlineSmall",
+                ),
+                chat_input,
                 Text(
                     "Login with email/password",
                     style="headlineSmall",