Skip to content

Commit 8281524

Browse files
AyushBherwani1998AyushBherwani1998
committed
improve pnp docs
1 parent dd27664 commit 8281524

26 files changed

Lines changed: 341 additions & 336 deletions

‎docs/sdk/pnp/react-native/usage.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Trigger the login flow that navigates the user to a browser model that allows th
4343
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
4444
| `loginProvider` | It sets the OAuth login method to be used. You can use any of the supported values are `GOOGLE`, `FACEBOOK`, `REDDIT`, `DISCORD`, `TWITCH`, `APPLE`, `LINE`, `GITHUB`, `KAKAO`, `LINKEDIN`, `TWITTER`, `WEIBO`, `WECHAT`, `EMAIL_PASSWORDLESS`. |
4545
| `extraLoginOptions?` | It can be used to set the OAuth login options for corresponding `loginProvider`. For instance, you'll need to pass user's email address as. Default value for the field is `null`, and it accepts `ExtraLoginOptions` as a value. |
46-
| `redirectUrl?` | Url where user will be redirected after successfull login. By default user will be redirected to same page where login will be initiated. Default value for the field is `null`, and accepts `Uri` as a value. |
46+
| `redirectUrl?` | Url where user will be redirected after successfull login. By default user will be redirected to same page where login will be initiated. Default value for the field is `null`, and accepts `string` as a value. |
4747
| `appState?` | It can be used to keep track of the app state when user will be redirected to app after login. Default is `null`, and accepts `string` as a value. |
4848
| `mfaLevel?` | Customize the MFA screen shown to the user during OAuth authentication. Default value for field is `MfaLevelType.default`, which shows MFA screen every 3rd login. It accepts `MfaLevelType` as a value. |
4949
| `dappShare?` | Custom verifier logins can get a dapp share returned to them post successful login. This is useful if the dapps want to use this share to allow users to login seamlessly. It accepts `string` as a value. |

‎docs/sdk/pnp/unity/custom-authentication.mdx‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Then, you should specify the details of your verifier in the `LoginConfigItem` s
2727

2828
:::note
2929

30-
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the
31-
**Growth Plan**. You can use this feature in the development environment for free.
30+
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the **Growth
31+
Plan**. You can use this feature in the development environment for free.
3232

3333
:::
3434

@@ -46,21 +46,21 @@ This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricin
4646

4747
<TabItem value="table">
4848

49-
| Parameter | Type | Mandatory | Description |
50-
| --------------------- | ------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51-
| verifier | String | Yes | The name of the verifier which you have registered on the Web3Auth Dashboard. |
52-
| typeOfLogin | Enum`<TypeOfLogin>` | Yes | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose google, a google sign-in flow will be used. If you choose jwt, which you should be providing your own JWT token, no sign-in flow will be presented. |
53-
| name | String | No | Name of your verifier for display purpose. |
54-
| description | String? | No | Description of this login flow. |
55-
| clientId | String? | No | The Client Id of the login provider. e.g. Google's Client ID |
56-
| verifierSubIdentifier | String? | No | The name of the field in the JWT that should be used as the unique user ID of the JWT. Should be same as the one you used |
57-
| logoHover | String? | No | Logo to be shown on mouse hover. |
58-
| logoLight | String? | No | Light logo for dark background |
59-
| logoDark | String? | No | Dark logo for light background |
60-
| mainOption | Boolean? | No | Show login button on the main list |
61-
| showOnModal | Boolean? | No | Whether to show the login button on modal or not |
62-
| showOnDesktop | Boolean? | No | Whether to show the login button on desktop |
63-
| showOnMobile | Boolean? | No | Whether to show the login button on mobile |
49+
| Parameter | Description |
50+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51+
| `verifier` | The name of the verifier that you have registered on the Web3Auth Dashboard. It's a mandatory field, and accepts `string` as a value. |
52+
| `typeOfLogin` | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose `google`, a Google sign-in flow will be used. If you choose `jwt`, you should be providing your own JWT token, no sign-in flow will be presented. It's a mandatory field, and accepts `TypeOfLogin` as a value. |
53+
| `clientId` | Client id provided by your login provider used for custom verifier. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. It's a mandatory field, and accepts `string` as a value. |
54+
| `name?` | Display name for the verifier. If null, the default name is used. It accepts `string` as a value. |
55+
| `description?` | Description for the button. If provided, it renders as a full length button. else, icon button. It accepts `string` as a value. |
56+
| `verifierSubIdentifier?` | The field in JWT token which maps to verifier id. Please make sure you selected correct JWT verifier id in the developer dashboard. It accepts `string` as a value. |
57+
| `logoHover?` | Logo to be shown on mouse hover. It accepts `string` as a value. |
58+
| `logoLight?` | Light logo for dark background. It accepts `string` as a value. |
59+
| `logoDark?` | Dark logo for light background. It accepts `string` as a value. |
60+
| `mainOption?` | Show login button on the main list. It accepts `bool` as a value. Default value is false. |
61+
| `showOnModal?` | Whether to show the login button on modal or not. Default value is true. |
62+
| `showOnDesktop?` | Whether to show the login button on desktop. Default value is true. |
63+
| `showOnMobile?` | Whether to show the login button on mobile. Default value is true. |
6464

