MongolTextField class

A material design text field for vertical Mongolian script.

A text field lets the user enter text, either with hardware keyboard or with an onscreen keyboard.

The text field calls the onChanged callback whenever the user changes the text in the field. If the user indicates that they are done typing in the field (e.g., by pressing a button on the soft keyboard), the text field calls the onSubmitted callback.

To control the text that is displayed in the text field, use the controller. For example, to set the initial value of the text field, use a controller that already contains some text. The controller can also control the selection and composing region (and to observe changes to the text, selection, and composing region).

By default, a text field has a decoration that draws a divider to the right of the text field. You can use the decoration property to control the decoration, for example by adding a label or an icon. If you set the decoration property to null, the decoration will be removed entirely, including the extra padding introduced by the decoration to save space for the labels.

If decoration is non-null (which is the default), the text field requires one of its ancestors to be a Material widget.

To integrate the MongolTextField into a Form with other FormField widgets, consider using MongolTextFormField.

Remember to call TextEditingController.dispose of the TextEditingController when it is no longer needed. This will ensure we discard any resources used by the object.

{@tool snippet} This example shows how to create a MongolTextField that will obscure input. The InputDecoration surrounds the field in a border using OutlineInputBorder and adds a label.

MongolTextField(
  obscureText: true,
  decoration: InputDecoration(
    border: OutlineInputBorder(),
    labelText: 'Password',
  ),
)

{@end-tool}

Reading values

A common way to read a value from a MongolTextField is to use the onSubmitted callback. This callback is applied to the text field's current value when the user finishes editing.

For most applications the onSubmitted callback will be sufficient for reacting to user input.

The onEditingComplete callback also runs when the user finishes editing. It's different from onSubmitted because it has a default value which updates the text controller and yields the keyboard focus. Applications that require different behavior can override the default onEditingComplete callback.

Keep in mind you can also always read the current string from a MongolTextField's TextEditingController using TextEditingController.text.

Handling emojis and other complex characters

In the live Dartpad example above, try typing the emoji 👨‍👩‍👦 into the field and submitting. Because the example code measures the length with value.characters.length, the emoji is correctly counted as a single character.

Constructors

MongolTextField({Key? key, TextEditingController? controller, FocusNode? focusNode, InputDecoration? decoration = const InputDecoration(), TextInputType? keyboardType, TextInputAction? textInputAction, TextStyle? style, MongolTextAlign textAlign = MongolTextAlign.top, TextAlignHorizontal? textAlignHorizontal, bool readOnly = false, ToolbarOptions? toolbarOptions, bool? showCursor, bool autofocus = false, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, bool enableSuggestions = true, int? maxLines = 1, int? minLines, bool expands = false, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, List<TextInputFormatter>? inputFormatters, bool? enabled, double cursorHeight = 2.0, double? cursorWidth, Radius? cursorRadius, Color? cursorColor, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool enableInteractiveSelection = true, TextSelectionControls? selectionControls, GestureTapCallback? onTap, MouseCursor? mouseCursor, InputCounterWidgetBuilder? buildCounter, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints, String? restorationId, ContentInsertionConfiguration? contentInsertionConfiguration}): Creates a Material Design text field for vertical Mongolian text.
const

Properties

autocorrect → bool: Whether to enable autocorrection.
final
autofillHints → Iterable<String>?: A list of strings that helps the autofill service identify the type of this text input.
final
autofocus → bool: Whether this text field should focus itself if nothing else is already focused.
final
buildCounter → InputCounterWidgetBuilder?: Callback that generates a custom InputDecoration.counter widget.
final
contentInsertionConfiguration → ContentInsertionConfiguration?: final
controller → TextEditingController?: Controls the text being edited.
final
cursorColor → Color?: The color of the cursor.
final
cursorHeight → double: How thick the cursor will be.
final
cursorRadius → Radius?: How rounded the corners of the cursor should be.
final
cursorWidth → double?: How wide the cursor will be.
final
decoration → InputDecoration?: The decoration to show around the text field.
final
dragStartBehavior → DragStartBehavior: Determines the way that drag start behavior is handled.
final
enabled → bool?: If false the text field is "disabled": it ignores taps and its decoration is rendered in grey.
final
enableInteractiveSelection → bool: Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions → bool: Whether to show input suggestions as the user types.
final
expands → bool: Whether this widget's width will be sized to fill its parent.
final
focusNode → FocusNode?: Defines the keyboard focus for this widget.
final
hashCode → int: The hash code for this object.
no setterinherited
inputFormatters → List<TextInputFormatter>?: Optional input validation and formatting overrides.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance → Brightness?: The appearance of the keyboard.
final
keyboardType → TextInputType: The type of keyboard to use for editing the text.
final
maxLength → int?: The maximum number of characters (Unicode scalar values) to allow in the text field.
final
maxLengthEnforcement → MaxLengthEnforcement?: Determines how the maxLength limit should be enforced.
final
maxLines → int?: The maximum number of lines for the text to span, wrapping if necessary.
final
minLines → int?: The minimum number of lines to occupy when the content spans fewer lines.
final
mouseCursor → MouseCursor?: The cursor for a mouse pointer when it enters or is hovering over the widget.
final
obscureText → bool: Whether to hide the text being edited (e.g., for passwords).
final
obscuringCharacter → String: Character used for obscuring text if obscureText is true.
final
onAppPrivateCommand → AppPrivateCommandCallback?: This is used to receive a private command from the input method.
final
onChanged → ValueChanged<String>?: Called when the user initiates a change to the MongolTextField's value: when they have inserted or deleted text.
final
onEditingComplete → VoidCallback?: Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onSubmitted → ValueChanged<String>?: Called when the user indicates that they are done editing the text in the field.
final
onTap → GestureTapCallback?: Called for each distinct tap except for every second tap of a double tap.
final
readOnly → bool: Whether the text can be changed.
final
restorationId → String?: Restoration ID to save and restore the state of the text field.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?: The ScrollController to use when horizontally scrolling the input.
final
scrollPadding → EdgeInsets: Configures padding to edges surrounding a Scrollable when the MongolTextField scrolls into view.
final
scrollPhysics → ScrollPhysics?: The ScrollPhysics to use when horizontally scrolling the input.
final
selectionControls → TextSelectionControls?: Optional delegate for building the text selection handles and toolbar.
final
selectionEnabled → bool: Same as enableInteractiveSelection.
no setter
showCursor → bool?: Whether to show cursor.
final
style → TextStyle?: The style to use for the text being edited.
final
textAlign → MongolTextAlign: How the text should be aligned vertically.
final
textAlignHorizontal → TextAlignHorizontal?: The horizontal alignment of vertical Mongolian text within an input box.
final
textInputAction → TextInputAction?: The type of action button to use for the keyboard.
final
toolbarOptions → ToolbarOptions: Configuration of toolbar options.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<MongolTextField>: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

noMaxLength → const int: If maxLength is set to this value, only the "current input length" part of the character counter is shown.