Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.19 KB

README.md

File metadata and controls

27 lines (18 loc) · 1.19 KB

dRural MacawUI

Even it started as the official React UI components kit for dRural platform. It is only used in the dashboard. It has some important components as the ThemeProvider, the Sidebar and other navigational components. But apart from this is been deprecated, if you need to create components for dRural, the recomended way is to create them in the frontend application itlsef: storefront or dashboard.

Installation

npm i @drural/macaw-ui

Note that this package depends on the following Material-UI v4 packages: @material-ui/core, @material-ui/icons and @material-ui/lab. If your project doesn't have them installed and you're not using npm v7 with automatically installed peer dependencies then you'll need to install them manually:

npm i @material-ui/core @material-ui/icons @material-ui/lab

Working with Material-UI

MacawUI was created to integrate with Material-UI seamlessly. It exports a ThemeProvider that will override Material-UI component styles:

import { ThemeProvider } from "@drural/macaw-ui";

<ThemeProvider>
  <App />
</ThemeProvider>;