Back to Rocket Chat

`@rocket.chat/ui-kit`

packages/ui-kit/README.md

8.4.02.1 KB
Original Source
<!--header--> <p align="center"> <a href="https://rocket.chat" title="Rocket.Chat"> </a> </p>

@rocket.chat/ui-kit

Interactive UI elements for Rocket.Chat Apps


<!--/header-->

Install

<!--install-->

Add @rocket.chat/ui-kit as a dependency:

sh
npm i @rocket.chat/ui-kit

# or, if you are using yarn:

yarn add @rocket.chat/ui-kit
<!--/install-->

Contributing

<!--contributing(msg)-->

Contributions, issues, and feature requests are welcome!

Feel free to check the issues.

<!--/contributing(msg)-->

Building

As this package dependends on others in this monorepo, before anything run the following at the root directory:

<!--yarn(build)-->
sh
yarn build
<!--/yarn(build)-->

Linting

To ensure the source is matching our coding style, we perform linting. Before commiting, check if your code fits our style by running:

<!--yarn(lint)-->
sh
yarn lint
<!--/yarn(lint)-->

Some linter warnings and errors can be automatically fixed:

<!--yarn(lint-and-fix)-->
sh
yarn lint-and-fix
<!--/yarn(lint-and-fix)-->

Running tests

Whenever possible, add tests to describe exactly what your code do. You can run them by yourself:

<!--yarn(test)-->
sh
yarn test
<!--/yarn(test)-->