⚠️ Warning: You are looking at the documentation of the Aphrodite-UI which is being actively developed. There will very likely be outdated and missing documentation.

Getting Started

Prerequisite

You need PostCSS, autoprefixer and Tailwind CSS installed.

npm install -D tailwindcss postcss autoprefixer

installation

Inside your React project directory, install Aphrodite UI by running the following:

npm install @aphrodite-ui/react @aphrodite-ui/core

Setup

  1. Setup Tailwind CSS if not configured.
npx tailwindcss init
  1. Configure your Tailwind CSS config file.
const { aphroditePlugin } = require('@aphrodite-ui/core');
 
module.exports = {
  content: [
    './src/**/*.{js,ts,jsx,tsx}',
    './node_modules/@aphrodite-ui/react/src/**/*.{js,ts,jsx,tsx}'
  ],
  darkMode: ['class', '[data-theme="dark"]'],
  theme: {
    extend: {}
  },
  plugins: [aphroditePlugin()]
};