@@ -6,65 +6,98 @@ description: "Whitelabeling Web3Auth | Documentation - Web3Auth"
6
6
image : " images/docs-meta-cards/documentation-card.png"
7
7
---
8
8
9
- Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and cohesive user experience across their applications.
10
- Through customization of the user interface, branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
9
+ Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and
10
+ cohesive user experience across their applications. Through customization of the user interface,
11
+ branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
11
12
authentication flow aligns with your application's identity.
12
13
13
14
#### Steps for Customization
14
15
15
- 1 . ** Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for customization and control.
16
- 2 . ** Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos, to align with your branding guidelines.
17
- 3 . ** Apply Translations:** Tailor the language and translations within the authentication flow to cater to your target audience.
16
+ 1 . ** Choose Your SDK:** Decide between Plug and Play or Core Kit SDKs based on your needs for
17
+ customization and control.
18
+ 2 . ** Define Your Branding:** Customize the elements of the SDKs, such as modals, screens, and logos,
19
+ to align with your branding guidelines.
20
+ 3 . ** Apply Translations:** Tailor the language and translations within the authentication flow to
21
+ cater to your target audience.
18
22
19
23
## Plug and Play SDKs Whitelabeling
20
24
21
- Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep level of customization to ensure the user interface,
22
- branding, and translations perfectly match your application's needs. These SDKs support detailed customization, offering a seamless and cohesive user
23
- experience.
25
+ Web3Auth's Plug and Play SDKs provide extensive whitelabeling capabilities, allowing for a deep
26
+ level of customization to ensure the user interface, branding, and translations perfectly match your
27
+ application's needs. These SDKs support detailed customization, offering a seamless and cohesive
28
+ user experience.
24
29
25
- - ** Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your application, ensuring a unified user experience that aligns
26
- with your brand identity. Customize every aspect, from the modal appearance to the user flow, including MFA screens, to maintain consistency across
27
- all user interactions.
30
+ - ** Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your
31
+ application, ensuring a unified user experience that aligns with your brand identity. Customize
32
+ every aspect, from the modal appearance to the user flow, including MFA screens, to maintain
33
+ consistency across all user interactions.
28
34
29
- - ** Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over the authentication experience, ensuring it is not
30
- only branded but also intuitive for users. This approach minimizes the need for additional UI development and aligns closely with your application's
31
- design principles.
35
+ - ** Comprehensive Management:** With Web3Auth's whitelabeling options, you gain full control over
36
+ the authentication experience, ensuring it is not only branded but also intuitive for users. This
37
+ approach minimizes the need for additional UI development and aligns closely with your
38
+ application's design principles.
32
39
33
- - ** Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's aesthetics, reinforcing your brand with every user
34
- interaction. Web3Auth allows for detailed branding customization, ensuring the wallet experience feels like an integral part of your app.
40
+ - ** Customizable to Your Brand:** Tailor the Embedded Wallet UI to perfectly fit your application's
41
+ aesthetics, reinforcing your brand with every user interaction. Web3Auth allows for detailed
42
+ branding customization, ensuring the wallet experience feels like an integral part of your app.
35
43
36
44
### Customization Examples
37
45
38
- - ** Login Modal Customization:** Adapt the login modal's design to reflect your application's branding, from colors and logos to fonts and button
39
- styles.
46
+ - ** Login Modal Customization:** Adapt the login modal's design to reflect your application's
47
+ branding, from colors and logos to fonts and button styles.
40
48
41
49
![ Web3Auth Plug and Play Login Modal] ( /images/whitelabel/modal/whitelable-login-modal.gif )
42
50
43
- - ** User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout the user authentication process, including the
44
- transition between different authentication stages and support for both light and dark modes.
51
+ - ** User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout
52
+ the user authentication process, including the transition between different authentication stages
53
+ and support for both light and dark modes.
45
54
46
55
![ Web3Auth - User Flow Screens] ( /images/whitelabel/user-flow-screens.gif )
47
56
57
+ ### NEW: Whitelabeling via the Dashboard:
58
+
59
+ - From version ` 8.5.0 ` , ** Web3Auth's Plug and Play SDKs** and ** WalletServicesPlugin** offer
60
+ whitelabeling capabilities via the ** Dashboard** , enabling developers to customize the
61
+ authentication modal, user interface, and translations to align with their application's branding
62
+ and user experience requirements.
63
+
64
+ - ** Customize the Authentication Modal:** Modify the appearance of the authentication modal,
65
+ including the primary color, application name, logo, and dark or light mode, to align with your
66
+ application's branding.
67
+
68
+ - ** Personalize the User Interface:** Tailor the Embedded Wallet UI to match your application's
69
+ design language, ensuring a seamless and cohesive user experience.
70
+
71
+ - ** Configure Language and Translations:** Customize the language and translations within the
72
+ authentication flow to cater to your target audience.
73
+
74
+ ![ Web3Auth Whitelabeling Dashboard] ( /images/whitelabel/whitelabel-dashboard.gif )
75
+
48
76
## Core Kit SDKs Whitelabeling
49
77
50
- - ** Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of Web3Auth's underlying mechanisms. Developers have the
51
- freedom to design their authentication pages and flows, offering unparalleled customization.
52
- - ** No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates the need for user redirection to ` auth.web3auth.io `
53
- for authentication, ensuring all processes are kept within your application's ecosystem.
78
+ - ** Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of
79
+ Web3Auth's underlying mechanisms. Developers have the freedom to design their authentication pages
80
+ and flows, offering unparalleled customization.
81
+ - ** No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates
82
+ the need for user redirection to ` auth.web3auth.io ` for authentication, ensuring all processes are
83
+ kept within your application's ecosystem.
54
84
55
85
## Wallet Services Whitelabeling
56
86
57
- - ** Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the entire user interface, including logos, color schemes,
58
- and visibility of specific sections, ensuring a branded experience throughout.
59
- - ** Application Identity:** Tailor the appearance of wallet service components, such as chain logos and the dApp logo, to reinforce your application's
60
- brand identity across all user interactions.
87
+ - ** Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the
88
+ entire user interface, including logos, color schemes, and visibility of specific sections,
89
+ ensuring a branded experience throughout.
90
+ - ** Application Identity:** Tailor the appearance of wallet service components, such as chain logos
91
+ and the dApp logo, to reinforce your application's brand identity across all user interactions.
61
92
62
93
## Language Customization and Localization (l10n)
63
94
64
- A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages, enhancing accessibility and user engagement
65
- across diverse demographics.
95
+ A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages,
96
+ enhancing accessibility and user engagement across diverse demographics.
66
97
67
- - ** Multiple Languages Support:** Web3Auth supports localization for a variety of languages including English (en), Spanish (es), German (de), Chinese
68
- (zh), Japanese (ja), Korean (ko), French (fr), Portuguese (pt), and Dutch (nl).
69
- - ** Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository, inviting contributions from the community to add or
70
- refine language support. [ Contribute to Web3Auth Locales] ( https://github.com/Web3Auth/web3auth-locales ) .
98
+ - ** Multiple Languages Support:** Web3Auth supports localization for a variety of languages
99
+ including English (en), Spanish (es), German (de), Chinese (zh), Japanese (ja), Korean (ko),
100
+ French (fr), Portuguese (pt), and Dutch (nl).
101
+ - ** Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository,
102
+ inviting contributions from the community to add or refine language support.
103
+ [ Contribute to Web3Auth Locales] ( https://github.com/Web3Auth/web3auth-locales ) .
0 commit comments