1. Getting started
  2. API reference
  3. dotui.json

dotui.json

The dotui.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.

Schema

After running the init command, you’ll have a new dotui.json file in your directory:

dotui.config.json
{
  "$schema": "https://dotui.org/schema.json",
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "core": "@/lib/core",
    "lib": "@/lib",
    "hooks": "@/hooks"
  },
  "preferences": {
    "prefersArrowFunction": false
  },
  "style": {
    "iconLibrary": "lucide",
    "componentsOverrides": {
      "button": "button-01"
    }
  }
}

$schema

The $schema field is used to validate the configuration file.

Aliases

Aliases are used to map the default import paths to your project's paths.

Preferences

Preferences are used to configure the project's preferences.

KeyTypeDescription
prefersArrowFunction
boolean
Whether to use arrow functions.

Style

The style object is used to configure the project's style.

KeyTypeDescription
iconLibrary
"lucide" | "phosphor" | "remix"
The icon library to use.
componentsOverrides
Record<string, string>
The component overrides to use.