Interface WebFlowInput

Hierarchy

  • WebFlowInput

Properties

startUrl: string

The URL to start navigation.

stopPattern: string

A regex pattern to stop web flow navigation.

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

allowedDomains: string[]

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.
maxNavigationLimit?: number

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

onLoadJsScript?: string

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

keepLoadingScreenUntilDomainChange?: boolean

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

Generated using TypeDoc