Skip to content

boggsyweb/modulo-ui

Repository files navigation

Logo

Módulo UI

Módulo UI is teeny tiny React component library designed to make building React projects easier. Módulo was started by Stephanie Boggs as a challenge to learn as much as possible about designing, building, packaging, and publishing a component library. The future looks bright, as Stephanie is working on some collaborative projects to help Módulo UI grow into a (slightly) larger than "teeny tiny" library.

Table of contents

Documentation

Click here for the Módulo UI website and for all of the up-to-date info.

Installation

with npm

 $ npm install modulo-ui

with yarn

 $ yarn add modulo-ui

Usage

To start using the components, import the one(s) you want to use into your project, pass the appropriate props, and add whatever logic you need:

import { Button } from 'modulo-ui'

      const App = () => (
        <>
         <Button 
            Size='large' 
            Color='red'
            Icon 
            IconType='settings1' 
            ButtonLabel="Submit" 
            onClick={handleButtonClick} 
         />
        </>
      );

For more in-depth examples, including how to overwrite default styles, go to the Módulo UI website.

Authors

Contributing

Módulo UI is still getting off the ground, but if you'd like to chat about contributing in the future, email here:

sjboggsdev@gmail.com

License

MIT

Releases

No releases published

Packages

No packages published