30810eecd7
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Code scanning - action / CodeQL-Build (push) Failing after 2s
92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
<!--header-->
|
|
|
|
<p align="center">
|
|
<a href="https://rocket.chat" title="Rocket.Chat">
|
|
<img src="https://github.com/RocketChat/Rocket.Chat.Artwork/raw/master/Logos/2020/png/logo-horizontal-red.png" alt="Rocket.Chat" />
|
|
</a>
|
|
</p>
|
|
|
|
# `@rocket.chat/ui-kit`
|
|
|
|
> Interactive UI elements for Rocket.Chat Apps
|
|
|
|
---
|
|
|
|
[](https://www.npmjs.com/package/@rocket.chat/ui-kit/v/latest) [](https://www.npmjs.com/package/@rocket.chat/ui-kit/v/next)  
|
|
|
|
 
|
|
|
|
<!--/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!<br />
|
|
Feel free to check the [issues](https://github.com/RocketChat/Rocket.Chat/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](<https://en.wikipedia.org/wiki/Lint_(software)>).
|
|
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)-->
|