Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.71 KB

README.md

File metadata and controls

51 lines (31 loc) · 1.71 KB
Raw

@masonite/external-ui-react

MDL styles and React components for development. See them in action in Storybook.

Install

npm i @masonite/external-ui-react

Usage

CSS

Add MDL CSS using SCSS found in the /styles directory. There are 2 main files to choose from: index.scss and global.scss. Index provides variables and mixins only. You can safely use this any CSS file. Global adds styling to h1-h6, p, and other element tags, as well as the variables.

Customize

Alternatively, you can modify the SCSS by defining the variables found in _config-variables.scss before importing index.scss.

Import Examples

ES6

import '@masonite/external-ui-react/dist/styles/index.scss'

SCSS file

// This is using webpack. How you access node_modules may differ.
@import '~@masonite/external-ui-react/dist/styles/index.scss';

React components

Import a component as shown below and you're good to go. See the list of available components on Storybook or check the components source folder.

import { Button } from '@masonite/external-ui-react'

Development

Clone down Masonitedoors/MDL, install dependencies, and run npm run storybook:react.

Deployment

  1. Update the CHANGELOG.md for the version you're releasing. If there is an [Unreleased] block, change that to the next version following semver.
  2. Build the package with npm run build-package:external-ui-react from the monorepo root, followed by lerna publish.