Skip to content

Commit 4ff1856

Browse files
authored
Merge pull request #650 from Web3Auth/enhancements/sdk-references
Update PnP SDK References
2 parents d57dbea + 94a4111 commit 4ff1856

48 files changed

Lines changed: 930 additions & 1318 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/pnp/features/whitelabel/user-flow-screens.mdx

Lines changed: 2 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,7 @@ description: "User Flow Screens | Documentation - Web3Auth"
77

88
import OpenloginWhiteLabelConfig from "@site/src/common/sdk/pnp/web/_openlogin-whitelabel-config.mdx";
99
import OpenloginWhiteLabelExample from "@site/src/common/sdk/pnp/web/_openlogin-whitelabel-example.mdx";
10-
import Image4 from "@site/static/guides/whitelabel-web3auth-openlogin-dark.png";
11-
import Image7 from "@site/static/guides/whitelabel-web3auth-openlogin-language.png";
12-
import Image3 from "@site/static/guides/whitelabel-web3auth-openlogin-light.png";
13-
import Image9 from "@site/static/guides/whitelabel-web3auth-openlogin-logo-dark.png";
14-
import Image8 from "@site/static/guides/whitelabel-web3auth-openlogin-logo-light.png";
15-
import DashboardImage from "@site/static/guides/whitelabel-web3auth-openlogin-theme1.png";
16-
import Image6 from "@site/static/guides/whitelabel-web3auth-openlogin-theme2.png";
10+
import WhiteLabelShowcase from "@site/src/common/sdk/pnp/_whitelabel_showcase.mdx";
1711

1812
Web3Auth's User Flow Screens can be customized to match a dApp's branding using the `OpenLoginAdapter` settings, providing more options for a
1913
personalized user experience.
@@ -27,135 +21,7 @@ whitelabel the Web3Auth's User Flow Screens.
2721

2822
<OpenloginWhiteLabelConfig />
2923

30-
### `name`
31-
32-
The name of the application. This will be displayed in the key reconstruction page.
33-
34-
<div className="text-image-column">
35-
<div>
36-
<h4>
37-
Standard screen <strong>without</strong> any change
38-
</h4>
39-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={DashboardImage} alt="Standard screen without any change" />
40-
</div>
41-
<div>
42-
<h4>
43-
Name changed to <code>Formidable Duo</code>
44-
</h4>
45-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image6} alt="Name changed to Formidable Duo" />
46-
</div>
47-
</div>
48-
<br />
49-
50-
### `logoLight` & `logoDark`
51-
52-
The logo of the application. Displayed in dark and light mode respectively. This will be displayed in the key reconstruction page.
53-
54-
<div className="text-image-column">
55-
<div>
56-
<h4>
57-
<code>logoLight</code> on dark mode
58-
</h4>
59-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image8} alt="logoLight on dark mode" />
60-
</div>
61-
<div>
62-
<h4>
63-
<code>logoDark</code> on light mode
64-
</h4>
65-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image9} alt="logoDark on light mode" />
66-
</div>
67-
</div>
68-
<br />
69-
70-
### `defaultLanguage`
71-
72-
Default language will set the language used on all OpenLogin screens. The supported languages are:
73-
74-
<div className="text-image-column">
75-
<div style={{ flexGrow: "1", minWidth: "200px" }}>
76-
<ul>
77-
<li>
78-
<code>en</code> - English (default)
79-
</li>
80-
<li>
81-
<code>de</code> - German
82-
</li>
83-
<li>
84-
<code>ja</code> - Japanese
85-
</li>
86-
<li>
87-
<code>ko</code> - Korean
88-
</li>
89-
<li>
90-
<code>zh</code> - Mandarin
91-
</li>
92-
<li>
93-
<code>es</code> - Spanish
94-
</li>
95-
<li>
96-
<code>fr</code> - French
97-
</li>
98-
<li>
99-
<code>pt</code> - Portuguese
100-
</li>
101-
<li>
102-
<code>nl</code> - Dutch
103-
</li>
104-
</ul>
105-
</div>
106-
<div>
107-
<img style={{ width: "100%", maxWidth: "500px" }} src={Image7} alt="default Language screen" />
108-
</div>
109-
</div>
110-
<br />
111-
112-
### `dark`
113-
114-
Can be set to `true` or `false` with default set to `false`.
115-
116-
<br />
117-
118-
<div className="text-image-column">
119-
<div>
120-
<h4>
121-
For Light: <code>dark: false</code>
122-
</h4>
123-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image3} alt="light theme" />
124-
</div>
125-
<div>
126-
<h4>
127-
For Dark: <code>dark: true</code>
128-
</h4>
129-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image4} alt="dark theme" />
130-
</div>
131-
</div>
132-
133-
<br />
134-
135-
### `theme`
136-
137-
Theme is a record of colors that can be configured. As of, now only `primary` color can be set and has effect on OpenLogin screens (default primary
138-
color is `#0364FF`). Theme affects icons and links. Examples below.
139-
140-
<div className="text-image-column">
141-
<div>
142-
<h4>
143-
Standard color <code>#0364FF</code>
144-
</h4>
145-
<img
146-
style={{ display: "block", maxHeight: "500px", alignSelf: "center" }}
147-
src={DashboardImage}
148-
alt="Theme is a record of colors that can be configured."
149-
/>
150-
</div>
151-
<div>
152-
<h4>
153-
Color changed to <code>#D72F7A</code>
154-
</h4>
155-
<img style={{ display: "block", maxHeight: "500px", alignSelf: "center" }} src={Image6} alt="Theme affects icons and links." />
156-
</div>
157-
</div>
158-
<br />
24+
<WhiteLabelShowcase />
15925

16026
## Example
16127

0 commit comments

Comments
 (0)