Skip to content

Commit f09c412

Browse files
shahbaz17shahbaz17
authored
Merge branch 'master' into patch-1
2 parents 3d18b36 + bf0ce9a commit f09c412

6 files changed

Lines changed: 19 additions & 16 deletions

File tree

‎docs/sdk/core-kit/mpc-core-kit/mpc-core-kit.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Image1 from "@site/static/images/tkey-mpc-flow.png";
99
Web3Auth's [`@web3auth/mpc-core-kit`](https://github.com/Web3Auth/mpc-core-kit) SDK is simple and easy-to-use SDK, which helps you implement the
1010
Web3Auth MPC Features while giving you the flexibility to customize the UI and UX of the authentication process.
1111

12-
## This Documentation is based on the [`2.3.0`](https://github.com/Web3Auth/mpc-core-kit/releases) SDK Version.
12+
## This Documentation is based on the [`2.3.0-0 Pre Release`](https://github.com/Web3Auth/mpc-core-kit/releases) SDK Version.
1313

1414
## Requirements
1515

‎docs/sdk/core-kit/mpc-core-kit/usage.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ indexes. Using this function you can add multi-address account support to your a
6565

6666
As an application, you need to persist this account index in the application state.
6767

68+
This feature is still in [pre-release](https://github.com/Web3Auth/mpc-core-kit/releases/tag/v2.3.0-0), so there can be some **breaking changes in
69+
upcoming versions.**
70+
6871
:::
6972

7073
#### Usage

‎docs/sdk/pnp/web/adapters/openlogin.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ const openloginAdapter = new OpenloginAdapter({
307307
whiteLabel: {
308308
logoLight: "https://web3auth.io/images/w3a-L-Favicon-1.svg",
309309
logoDark: "https://web3auth.io/images/w3a-D-Favicon-1.svg",
310-
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl
310+
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl, tr
311311
mode: "dark", // whether to enable dark, light or auto mode. defaultValue: auto [ system theme]
312312
},
313313
// SCALE and above plan only feature
@@ -383,7 +383,7 @@ const openloginAdapter = new OpenloginAdapter({
383383
appUrl: "https://web3auth.io",
384384
logoLight: "https://web3auth.io/images/w3a-L-Favicon-1.svg",
385385
logoDark: "https://web3auth.io/images/w3a-D-Favicon-1.svg",
386-
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl
386+
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl, tr
387387
mode: "auto", // whether to enable dark mode. defaultValue: false
388388
theme: {
389389
primary: "#768729",

‎src/common/sdk/pnp/web/_openlogin-whitelabel-config.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ The whitelabel parameter takes `WhitelabelData` as input. The `WhitelabelData` o
1717

1818
`WhiteLabelData`
1919

20-
| Parameter | Type | Description | Default | Mandatory |
21-
| ------------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | --------- |
22-
| `appName?` | `string` | App name to be displayed in the User Flow Screens. | dApp's Website URL | No |
23-
| `appUrl?` | `string` | App URL to be displayed in the User Flow Screens. | dApp's Website URL | No |
24-
| `logoLight?` | `string` | App logo to be shown on the light background (light theme) | [web3auth-logo.svg](https://images.web3auth.io/web3auth-logo.svg) | No |
25-
| `logoDark?` | `string` | App logo to be shown on the dark background (dark theme) | [web3auth-logo.svg](https://images.web3auth.io/web3auth-logo.svg) | No |
26-
| `defaultLanguage?` | `string` | Default Language to use. <br/> Choose from: <ul><li>`en` - English</li><li>`de` - German</li><li>`ja` - Japanese</li><li>`ko` - Korean</li><li>`zh` - Mandarin</li><li>`es` - Spanish</li><li>`fr` - French</li><li>`pt` - Portuguese</li><li>`nl` - Dutch</li></ul> | en - English | No |
27-
| `mode?` | `string` | Choose between `auto`, `light` or `dark` background modes. | `auto` | No |
28-
| `theme?` | `{ [P in string]: string; }` | Used to customize the theme of the login modal with the following options <br /> `'primary'` - To customize the primary color of the modal's content | `#0364FF` | No |
29-
| `tncLink?` | `Partial<Record<LANGUAGE_TYPE, string>>` | Language specific link for terms and conditions on torus-website. See (examples/vue-app) to configure e.g. tncLink: `{en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja"}` | none | No |
30-
| `privacyPolicy?` | `Partial<Record<LANGUAGE_TYPE, string>>` | Language specific link for privacy policy on torus-website. See (examples/vue-app) to configure e.g. `privacyPolicy: { en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja", }` | none | No |
20+
| Parameter | Type | Description | Default | Mandatory |
21+
| ------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | --------- |
22+
| `appName?` | `string` | App name to be displayed in the User Flow Screens. | dApp's Website URL | No |
23+
| `appUrl?` | `string` | App URL to be displayed in the User Flow Screens. | dApp's Website URL | No |
24+
| `logoLight?` | `string` | App logo to be shown on the light background (light theme) | [web3auth-logo.svg](https://images.web3auth.io/web3auth-logo.svg) | No |
25+
| `logoDark?` | `string` | App logo to be shown on the dark background (dark theme) | [web3auth-logo.svg](https://images.web3auth.io/web3auth-logo.svg) | No |
26+
| `defaultLanguage?` | `string` | Default Language to use. <br/> Choose from: <ul><li>`en` - English</li><li>`de` - German</li><li>`ja` - Japanese</li><li>`ko` - Korean</li><li>`zh` - Mandarin</li><li>`es` - Spanish</li><li>`fr` - French</li><li>`pt` - Portuguese</li><li>`nl` - Dutch</li><li>`tr` - Turkish</li></ul> | en - English | No |
27+
| `mode?` | `string` | Choose between `auto`, `light` or `dark` background modes. | `auto` | No |
28+
| `theme?` | `{ [P in string]: string; }` | Used to customize the theme of the login modal with the following options <br /> `'primary'` - To customize the primary color of the modal's content | `#0364FF` | No |
29+
| `tncLink?` | `Partial<Record<LANGUAGE_TYPE, string>>` | Language specific link for terms and conditions on torus-website. See (examples/vue-app) to configure e.g. tncLink: `{en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja"}` | none | No |
30+
| `privacyPolicy?` | `Partial<Record<LANGUAGE_TYPE, string>>` | Language specific link for privacy policy on torus-website. See (examples/vue-app) to configure e.g. `privacyPolicy: { en: "http://example.com/tnc/en", ja: "http://example.com/tnc/ja", }` | none | No |
3131

3232
</TabItem>
3333

‎src/common/sdk/pnp/web/_openlogin-whitelabel-example.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const openloginAdapter = new OpenloginAdapter({
1212
appUrl: "https://web3auth.io",
1313
logoLight: "https://web3auth.io/images/web3auth-logo.svg",
1414
logoDark: "https://web3auth.io/images/web3auth-logo---Dark.svg",
15-
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl
15+
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl, tr
1616
mode: "dark", // whether to enable dark mode. defaultValue: auto
1717
theme: {
1818
primary: "#00D1B2",

‎src/common/sdk/pnp/web/_ui-config-whitelabel-example.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const web3auth = new Web3Auth({
1313
loginMethodsOrder: ["apple", "google", "twitter"],
1414
logoLight: "https://web3auth.io/images/web3auth-logo.svg",
1515
logoDark: "https://web3auth.io/images/web3auth-logo---Dark.svg",
16-
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl
16+
defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl, tr
1717
loginGridCol: 3,
1818
primaryButton: "socialLogin", // "externalLogin" | "socialLogin" | "emailLogin"
1919
},

0 commit comments

Comments
 (0)