# wix-ui-tpa

Support Channel: [#wix-ui-tpa](https://wix.slack.com/archives/CJRU3U97A)

`wix-ui-tpa` is a library of React components that are designed to be used in Wix TPA's.

#### [Demo](https://bo.wix.com/pages/wix-ui-tpa) | [Demo App](https://github.com/wix/wix-ui-tpa-example)

## 📦 Installation

Before starting, note that the library is part of a [monorepo](../../docs/working-with-monorepo.md) bootstrapped by yarn.

Then, install with `npm` or `yarn`:

```sh
npm i wix-ui-tpa
# OR
yarn add wix-ui-tpa
```

## 🖇 Prerequisites

`wix-ui-tpa` uses [Stylable](https://stylable.io/) configuration, and depends on
[`wix-style-processor`](https://github.com/wix/wix-style-processor) by default.
In order to use `wix-ui-tpa`, your module bundler and app should be configured accordingly.

## 🚀 Usage

Please refer to the [Usage document](docs/USAGE.md).

## ✅ Test drivers

All of `wix-ui-tpa` components are 100% tested and supplies test drivers for easy
interactions in your tests. Read more about it in `wix-style-react`'s excellent
documentation [here](https://github.com/wix-private/wix-design-systems/blob/master/packages/wix-style-react/docs/usage/COMPONENTS_DRIVERS.md).

## 🤝 Contributing

Please refer to the [Contribution document](docs/CONTRIBUTION.md).

## 💫 Release Process

Please refer to the [Version Release document](docs/internal/VERSION_RELEASE.md).