Skip to content

Commit 4899a21

Browse files
Adamj1232leightktgesquinca0xnikterlaurencedelisle
authored
Partial Docs release (#1692)
* Release 2.21.3 (develop) (#1656) * Bump docs packages * Update package versions for release * Remove optional chain in trezor * add safeheron to injected package readme * add wallet as value to translate function in more areas of connect * package updates * add images * text update * Update packages/react/package.json Co-authored-by: Adam Carpenter <adamcarpenter86@gmail.com> * Update packages/vue/package.json Co-authored-by: Adam Carpenter <adamcarpenter86@gmail.com> * add screenshots to top level assets folder * update react pkg * fix merge conflict in react pkg * fix vue pkg --------- Co-authored-by: Kat Leight <leightkt@gmail.com> Co-authored-by: Kat Leight <33187102+leightkt@users.noreply.github.com> * Update react hooks docs re usage of apiKey (#1668) * update supported networks svg * fix indentation * FEATURE: Add cede.store wallet package (#1667) * FEATURE: Add cede.store wallet package * Formatting and add to docs site * DOCS: Add cede.store detailed documentation with an example flow * Update formatting - looks good! --------- Co-authored-by: Adam Carpenter <adamcarpenter86@gmail.com> * Release 2.21.4 (develop) (#1671) * Update cede and WC docs (#1681) * add webpack-dev-server to dependencies (#1680) * Feat: Secondary Token Balances (#1679) * RPC working from hackathon * Working as expected for setting balances in state, no rendering yet * Display but need to be abstracted and cleaned * Added layout and styling for secondary tokens along with rework of maximized account center layout, still need docs updates for secondary tokens * Fix compiler err * Add docks for secondaryTokens and screenshots to readme and docs of AC * Fix versioning of common * Bump common * Bump all versions required * Prettify common validation * Fix: Walletconnet - wallet switching chains and handling int and hex chainIds (#1682) * Wallet switching chains now working properly and setting required chains to the config chains in w3o * Fix web3auth ci build * Update HeroSection.svelte (#1685) update title from web3-onboard to Web3 Onboard. When not referencing code we should stick to no dash * Update the core version within vue and react projects (#1686) * Playwright (#1609) * change scripts loaded for dev server, fix walletConnect, update webpack config, fix accounts error on no wallet connection (#1689) * Update FeaturesSection.svelte (#1684) * Update title Web3-Onboard to Web3 Onboard When not referencing the code, we should always use Web3 Onboard. When referencing code, we use web3-onboard. * Update FeaturesSection.svelte Update FeaturesSection to include the core package size minified. * Update docs/src/lib/components/HeroSection.svelte --------- Co-authored-by: Adam Carpenter <adamcarpenter86@gmail.com> * Fix: Secondary Token Symbol fetch and docs (#1690) * Fixing * Update SecondaryToken type * Add max of 5 tokens to secondaryTokens, add error handling in html, add docs update * Bump all package versions * Revert node version changes for web3auth * Remove cede from wallets group * Remove merge conflict in yarn.lock * Update packages/cede-store/README.md * Fix image path in docs * Update Account Center example with a better shot * Spelling & web3 onboard cohesion update (#1694) updating some spelling and web3 onboard referneces * Update account center shot to show multiple wallets connected * Update account center shot to show multiple wallets connected --------- Co-authored-by: Kat Leight <leightkt@gmail.com> Co-authored-by: Kat Leight <33187102+leightkt@users.noreply.github.com> Co-authored-by: Gustavo Esquinca <g.esq.ca@gmail.com> Co-authored-by: Nikita TEREKHOV <57397713+neeeekitos@users.noreply.github.com> Co-authored-by: Laurence <53497147+laurencedelisle@users.noreply.github.com>
1 parent 0dcbad8 commit 4899a21

File tree

85 files changed

+12976
-312
lines changed

Some content is hidden

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

85 files changed

+12976
-312
lines changed

assets/account-center-example.png

69.8 KB
Loading
69.8 KB
Loading

docs/src/lib/components/FeaturesSection.svelte

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<TextBlock
2424
title={'Framework Agnostic'}
2525
subtitle={'Support all your favorite frameworks.'}
26-
text={'Use web3-onboard with any of your favorite Javascript libraries.'}
26+
text={'Use Web3 Onboard with any of your favorite Javascript libraries.'}
2727
>
2828
<Flexbox --wrap="wrap">
2929
<Button href="/docs" buttonStyle={'link'}>{'Learn More'}</Button>
@@ -47,7 +47,7 @@
4747
<div class="flexbox">
4848
<FeatureCard
4949
title={'Minimal Dependencies'}
50-
text={'All wallet dependencies are included in separate packages, so you only include the ones you want to use in your app.'}
50+
text={'All wallet dependencies are included in separate packages, so you only include the ones you want to use in your app. Core package is only 815kb minified.'}
5151
/>
5252
<FeatureCard
5353
title={'Dynamic Imports'}
@@ -71,7 +71,7 @@
7171
<TextBlock
7272
title={'Enable Multi-Wallet and Multi-Chain functionality with one library '}
7373
subtitle={''}
74-
text={'Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 35 unique hardware and software wallets, Web3-Onboard saves you time and headaches.'}
74+
text={'Web3 Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 35 unique hardware and software wallets, Web3 Onboard saves you time and headaches.'}
7575
>
7676
<Flexbox --wrap="wrap">
7777
<Button href="/docs" buttonStyle={'link'}>{'Learn More'}</Button>

docs/src/lib/components/HeroSection.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<section style="background-image: url({heroBg});">
1010
<div class="textblock">
11-
<div class="title">{'Web3-Onboard'}</div>
11+
<div class="title">{'Web3 Onboard'}</div>
1212
<div class="text">
1313
{'Open-source, framework-agnostic JavaScript library to onboard users to web3 apps. Help your users transact with ease by enabling wallet connection, real-time transaction states, and more.'}
1414
</div>

docs/src/lib/components/TestimonialSection.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<section>
66
<h1 class="text">
7-
{"Who's using web3-onboard?"}
7+
{"Who's using Web3 Onboard?"}
88
</h1>
99
<div>
1010
<img src={TestimonialsGraphic} alt="Web3-Onboard-users">

docs/src/lib/components/ThemeCustomizer.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@
274274
<div id="image_drop_area">
275275
<form class="drop-area-controls" on:submit|preventDefault={addURLToIFrame}>
276276
<div>
277-
Enter your website url or drag and drop a screenshot to preview web3-onboard on your site
277+
Enter your website url or drag and drop a screenshot to preview Web3 Onboard on your site
278278
</div>
279279
<!-- <div>Then click color circles above to change the theme.</div> -->
280280
<div class="website-input-row">

docs/src/lib/components/ThemingSection.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
<div class="flexbox">
1515
<TextBlock
1616
title={'Themeable'}
17-
subtitle={'Powerfull customization options for all your needs'}
18-
text={'Style web3-onboard to fit into your existing designs, or pick from our pre-made themes.'}
17+
subtitle={'Powerful customization options for all your needs'}
18+
text={'Style Web3 Onboard to fit into your existing designs, or pick from our pre-made themes.'}
1919
>
2020
<Flexbox --wrap="wrap">
2121
<Button href="/docs" buttonStyle={'link'}>{'Learn More'}</Button>

docs/src/routes/docs/[...1]overview/[...1]introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ web3-onboard supports all EVM networks. Supporting a new network is simply a mat
3838
- Ethereum
3939
- Polygon
4040
- Base Goerli
41+
- Goerli
42+
- Sepolia
4143
- Arbitrum
4244
- Optimism
4345
- Avalanche
@@ -47,9 +49,7 @@ web3-onboard supports all EVM networks. Supporting a new network is simply a mat
4749
- Gnosis Chain
4850
- Harmony One
4951
- Moonriver
50-
- Goerli
51-
- Sepolia
52-
- Any other EVM network
52+
- All other EVM network
5353

5454
### [Optional] Use an API key to fetch real time transaction data, balances & gas
5555

docs/src/routes/docs/[...3]modules/core.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<script>
2+
import accountCenter from '$lib/assets/account-center-example.png'
23
import walletModal from '$lib/assets/connect-modal.svg'
34
import notifyCustomImg from '$lib/assets/notify-custom-example.png'
45
import notifyImg from '$lib/assets/notify-example.png'
@@ -139,6 +140,20 @@ type Chain = {
139140
icon?: string // the icon to represent the chain
140141
publicRpcUrl?: string // an optional public RPC used when adding a new chain config to the wallet
141142
blockExplorerUrl?: string // also used when adding a new config to the wallet
143+
secondaryTokens?: SecondaryTokens[] // An optional array of tokens (max of 5) to be available to the dapp in the app state object per wallet within the wallet account and displayed in Account Center (if enabled)
144+
}
145+
146+
interface SecondaryTokens {
147+
/**
148+
* Required - The onchain address of the token associated
149+
* with the chain it is entered under
150+
*/
151+
address: string
152+
/**
153+
* An optional svg or url string for the icon of the token.
154+
* If an svg is used ensure the height/width is set to 100%
155+
*/
156+
icon?: string
142157
}
143158
```
144159

@@ -255,18 +270,18 @@ type i18nOptions = Record<Locale, i18n>
255270
To see a list of all of the text values that can be internationalized or replaced, check out the [default en file](https://github.com/blocknative/web3-onboard/blob/develop/packages/core/src/i18n/en.json).
256271
Onboard is using the [ICU syntax](https://formatjs.io/docs/core-concepts/icu-syntax/) for formatting under the hood.
257272
258-
For example, to update the connect interface language for Metamask, while giving a different message for other wallets, you can include the following:
273+
For example, to update the connect interface language for Metamask, while giving a different message for other wallets, you can include the following:
259274
260275
```typescript
261276
i18n: {
262-
en: {
263-
connect: {
264-
connectingWallet: {
265-
paragraph: "{wallet, select, MetaMask {{wallet} can only present one account, so connect just the one account you want.} other {Please connect to all of your accounts in {wallet}.}}"
266-
}
267-
}
277+
en: {
278+
connect: {
279+
connectingWallet: {
280+
paragraph: '{wallet, select, MetaMask {{wallet} can only present one account, so connect just the one account you want.} other {Please connect to all of your accounts in {wallet}.}}'
268281
}
269282
}
283+
}
284+
}
270285
```
271286
272287
MetaMask message:
@@ -275,7 +290,7 @@ MetaMask message:
275290
All other wallets:
276291
<img src="{customConnect1}" alt="Web3-Onboard connect wallet modal with custom message"/>
277292
278-
Default Message- with no i18n override:
293+
Default Message- with no i18n override:
279294
<img src="{customConnectDefault}" alt="Web3-Onboard connect wallet modal with default message"/>
280295
281296
---
@@ -340,6 +355,8 @@ type disableFontDownload = boolean // defaults to false
340355
341356
An object that defines whether the account center UI (default and minimal) is enabled and its position on the screen. Currently the account center is enabled for both desktop and mobile devices.
342357
358+
<img src="{accountCenter}" alt="Web3-Onboard Account Center example"/>
359+
343360
```ts
344361
type AccountCenter = {
345362
enabled: boolean

docs/src/routes/docs/[...4]wallets/walletconnect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Walletconnect
22

3-
Wallet module for connecting Wallet Connect to web3-onboard
3+
Wallet module for connecting WalletConnect to web3-onboard, currently supporting both v1 and v2.
44

55
:::admonition type=warning
66
_Not all Wallets support WalletConnect V2 currently. For an up to date list please see the [WalletConnect Explorer](https://explorer.walletconnect.com/?version=2)_

0 commit comments

Comments
 (0)