React implementation for St. Jude Cloud Theme components
npm install @stjudecloud/ui-react
src="https://img.shields.io/badge/status-active-success.svg" />
src="https://img.shields.io/github/issues/stjudecloud/theme/%40stjudecloud%2Fui-react?label=issues" />
src="https://img.shields.io/github/issues-pr/stjudecloud/theme/%40stjudecloud%2Fui-react?label=pull%20requests" />
React component library for the St. Jude Cloud design system. See the repository's root README.md for more information on the design system itself.
Request Feature
|
Report Bug
⭐ Consider starring the repo! ⭐
Use the following commands to get started quickly.
``bashClone the repository and cd to packages/react
git clone https://github.com/stjudecloud/theme.git
cd theme/packages/react
Versioning
This repository matches Bootstrap's two major version numbers. If this repository's version is v4.3.123, then it depends on Bootstrap v4.3.x.
Using this package
First, add the library to your
package.json:`bash
npm add @stjudecloud/theme-react
`Next, use any of the components provided by the library in your own designs.
`javascript
import {Navbar} from '@stjudecloud/ui-react'; function MyComponent() {
return (
Cool content
);
}
`PLEASE NOTE: Your build process will need to be able to handle importing image files, e.g. with
webpack + file-loader`.Originally, react-router-dom was listed as an optional dependency. However, it turns out that NPM does not actually skip optional dependencies. For this reason. it is declared as a peer dependency, but is correctly handled if the dependency is missing.
© 2021-Present St. Jude Children's Research Hospital.