DocumentCaptureWidget class
Widget for capturing document images from camera or gallery
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DocumentCaptureWidget
Constructors
- DocumentCaptureWidget({Key? key, OnImageCaptured? onImageCaptured, OnError? onError, bool showCamera = true, bool showGallery = true, String? cameraButtonText, String? galleryButtonText, ButtonStyle? buttonStyle, String? title, String? instructions, bool showCompanyBranding = false, bool showTips = true, KycTheme? theme})
-
const
Properties
-
Custom styling
final
- cameraButtonText → String?
-
Custom button text for camera
final
- effectiveShowGallery → bool
-
Get effective showGallery value based on config
enableManualCapture = true means gallery is enabled
enableManualCapture = false means only camera (gallery disabled)
no setter
- galleryButtonText → String?
-
Custom button text for gallery
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- instructions → String?
-
Subtitle/instructions text to display
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onError → OnError?
-
Callback when an error occurs
final
- onImageCaptured → OnImageCaptured?
-
Callback when image is successfully captured
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showCamera → bool
-
Show camera option
final
- showCompanyBranding → bool
-
Show company branding (logo and name) from config. Defaults to false.
final
- showGallery → bool
-
Show gallery option
final
- showTips → bool
-
Show helpful tips card. Defaults to true.
final
- theme → KycTheme?
-
Theme color for the widget. If not provided, uses default green theme.
final
- title → String?
-
Title text to display above buttons
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< DocumentCaptureWidget> -
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.
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