Featherweight Design Component Library

A component library built for and maintained by Featherweight Design in an effort to standardize and expedite the design and development process.

View the published library ✨

Installation

Clone the repository:

git clone [email protected]:featherweight-design/component-library.git

Enter the directory and install all dependencies:

cd component library
yarn install

Usage

To run the component library's Storybook:

yarn storybook

To install the component library as a dependency:

yarn add @f-design/component-library

npm install @f-design/component-library

To override style variables in your project, add the below @import to your main.scss or equivalent file:

// variables.scss
$brand-color: #8155A5;
$brand-hover: #764E96;
$brand-active: #6A4688;

// main.scss
@import './variables';
@import './mixins';

@import '~@f-design/component-library/dist/scss/components/all.scss';

Contributing

See our CONTRIBUTING.md

LICENSE

MIT