FAQ

Frequently asked questions

What does a complex component look like?

Here's an example of a complex component that installs a page, two components, a hook, a format-date utils and a config file.

Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.

How do I add a new Tailwind color?

To add a new color you need to add it to cssVars under light and dark keys.

Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.

The CLI will update the project CSS file. Once updated, the new colors will be available to be used as utility classes: bg-brand and text-brand-accent.

Why does button in registryDependencies not resolve to my GitHub repository?

Bare registry dependency names keep the existing JGuang UI behavior. button means the built-in JGuang UI button item.

For a dependency from a GitHub repository, use the full GitHub item address.

{
  "registryDependencies": ["acme/ui/button"]
}

How do I pin a GitHub registry item?

Add #ref to the GitHub item address. The ref can be a branch, tag or full commit SHA.

Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.

For published registries, prefer tags or full commit SHAs.

Can GitHub registry addresses use private repositories?

Not currently. GitHub registry addresses support public github.com repositories. For private registries, use a namespace with authenticated URLs.

How do I add or override a Tailwind theme variable?

To add or override a theme variable you add it to cssVars.theme under the key you want to add or override.

Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.