react-mac-ui

React mac ui

Documentation

Visit https://react-mac-ui.netlify.app for full documentation.

Getting Started

Learn how to use react-mac-ui components to quickly and easily create elegant and flexible pages using Tailwind CSS.

react-mac-ui is working with Tailwind CSS classes and you need to have Tailwind CSS installed on your project - Tailwind CSS Installation.

• Intall react-mac-ui

npm i react-mac-ui

or

yarn add react-mac-ui

• Once you install react-mac-ui you need to wrap your tailwind css configurations with the withReactMacUI() function coming from react-mac-ui/config.

const withReactMacUI = require("react-mac-ui/config");

module.exports = withReactMacUI({
  content: ["src/**/*.{tsx,ts,js,jsx}"],
  theme: {
    extend: {},
  },
  variants: {},
  plugins: [],
});

• Add import css and BaseFeature component in your App.tsx file wrapped outside entire components

import "react-mac-ui/main.css";
import { BaseFeature } from 'react-mac-ui';
...

const App: React.FC = () => {
  return (
    <BaseFeature>
        ...
    </BaseFeature>
  )
}

• Congratulations 🥳, you did it, now you're ready to use react-mac-ui.

Community

Contributing

License

MIT