{"repo":"saleor/macaw-ui","free":true,"listed":false,"github":"https://github.com/saleor/macaw-ui","clone":"git clone https://github.com/saleor/macaw-ui.git","description":"MacawUI: an official UI design kit for Saleor","language":"TypeScript","stars":119,"topics":["react-components","react","typescript","hacktoberfest"],"license":null,"category":"ui-components","readme_excerpt":"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 Usage You need to import the styles into your app. You can do it in your main entry point, for example index. tsx : Next, you need to add the ThemeProvider to your app. It will provide the theme to the components: Usage with Next.js If you need to render styles on the server we recommend that you use getCSSVariables helper to get the CSS variables that can be injected in document.tsx : Usage with form libraries React Hook Form You need to wrap the MacawUI component with Controller . For example: Usage with Sentry Add following configuration to Sentry.Integrations.Breadcrumbs : Right now sentry will display MacawUI components names in breadcrumbs. Development To begin, you need to install dependencies: Then, you can run the Storybook: You can run build in watch mode (useful for real-time development with e.g Dashboard): When you finish woking, you can add new changeset Useful tooling - Chrome browser extension - Atomic CSS Devtools License Distributed under the Creative Common Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ Thanks Thanks to Chromati","default_branch":null,"files":null,"tree":[],"storefront":"/r/saleor","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/saleor/macaw-ui/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}