macpro-ux-lib
Common UI/UX Library built on USWDS 3.4.1 and packaged for easier distribution throughout CMS.
See the Storybook for a preview of the component library.
Overview
This is a React implementation of USWDS 3.4.1 in conjuction with some MACPRO theming. This library is meant to be consumed for implementing a USWDS compliant web application in React. For more information about USWDS and their design principles refer to the below link.
Usage and Getting Started
To install the package run the following command:
npm install @enterprise-cmcs/macpro-ux-lib
or
yarn add @enterprise-cmcs/macpro-ux-lib
After installing the package in the root level of your project include this import statement
import "@enterprise-cmcs/macpro-ux-lib/build/assets/css/index.css";
This will include the css required for the styles to be applied to any components that are used.
With the project now set up you can import any of the components in your code and use them. Refer to the StoryBook for implementation details on each component.
Contributing
Found a bug, want to help with updating the docs or maybe you want to help add a feature. Refer to our contribution documentation for more information: Documentation
License
See LICENSE for full details.