@rocket.chat/fuselage

Rocket.Chat's React Components Library

Install

Firstly, install the peer dependencies (prerequisites):

npm i @rocket.chat/fuselage-hooks @rocket.chat/fuselage-polyfills @rocket.chat/icons react react-dom react-virtuoso

# or, if you are using yarn:

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

Add @rocket.chat/fuselage as a dependency:

npm i @rocket.chat/fuselage

# or, if you are using yarn:

yarn add @rocket.chat/fuselage

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues.

Building

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

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

Some linter warnings and errors can be automatically fixed:

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

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

Usage

To use the fuselage, you need to import the css first:

import '@rocket.chat/fuselage/dist/fuselage.css';

const MyButton = () => {
  return <Button>Fuselage Button</<Button>
};

Note: If you are using Next.js for development and wish to use Rocket.Chat Fuselage components, you need to dynamically import the component. More on this can be found here.

Usage Example:

import dynamic from 'next/dynamic';

export const TextInput = dynamic(
  () => import('@rocket.chat/fuselage').then((module) => module.TextInput),
  { ssr: false }
);