Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: SwapSettings #1265

Merged
merged 2 commits into from
Sep 20, 2024
Merged

docs: SwapSettings #1265

merged 2 commits into from
Sep 20, 2024

Conversation

cpcramer
Copy link
Contributor

@cpcramer cpcramer commented Sep 17, 2024

What changed? Why?
Add SwapSettings docs covering SwapSettings, SwapSettingsSlippageDescription, SwapSettingsSlippageInput, and SwapSettingsSlippageTitle.

Examples include general usage, overriding styles, overriding icons, adding text, and updating text!

Export-1726612507142

Screenshot 2024-09-17 at 3 31 06 PM Screenshot 2024-09-17 at 3 31 20 PM Screenshot 2024-09-17 at 3 31 30 PM Screenshot 2024-09-17 at 3 31 47 PM Screenshot 2024-09-17 at 3 32 04 PM Screenshot 2024-09-17 at 3 32 15 PM Screenshot 2024-09-17 at 3 32 27 PM Screenshot 2024-09-17 at 3 32 36 PM

Notes to reviewers

How has it been tested?

@github-actions github-actions bot added documentation Improvements or additions to documentation pkg: swap labels Sep 17, 2024
Copy link

vercel bot commented Sep 17, 2024

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 Sep 18, 2024 6:15pm
onchainkit-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 6:15pm
onchainkit-routes ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2024 6:15pm

@cpcramer cpcramer force-pushed the paul/add-swap-settings-slippage-docs branch from 6512503 to 1448ac5 Compare September 17, 2024 20:51
The `SwapSettings` component allows users to configure the maximum acceptable price difference (slippage) for their token swap transactions.
It provides a simple interface to set and adjust this tolerance level.

## Usage
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's rewrite all of this as Steps and story telling, like we have here https://onchainkit.xyz/transaction/transaction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Synced with Tina - Going to merge this"v1" now to focus on trying to get USD values in before the release tomorrow.

After USD values are implemented I will update SwapSettings to the story telling design that we have for /transaction

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update - merging this PR after Thursday's release. There is a icon bug fix that we need

@cpcramer cpcramer merged commit 9a7ef85 into main Sep 20, 2024
16 checks passed
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 pkg: swap
Development

Successfully merging this pull request may close these issues.

5 participants