rts-react-components-v3 v0.0.7

⚛️ RTS React Component Library

The React Component Library is a collection of components used within the RTS Design System to provide a consistent foundation for client projects at RTS. The Library is intended to improve the quality and efficiency of RTS developed products by jump-starting development with ready-made components that solve for common design elements or product features. Basic styles are provided out-of-the-box for quickly wireframing or testing proposed solutions.

Purpose

The Library is designed to meet several business goals of RTS and its customers:

1. Encourage consistent development practices
2. Improve quality, reliability, and performance of RTS products
3. Increase developer bandwidth
4. Reduce the cost and duration of product development
5. Reduce the time to onboard new developers

Maintainers

These contributors are the primary maintainers of this library. This list will be updated over time as contributors join or depart.

• Chris Monaccio (@cmonaccio)
• Trevor Kirpaul (@trevorKirpaulRTS)
• Caitlin Munley (@CaitlinWeb)

See contributors for other contacts.

👩‍💻 Using the Library

Installation

Install the Library package using npm:

npm install @rtslabs/rts-react-components --save

Importing Components

Include a provided component in your project:

import { Button } from "@rtslabs/rts-react-components";

Rendering a Component

Use the element within the render function:

ReactDOM.render(
  <Button onClick={() => alert("Button clicked!")}>Example button</Button>
);

Styling a Component

We've chosen Styled Components for styling and themeing our components. It uses tagged template literals

This is a basic example of how components are styled within the library:

// Create a Title component that'll render an <h1> tag with some styles
const Title = styled.h1`
  font-size: 1.5em;
  text-align: center;
  color: palevioletred;
`;

// Create a Wrapper component that'll render a <section> tag with some styles
const Wrapper = styled.section`
  padding: 4em;
  background: papayawhip;
`;

// Use Title and Wrapper like any other React component – except they're styled!
render(
  <Wrapper>
    <Title>Hello World!</Title>
  </Wrapper>
);

For a full description on how to style a component, please refer to Styled Components' Documentation.

📆 Components Status

👩‍🎤 Contributing

For more information, refer to the Developer Docs wiki page.