Skip to content

feat: WalletAdvanced docs#1819

Merged
brendan-defi merged 6 commits into
mainfrom
bf/wallet-island-docs
Jan 15, 2025
Merged

feat: WalletAdvanced docs#1819
brendan-defi merged 6 commits into
mainfrom
bf/wallet-island-docs

Conversation

@brendan-defi
Copy link
Copy Markdown

@brendan-defi brendan-defi commented Jan 15, 2025

What changed? Why?

  • added documentation for WalletAdvanced, including WalletAdvancedDefault, WalletIsland, and customization options

Notes to reviewers

How has it been tested?

@github-actions github-actions Bot added documentation Improvements or additions to documentation root labels Jan 15, 2025
@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
onchainkit-coverage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 7:59pm
onchainkit-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 7:59pm
onchainkit-routes ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 7:59pm

Comment thread site/docs/pages/wallet/types.mdx
## `WalletAdvancedContextType`

```ts
export type WalletAdvancedContextType = {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same with this one. does it need to be exposed?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's helpful, no?

Copy link
Copy Markdown
Contributor

@dschlabach dschlabach Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I missed it in the other wallet advanced PR, but I don't think we should export WalletAdvancedContextType or include in external docs - it's an internal implementation detail that's unhelpful / confusing to users

Is there a use case you have in mind?

Comment thread site/docs/pages/wallet/wallet-advanced.mdx Outdated
Comment thread site/docs/pages/wallet/wallet-island.mdx
Comment on lines +219 to +224
<WalletAdvanced>
<WalletAdvancedWalletActions />
<WalletAdvancedAddressDetails />
<WalletAdvancedTransactionActions />
<WalletAdvancedTokenHoldings />
</WalletAdvanced>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we showcase some of the props in action?

Wallet modal offers users multiple wallet connection options. Explore these options
[here](/wallet/wallet#using-wallet-modal).

## Example usage
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also be good to showcase theming and link to customizing themes

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like that, esp for the QR codes, will add as a fast-follow

Comment thread site/docs/pages/wallet/wallet-island.mdx
Comment thread site/docs/pages/wallet/wallet-island.mdx
Comment thread site/docs/pages/wallet/wallet-island.mdx Outdated
fakepixels
fakepixels previously approved these changes Jan 15, 2025
cpcramer
cpcramer previously approved these changes Jan 15, 2025
@fakepixels fakepixels self-requested a review January 15, 2025 20:05
@brendan-defi brendan-defi merged commit ab00cd6 into main Jan 15, 2025
@brendan-defi brendan-defi deleted the bf/wallet-island-docs branch January 15, 2025 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

6 participants