JSPM

@saleor/macaw-ui

0.3.0-a.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4896
  • Score
    100M100P100Q143737F
  • License CC-BY-4.0

Saleor's UI component library

Package Exports

  • @saleor/macaw-ui
  • @saleor/macaw-ui/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@saleor/macaw-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Material-ui-pickers logo

npm package npm download Bundle Size

MacawUI

Official React UI components kit for Saleor — an open-source GraphQL-first and Next.js ready e-commerce platform. You can find most of the elements used in the creation of Saleor's dashboard interface and use it to create Saleor Apps. Have a great time working on your projects and empowering your users. If you have any questions, feel free to let us know on GitHub Discussions.

Installation

npm i @saleor/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

Documentation

Take a look at our storybook docs. You can find guides, component overview, and project ideas there.

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 "@saleor/macaw-ui";

// ...

<ThemeProvider>
  <App />
</ThemeProvider>

License

Distributed under the Creative Common Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/