VirtualKeyboard class

Display a simulated on screen keyboard at the bottom of a child widget.

When isEnabled is updated, a transitionDuration starts to display or hide the virtual keyboard.

No interraction is available, its only purpose is to display the visual and update media query's viewInsets for child.

Inheritance

Constructors

VirtualKeyboard({Key? key, required Widget child, bool isEnabled = false, Duration transitionDuration = const Duration(milliseconds: 400)})
Display a simulated on screen keyboard on top of the given child widget.
const

Properties

child Widget
The widget on top of which the keyboard is displayed.
final
hashCode int
The hash code for this object.
no setterinherited
isEnabled bool
Indicates whether the keyboard is displayed or not.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
transitionDuration Duration
The transition duration when the keyboard is displayed or hidden.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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.
inherited
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

Static Methods

mediaQuery(MediaQueryData mediaQuery) MediaQueryData
Adds the keyboard insets to the given mediaQuery.