uniswap-interface-uncensored/WIDGETS_README.md
Jordan Frankfurt dceadf8472
chore(docs): add widgets info to the repo README (#3600)
* add widgets info to the repo README

* pr feedback from z

* pr feedback from w and z

* separate README.md and INTERFACE_README.md

* Update WIDGETS_README.md

Co-authored-by: Will Hennessy <hennessywill@gmail.com>

Co-authored-by: Will Hennessy <hennessywill@gmail.com>
2022-03-28 11:35:14 -05:00

1.7 KiB

Uniswap Labs Swap Widget

The Swap Widget bundles the whole swapping experience into a single React component that developers can easily embed in their app with one line of code.

swap widget screenshot

You can customize the theme (colors, font, border radius, and more) to match the style of your application. You can also configure your own default token list and optionally set a convenience fee on swaps executed through the widget on your site.

Installation

Install the widgets library via npm or yarn. If you do not already use the widget's peerDependencies redux and react-redux, then you'll need to add them as well.

yarn add @uniswap/widgets redux react-redux
npm i --save @uniswap/widgets redux react-redux

Documentation

Example Apps

Uniswap Labs maintains two demo apps in branches of the widgets-demo repo:

Others have also also released the widget in production to their userbase:

Uniswap Labs encourages integrators to evaluate their own regulatory obligations when integrating this widget into their products, including, but not limited to, those related to economic or trade sanctions compliance.