Getting Started

Get started with Universal UI in seconds.

Begin by installing @parssa/universal-ui with your package manager of choice.

npm install @parssa/universal-ui

Now, wrap the root of your app in the UniversalUIConfigProvider to provide global theming. More on how to customize Universal UI here.

import { UniversalUIConfigProvider } from "@parssa/universal-ui";

const App = () => {
  return <UniversalUIConfigProvider>{/* ... */}</UniversalUIConfigProvider>;
};

Lastly, add the following to your tailwind.config.js to enable the Universal UI plugin.

module.exports = {
  content: [
    "./node_modules/@parssa/universal-ui/src/components/**/*.{ts,tsx,js,jsx}"
  ],
  ...
  plugins: [
    require("@parssa/universal-ui/src/plugin"),
  ]

That's it! 🎉 You're now ready to use Universal UI in your app.

Next

Customization