OnScreenKeyPad class
A customizable on-screen numeric keypad for Flutter applications.
This widget is useful for PIN entry, authentication screens, and custom input fields with haptic feedback support.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- OnScreenKeyPad
Constructors
- OnScreenKeyPad({Key? key, bool enableHapticFeedback = false, HapticFeedbackType? hapticFeedbackType, EdgeInsets? keyPadding, BoxShape keyShape = BoxShape.rectangle, Color? keyCellSplashColor, Color? keyCellHighlightColor, Color? keyCellBackgroundColor, required void onKeyPress(String), Widget? leftButtonAction, Widget? rightButtonAction, TextStyle? style})
-
Constructs an OnScreenKeyPad widget.
const
Properties
- enableHapticFeedback → bool
-
Enables or disables haptic feedback for key presses.
final
- hapticFeedbackType → HapticFeedbackType?
-
Type of haptic feedback to trigger on key press.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- keyCellBackgroundColor → Color?
-
Background color of the keypad keys.
final
- keyCellHighlightColor → Color?
-
Highlight color effect when a key is tapped.
final
- keyCellSplashColor → Color?
-
Splash color effect when a key is tapped.
final
- keyPadding → EdgeInsets?
-
Padding for each key cell.
final
- keyShape → BoxShape
-
The shape of the keypad keys (rectangle or circle).
final
- leftButtonAction → Widget?
-
Custom widget for the left button (e.g., backspace).
final
- onKeyPress → void Function(String)
-
Callback function that gets triggered when a key is pressed.
final
- rightButtonAction → Widget?
-
Custom widget for the right button (e.g., submit).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- style → TextStyle?
-
Text style applied to keypad keys.
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, int wrapWidth = 65}) → 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