KwikForms class - kwikforms library

Constructors

KwikForms({Key? key, required List<KwikAddress> addresses, required bool consent, int? consentTimestamp, ValueChanged<KwikAddress>? onFormSubmit, ValueChanged? onSubmissionFailed, VoidCallback? onClose, KwikLoginConfig? loginConfig, KwikFormsStyle? style, List<String>? visibleAddressFields, KwikFormsConfig? kwikFormsConfig, KwikAddress? mapPickedAddress, bool isMapsConfigured = false, VoidCallback? onOpenMap}): const

Properties

addresses → List<KwikAddress>: final
consent → bool: final
consentTimestamp → int?: Timestamp (in milliseconds since epoch) when the user granted consent.
final
hashCode → int: The hash code for this object.
no setterinherited
isMapsConfigured → bool: True when the host app has a map picker configured. When true and onOpenMap is set, tapping "Add Address" calls onOpenMap instead of opening the built-in Add Address screen.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
kwikFormsConfig → KwikFormsConfig?: Mode config for the widget.
final
loginConfig → KwikLoginConfig?: Config for the login step. When provided, a login entry point is available.
final
mapPickedAddress → KwikAddress?: Address pre-filled from a map selection by the host app. When this changes to a non-null value, the widget navigates to the Add Address screen with fields pre-populated.
final
onClose → VoidCallback?: Called when the user taps back on the first screen (selectAddress).
final
onFormSubmit → ValueChanged<KwikAddress>?: Called when the user confirms an address for delivery. Receives the selected KwikAddress in the same format as addresses passed in.
final
onOpenMap → VoidCallback?: Called when the user taps "Add Address" and isMapsConfigured is true.
final
onSubmissionFailed → ValueChanged?: Called when the address submission API call fails. Receives the error for the host app to handle (e.g. show a toast).
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
style → KwikFormsStyle?: Style customisations for the address flow UI. Only visual/style properties — text content is not overridable here.
final
visibleAddressFields → List<String>?: Allowlist of field ids to render on the Add Address screen.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<KwikForms>: 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