rivet-react v2.4.2

Rivet-react

Rivet-react is a library of React components that implement the Rivet Software Design System. The components can be used by any Javascript application with a peer dependency of React 16+.

Rivet-react resources

• Component Documentation and Style Guide
• Contribution Guidelines
• GitHub repo
• NPM package
• Circle CI

Branch	Build	Code Coverage
master
beta

Installation

To install the rivet-react package from NPM,

npm install rivet-react

Or with yarn,

yarn add rivet-react

Once installed you can use the components in your project. The Rivet styles are included as a dependency of rivet-react but they are not bundled into the components, so you'll need to import them as well.

import * as React from "react";
import "rivet-core/css/rivet.min.css";
import { Alert } from "rivet-react";

<Alert variant="info">A very important message for you!</Alert>;

Using rivet-icons and rivet-stickers

Rivet-react relies on several icons and stickers from the Rivet Icons and Rivet Stickers packages. In order to load the CSS and custom JavaScript necessary to display these elements, client applications will need to include the following in their index.jsx file similarly to how the Rivet core CSS is imported.

import "~/rivet-icons/dist/rivet-icon-element.js";
import "~/rivet-icons/dist/rivet-icon-element.css";
import "~/rivet-stickers/dist/rivet-sticker-element.js";
import "~/rivet-stickers/dist/rivet-sticker-element.css";

Documentation

Check out the Component Documentation and Style Guide for comprehensive component documentation and examples.

You can also find documentation for the 2.x beta components.

Issues and Contributions

Rivet-react is open source and maintained by members of the Indiana University organization on GitHub. If you have questions about the library or encounter problems please file an issue. If you wish to contribute, pull requests are welcome! Please review our Contribution Guidelines.