CheckoutWebView class
A widget that opens a WebView
for a payment checkout flow.
It loads the given checkoutUrl and monitors navigation events. When the page navigates to returnDeepLink, the onReturn callback is invoked with the full Uri. The widget then automatically pops itself from the navigation stack.
This is commonly used for handling PhonePe (or other PSP) checkout flows where the provider redirects back to your app via a deep link.
Example:
await Navigator.of(context).push(
MaterialPageRoute(
builder: (_) => CheckoutWebView(
checkoutUrl: 'https://example.com/pay',
returnDeepLink: 'myapp://payment-return',
onReturn: (uri) {
final status = uri.queryParameters['status'];
debugPrint('Returned with status: $status');
},
),
),
);
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CheckoutWebView
Constructors
-
CheckoutWebView.new({Key? key, required String checkoutUrl, required String returnDeepLink, required ValueChanged<
Uri> onReturn, String? appBarTitle}) -
Creates a new CheckoutWebView.
const
Properties
- appBarTitle → String?
-
Optional title shown in the CustomAppBar. Defaults to
'PhonePe Checkout'
.final - checkoutUrl → String
-
The initial URL to load in the WebView for checkout.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onReturn
→ ValueChanged<
Uri> -
Called when returnDeepLink is reached. Receives the full return Uri.
final
- returnDeepLink → String
-
The deep link (custom scheme or https) that signals checkout completion.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CheckoutWebView> -
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