MUI Bueno v3

A React component library based on Material UI components with built-in support for React Hook Form. Rebuilt & redesigned based on the original mui-bueno library, and expanded to provide additional components beyond form components.

A product of the SimonComputing Technology Innovations Lab

Installation

npm install mui-bueno-v3

Basic Example

<MForm>
    <TextField label="First Name" name="first-name" />
    <TextField name="lastName" label="Last Name" />
    <TextField name="dob" label="Date of Birth" format="99/99/9999" placeholder="MM/DD/YYYY" />
    <TextField name="email" label="Email" />
    <Submit>Submit</Submit>
</MForm>

Running the Library Locally

To test locally before submitting to NPM, perform the following:

rm -rf dist
npm run build:lib
npm pack

# will output something like: simoncomputing-mui-bueno-v3-0.1.14.tgz

In the application repo:

# Update package to look for this file in the proper directory.
npm i ~/git/mui-bueno-v3/simoncomputing-mui-bueno-v3-0.2.2.tgz

# Install
npm install

## If you want a clean reinstall
rm -rf node_modules package-lock.json
npm install

Deploying to NPM

Get an NPM Account

1. Request an account from Simon, indicate you want to deploy mui-bueno-v3.

Log into NPM

This project has been updated to require MFA and reject access tokens.

1. remove ~/.npmrc if it exists. We will login using MFA through the browser.
2. At command line, type: npm login
3. You'll be prompted to press enter to open the browser.
4. Finish your login process.
5. You can now confirm you're logged in:

# This should identify your user ID
npm whoami

# Logout
npm logout

# Running whoami again should return an error
npm whoami

# Log back in
npm login

Run the build

Go into package.json and set private to false. Don't check this in as this is safety against accidental deployment.

# Test with dry run
npm run publishLib:dryrun

# Run actual deployment
npm run publishLib

Undo your change to package.json

Documentation & Demo

This project uses Storybook to document and demonstrate the components. URL COMING SOON.

Release History

Details for every release are documented in CHANGELOG.md