Back to Rocket Chat

`@rocket.chat/fuselage-ui-kit`

packages/fuselage-ui-kit/README.md

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

@rocket.chat/fuselage-ui-kit

UiKit elements for Rocket.Chat Apps built under Fuselage design system


<!--/header-->

Install

<!--install-->

Firstly, install the peer dependencies (prerequisites):

sh
npm i @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/styled react react-dom

# or, if you are using yarn:

yarn add @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/styled react react-dom

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

sh
npm i @rocket.chat/fuselage-ui-kit

# or, if you are using yarn:

yarn add @rocket.chat/fuselage-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)-->

Component stories

We develop and describe our visual components in the form of stories, manage by a tool called Storybook. To start developing with Storybook, run:

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