Skip to content

Commit e36fa90

Browse files
committed
Update whitelabel docs
1 parent 8c6f253 commit e36fa90

File tree

5 files changed

+263
-436
lines changed

5 files changed

+263
-436
lines changed

docs/features/whitelabel.mdx

Lines changed: 41 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,27 @@ description: "Whitelabeling Web3Auth | Documentation - Web3Auth"
66
image: "images/docs-meta-cards/documentation-card.png"
77
---
88

9+
import WhiteLabelShowcase from "@site/src/common/sdk/pnp/_whitelabel_showcase.mdx";
10+
911
Whitelabeling is a pivotal feature of Web3Auth that empowers developers to offer a seamless and
1012
cohesive user experience across their applications. Through customization of the user interface,
1113
branding, and translations, Web3Auth's whitelabeling capabilities ensure that every aspect of the
1214
authentication flow aligns with your application's identity.
1315

1416
#### Steps for Customization
1517

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.
18+
1. **Choose Your SDK:** Decide between Plug and Play, SFA & MPC Core Kit SDKs based on your needs
19+
for customization and control.
20+
21+
:::info
22+
23+
With Single Factor Auth & MPC Core Kit SDKs, Web3Auth is invisible to the user, and you have the
24+
complete control over the user interface, branding, and translations.
25+
26+
:::
27+
28+
2. **Define Your Branding:** While using Plug and Play SDKs, you can customize the elements of the
29+
SDKs, such as modals, screens, and logos, to align with your branding guidelines.
2030
3. **Apply Translations:** Tailor the language and translations within the authentication flow to
2131
cater to your target audience.
2232

@@ -34,6 +44,13 @@ level of customization to ensure the user interface, branding, and translations
3444
application's needs. These SDKs support detailed customization, offering a seamless and cohesive
3545
user experience.
3646

47+
:::info
48+
49+
Head over to the [Web3Auth PnP SDK Reference](/sdk/pnp/web/modal/whitelabel) to whitelabel your PnP
50+
integration.
51+
52+
:::
53+
3754
- **Seamless Integration:** Effortlessly embed Web3Auth's authentication modal within your
3855
application, ensuring a unified user experience that aligns with your brand identity. Customize
3956
every aspect, from the modal appearance to the user flow, including MFA screens, to maintain
@@ -48,20 +65,19 @@ user experience.
4865
aesthetics, reinforcing your brand with every user interaction. Web3Auth allows for detailed
4966
branding customization, ensuring the wallet experience feels like an integral part of your app.
5067

51-
### Customization Examples
52-
53-
- **Login Modal Customization:** Adapt the login modal's design to reflect your application's
54-
branding, from colors and logos to fonts and button styles.
55-
56-
![Web3Auth Plug and Play Login Modal](/images/whitelabel/modal/whitelable-login-modal.gif)
68+
## Language Customization and Localization (l10n)
5769

58-
- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout
59-
the user authentication process, including the transition between different authentication stages
60-
and support for both light and dark modes.
70+
A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages,
71+
enhancing accessibility and user engagement across diverse demographics.
6172

62-
![Web3Auth - User Flow Screens](/images/whitelabel/user-flow-screens.gif)
73+
- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages
74+
including English (en), Spanish (es), German (de), Chinese (zh), Japanese (ja), Korean (ko),
75+
French (fr), Portuguese (pt), and Dutch (nl).
76+
- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository,
77+
inviting contributions from the community to add or refine language support.
78+
[Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).
6379

64-
### NEW: Whitelabeling via the Dashboard:
80+
## NEW: Whitelabeling via the Dashboard:
6581

6682
- From version `8.5.0`, **Web3Auth's Plug and Play SDKs** and **WalletServicesPlugin** offer
6783
whitelabeling capabilities via the **Dashboard**, enabling developers to customize the
@@ -87,35 +103,22 @@ Access to Whitelabeling Dashboard is gated. The minimum
87103
plan, you would see a limited version of the dashboard, with disabled whitelabeling options for
88104
mainnet projects. For `sapphire_devnet` projects, you can access all the whitelabeling options,
89105
regardless of your pricing plan.
106+
90107
![Base Whitelabeling Dashboard](/images/whitelabel/base-whitelabeling-dashboard.png)
91108

92109
:::
93110

94-
## Core Kit SDKs Whitelabeling
95-
96-
- **Complete Control:** The Core Kit SDKs go a step further by providing total invisibility of
97-
Web3Auth's underlying mechanisms. Developers have the freedom to design their authentication pages
98-
and flows, offering unparalleled customization.
99-
- **No Redirection:** Distinguishing itself from the Plug and Play model, the Core Kit eliminates
100-
the need for user redirection to `auth.web3auth.io` for authentication, ensuring all processes are
101-
kept within your application's ecosystem.
111+
## Customization Examples
102112

103-
## Wallet Services Whitelabeling
113+
- **Login Modal Customization:** Adapt the login modal's design to reflect your application's
114+
branding, from colors and logos to fonts and button styles.
104115

105-
- **Comprehensive Customization:** For Wallet Services, whitelabeling extends to modifying the
106-
entire user interface, including logos, color schemes, and visibility of specific sections,
107-
ensuring a branded experience throughout.
108-
- **Application Identity:** Tailor the appearance of wallet service components, such as chain logos
109-
and the dApp logo, to reinforce your application's brand identity across all user interactions.
116+
![Web3Auth Plug and Play Login Modal](/images/whitelabel/modal/whitelable-login-modal.gif)
110117

111-
## Language Customization and Localization (l10n)
118+
- **User Flow and MFA Screen Transition:** Provide a consistent and engaging experience throughout
119+
the user authentication process, including the transition between different authentication stages
120+
and support for both light and dark modes.
112121

113-
A significant aspect of Web3Auth's whitelabeling capabilities is its support for multiple languages,
114-
enhancing accessibility and user engagement across diverse demographics.
122+
![Web3Auth - User Flow Screens](/images/whitelabel/user-flow-screens.gif)
115123

116-
- **Multiple Languages Support:** Web3Auth supports localization for a variety of languages
117-
including English (en), Spanish (es), German (de), Chinese (zh), Japanese (ja), Korean (ko),
118-
French (fr), Portuguese (pt), and Dutch (nl).
119-
- **Open Source Contributions:** The Web3Auth locales are maintained in an open-source repository,
120-
inviting contributions from the community to add or refine language support.
121-
[Contribute to Web3Auth Locales](https://github.com/Web3Auth/web3auth-locales).
124+
<WhiteLabelShowcase />

docs/features/whitelabelasdf/login-modal.mdx

Lines changed: 0 additions & 227 deletions
This file was deleted.

0 commit comments

Comments
 (0)