@cowprotocol/widget-react/README.md

CoW Swap Widget Library. Allows you to easily embed a CoW Swap widget on your React application.

# CoW Swap React widget

React component that creates a CoW Swap widget. It is based on [https://npmjs.com/package/@cowprotocol/widget-lib](https://npmjs.com/package/@cowprotocol/widget-lib)

## Use it

Install dependency

```bash
yarn add @cowprotocol/widget-react
```

```bash
npm install @cowprotocol/widget-react
```

Import component and some convenient types

```ts
import { CowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-react'
```

Prepare the config for the widget:

```ts
const cowSwapWidgetParams: CowSwapWidgetParams = {
  appCode: 'NAME-OF-YOU-APP', // Add here the name of your app. e.g. "Pig Swap"
  width: '600px',
  height: '700px',
  tradeType: 'swap',
}
```

Render the component:

```jsx
<CowSwapWidget params={cowSwapWidgetParams} />
```

## Developers

```bash
# Test
nx test widget-react

# Build the library
nx build widget-react

# Publish to NPM
nx publish widget-react --ver x.y.z --tag latest
```