6565
</TabItem>
6666

‎docs/sdk/pnp/unity/initialize.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,16 @@ The Web3Auth Constructor takes a class `Web3AuthOptions` as input. This class ha
8888

8989
<TabItem value="table">
9090

91-
| Parameter | Type | Mandatory | Description |
92-
| ---------------- | ------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93-
| `clientId` | `string` | Yes | Your Web3Auth Project ID |
94-
| `network` | enum Web3Auth.Network | Yes | Network to run Web3Auth, either SAPPHIRE_MAINNET, SAPPHIRE_DEVNET, MAINNET, CYAN, AQUA or TESTNET |
95-
| `redirectUrl` | `Uri` | No | URL that Web3Auth will redirect API responses, default is `null` |
96-
| `whiteLabel` | `WhiteLabelData` | No | A configuration optional object to customize UI, branding, and translations for your brand. Refer [WhiteLabel](/pnp/features/whitelabel) section for more info. |
97-
| `loginConfig` | `Dictionary<string, LoginConfigItem>` | No | A configuration optional object to use custom authentication. Refer [Custom Authentication](/pnp/features/custom-authentication) for more info. |
98-
| `useCoreKitKey` | `bool` | No | A configuration optional object to use coreKitKey. |
99-
| `chainNamespace` | `ChainNamespace` | No | A configuration optional object to use chainNamespace. |
100-
| `mfaSettings` | `MfaSettings` | No | A configuration optional object to use mfaSettings. |
91+
| Parameter | Description |
92+
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93+
| `clientId` | Your Web3Auth Client ID. You can get it from Web3Auth [Dashboard](https://dashboard.web3auth.io/) under project details. It's a mandatory field of type `string` |
94+
| `network` | Defines the Web3Auth network. It's a mandatory field of type Network. |
95+
| `redirectUrl` | URL that Web3Auth will redirect API responses upon successful authentication from browser. It's a mandatory field of type `Uri`. |
96+
| `whiteLabel?` | WhiteLabel options for web3auth. It helps you define custom UI, branding, and translations for your brand app. It takes `WhiteLabelData` as a value. |
97+
| `loginConfig?` | Login config for the custom verifiers. It takes `Dictionary<string, LoginConfigItem>` as a value. |
98+
| `useCoreKitKey?` | Use CoreKit Key to get core kit key. It's an optional field with default value as `false`. |
99+
| `chainNamespace?` | Chain Namespace [`EIP155` and `SOLANA`]. It takes `Web3Auth.ChainNamespace` as a value. |
100+
| `mfaSettings?` | Allows developers to configure the Mfa settings for authentication. It takes `MfaSettings` as a value. |
101101

102102
</TabItem>
103103

0 commit comments

Comments
 (0)