Skip to content

Commit ff6ff1f

Browse files
authored
Edit the Angular SDK content. (#2287)
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
1 parent 1486f6d commit ff6ff1f

File tree

10 files changed

+40
-28
lines changed

10 files changed

+40
-28
lines changed
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
### Fixing Bundler Issues
1+
### Fix bundler issues
22

3-
While using any web3 library in Angular, you may run into issues building. This issue occurs because some core packages like `eccrypto` have certain dependencies which are not present within the browser build environment.
3+
Some web3 packages (for example, `eccrypto`) rely on Node.js modules that aren't available in the
4+
browser.
45

5-
To solve this, please have a look at our troubleshooting pages about [Webpack 5 Issues](/troubleshooting/webpack-issues)
6+
To resolve this, see the
7+
[Webpack 5 troubleshooting issues](/embedded-wallets/troubleshooting/webpack-issues#angular) page.
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
### MetaMask Embedded Wallets Angular Quick Start
1+
### MetaMask Embedded Wallets Angular quickstart
22

3-
Integrate secure and seamless Web3 authentication into your Angular app using MetaMask Embedded Wallet SDKs.
3+
Add Web3 authentication to your Angular app with the MetaMask Embedded Wallets SDK.
44

5-
Clone the Angular Quick Start Application
5+
To view a quickstart for a different platform, select the dropdown in the menu bar and choose your
6+
target (for example, Android, React, Flutter, iOS, or others).
7+
8+
Clone the Angular quickstart application:
69

710
```shell
811
npx degit Web3Auth/web3auth-examples/quick-starts/angular-quick-start w3a-quick-start
912
```
1013

11-
:::info
14+
:::info Get help
1215

13-
If you face any problem anytime, you can always find help in the [**Web3Auth Community**](https://web3auth.io/community/c/help-pnp/pnp-web/7).
16+
Visit the [**Web3Auth community**](https://web3auth.io/community/).
1417

1518
:::
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
### Making Blockchain Calls
1+
### Make blockchain calls
22

3-
This example demonstrates the connection for an EVM Chain with Web3Auth. You can choose the library of your choice and configure it according the steps given in the respective RPC Files.
3+
This example shows how to connect to an EVM chain with Web3Auth. Choose your preferred library and
4+
configure it by following the steps in the relevant RPC files.
45

5-
:::tip Other Blockchains
6+
:::tip Connect any blockchain
67

7-
Web3Auth supports all blockchains. Have a look at our [Connect Blockchain](/connect-blockchain/) section of the documentation and choose your blockchain to get started.
8+
Refer to the [blockchain documentation](/embedded-wallets/connect-blockchain/) to learn more about making calls on
9+
any supported blockchain.
810

911
:::
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
### Configure Web3Auth
22

3-
Create a basic config for Web3Auth and pass the `clientId` & `web3AuthNetwork` from your Web3Auth Dashboard Project Settings.
3+
Create a basic Web3Auth configuration and pass the client ID and network details from your
4+
project settings in the Web3Auth dashboard.
45

56
:::info
67

7-
This is where you can also configure any major settings of your integration as well. Visit our [**configuration section**](/embedded-wallets/sdk/js/config) of the sdk reference to learn more about the different options available.
8+
Configure other major settings here as needed. See the [**configuration section**](/embedded-wallets/sdk/js/advanced/)
9+
for available options.
810

911
:::
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
### Initialize Web3Auth
22

3-
Web3Auth's Instance needs to be initialized as soon as your app loads up to enable the user to log in. Preferably done within a constructor.
3+
Initialize the `Web3Auth` instance when your app loads to enable sign-in. We recommend
4+
doing this within a constructor.

src/pages/quickstart/builder/embedded-wallets/angular/stepContent/installation.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
### Install MetaMask Embedded Wallet SDK
1+
### Install MetaMask Embedded Wallets Angular SDK
22

3-
Install the Web3Auth Angular SDK package in your project.
4-
5-
> Additionally, for blockchain calls, this example can run with `viem` or `ethers`, you can choose your preferred library.
3+
Install the SDK package in your project. For blockchain calls, this example can run with `viem` or
4+
`ethers`, you can choose your preferred library.
65

76
```bash npm2yarn
87
npm install --save @web3auth/modal viem
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
### Logging in your User
1+
### Sign in the user
22

3-
Use the `connect` function in the Web3Auth Instance to display the modal. The modal will prompt the user to login with their wallet and handle the authentication for you.
3+
Use the [`connect`](/embedded-wallets/sdk/js/usage/connect) function to display the sign-in modal.
4+
The modal prompts the user to sign in with their wallet and handles the authentication.
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
### Log the user out
1+
### Sign out the user
22

3-
Use the `useWeb3AuthDisconnect` composable to log the user out. This will also delete the session information from the local storage of the browser.
3+
Use the `useWeb3AuthDisconnect` composable to sign out the user. This also clears session information
4+
from the browser's local storage.
45

56
:::info
67

7-
There are multiple other functions available in the Web3Auth SDK. Visit our [**functions section**](/embedded-wallets/sdk/js/functions) of the sdk reference to learn more about the different functions available.
8+
The SDK provides additional functions.
9+
See the [**functions reference**](/embedded-wallets/sdk/js/usage) for details.
810

911
:::

src/pages/quickstart/commonSteps/registerApp.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Visit the Web3Auth dashboard and create a new project. Use the client ID of the
1111
integration.
1212

1313
<a
14-
className="button"
14+
className="button button--primary button--sm"
1515
href="https://dashboard.web3auth.io"
1616
target="_blank"
1717
rel="noreferrer noopener">
18-
<span>Go to the Developer dashboard</span>
18+
Go to the Developer dashboard
1919
</a>

src/pages/quickstart/commonSteps/walletAggregatorOnly.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ To use Web3Auth as a wallet aggregator only (without social logins), disable soc
1212
Navigate to **Authentication > Social Connections** and turn off all social login providers to use Web3Auth purely as a wallet aggregator.
1313

1414
<a
15-
className="button"
15+
className="button button--primary button--sm"
1616
href="https://dashboard.web3auth.io"
1717
target="_blank"
1818
rel="noreferrer noopener">
19-
<span>Configure in Dashboard</span>
19+
Configure in Dashboard
2020
</a>

0 commit comments

Comments
 (0)