Interface WebFlowInput

The URL to start navigation.

A regex pattern to stop web flow navigation.

Navigation will be stopped, and the interface will finish when the URL matches this regex.

A list of domains that are allowed to be accessed during the web flow.

If the user tries to navigate to a domain that is not in this list, the navigation will be stopped.

If this list is empty, no domain will be allowed.

Example:

 allowedDomains: ["domain1.com", "domain2.tech"]
 allowedDomains: ["*"] // allows all domains. Use with caution.
Copy

The maximum number of navigations allowed before stopping the web flow.

If the navigation count reaches this limit, the web flow will be stopped.

Default value: 10

A js script to be executed when the startUrl completes loading.

Shows a loading screen until the browser navigates away from the initial domain. This is useful to prevent the user from interacting with the app while the web flow is loading.

Use cases: Login with Google, Login with Facebook, etc. The loading screen will remain visible until the user is redirected to a different domain, typically triggered by onLoadJsScript.

Default value: false

Overrides the default User-Agent string sent by the web view.

Useful when the target website requires a specific browser identity or when the default desktop UA causes undesired behaviour (e.g., triggering bot-detection, forcing a desktop layout, or failing OAuth provider checks).

When omitted, the web view uses its built-in default User-Agent.

Example:

userAgent: "Mozilla/5.0 (Linux; Android 10; Mobile) AppleWebKit/537.36"
Copy

Cookies to inject into the WebView before the first navigation.

Each cookie requires a name and value. The domain and path are optional and default to the host derived from startUrl and "/" respectively. All cookies use a default expiration of 48 hours.

Example:

cookies: [
  { name: "session_id", value: "abc123" },
  { name: "auth_token", value: "xyz789", domain: ".example.com", path: "/api" }
]
Copy

When provided, the web flow interface will display a header with the specified style.