Authenticate Your UsersOnboarding Modal
Authenticate User via Onboarding Modal
Learn how to trigger and handle authentication using the Okto Onboarding Modal.
Method Overview
| Method | Description |
|---|---|
asyncshowOnboardingWidget() | Opens the Okto Onboarding flow with your chosen primaryAuth (e.g., Email, Phone, or Google) and brand data |
Show Onboarding Widget
showOnboardingWidget()
presents a guided onboarding flow to the user. This includes brand data, theming, and whichever primaryAuth type you’ve set in the <OktoProvider> or pass in at runtime.
Parameters
None directly. The Okto Provider already know how to handle brandData, primaryAuth, and theming.
Response
Success Response
| Field Name | Type | Description |
|---|---|---|
result | void | No direct response returned on success |
Note on Brand Customization
You can customize the branding and theming of the onboarding widget by modifying the brandData object in your <OktoProvider> setup or passing a partial theme. This allows you to define the title, subtitle, icon, and colors that represent your application.