modern-ui.json

The modern-ui.json file holds configuration for your project.

We use it to understand how your project is set up and how to generate components customized for your project.

Note: The modern-ui.json file is optional and only required if you're using the CLI to add components to your project. If you're using the copy and paste method, you don't need this file.

You can create a modern-ui.json file in your project by running the following command:

See the CLI section for more information.

style

The style for your components. This cannot be changed after initialization.


{
  "style": "default"
}

outDir

The directory where the components will be installed.


{
  "outDir": "src/components/modern-ui"
}

typescript

TypeScript support toggle.


{
  "typescript": true
}

tailwind

Tailwind support toggle.


{
  "tailwind": true
}

tailwindVersion

The version of Tailwind to use.


{
  "tailwindVersion": "v4"
}

framework

Detected framework


{
  "framework": "nextjs"
}

theme

The theme to use.


{
  "theme": "default"
}

aliases

Aliases for components.


{
  "aliases": {
    "cn": "@/lib/utils",
    "hooks": "@/hooks",
  }
}

components

Tracks installed components.


{
  "components": []
}