mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-28 07:04:20 +00:00
* feat(v4): update home page * fix * fix: cards * feat(v4): charts page * feat: update pages * feat: colors * fix * feat: add docs * feat: mdx work * fix * fix * fix: sidebar * fix: lint * feat: updates * feat: update components * feat: fix docs * fix: responsive * feat: implement cmdk * fix: update navigation menu demo * fix: code style * fix: themes * feat: implement blocks page * fix: docs config * refactor * fix: outputFileTracingIncludes * fix * fix: output * fix * fix: registry * refactor: move docs * debug: docs * debug * revert * fix: mjs * deps: pin fumadocs * debug * fix: downgrade next * fix: index page * refactor: move mdx components * fix: remove copy button * fix * was it zod * yes it was * remove copy page * fix: color page * fix: colors page * fix: meta colors * fix: copy button * feat: sync registry * fix: registry build script * feat: update port * feat: clean up examples * fix * fix: mobile nav * fix: blur for mobile * fix: sidebar nav * feat: update examples * fix: build scripts * feat: update components * feat: restyle * fix: types * fix: styles * fix: margins * fix: screenshots * fix * feat: update theme * fix: charts nav * fix: image * feat: optimize images * fix: menu * fix: card * fix: border * check * feat: implement charts page * fix: charts * fix: og images * feat: extend touch * fix: static * fix: sizing * fix: mobile screenshots * fix: page nav * fix * feat: update favicon * fix: theme selector * fix: feedback * fix: sink * docs: update * fix: styles * chore: update registry * fix: command * fix * fix: minor updates * fix: typography on smaller devices * fix: format * fix: remove unused icon * feat: update favicon * fix: typography * docs: typography page * fix: steps
102 lines
2.6 KiB
Plaintext
102 lines
2.6 KiB
Plaintext
---
|
|
title: FAQ
|
|
description: Frequently asked questions about running a registry.
|
|
---
|
|
|
|
## 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.
|
|
|
|
```json showLineNumbers
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
|
|
"name": "hello-world",
|
|
"title": "Hello World",
|
|
"type": "registry:block",
|
|
"description": "A complex hello world component",
|
|
"files": [
|
|
{
|
|
"path": "registry/new-york/hello-world/page.tsx",
|
|
"type": "registry:page",
|
|
"target": "app/hello/page.tsx"
|
|
},
|
|
{
|
|
"path": "registry/new-york/hello-world/components/hello-world.tsx",
|
|
"type": "registry:component"
|
|
},
|
|
{
|
|
"path": "registry/new-york/hello-world/components/formatted-message.tsx",
|
|
"type": "registry:component"
|
|
},
|
|
{
|
|
"path": "registry/new-york/hello-world/hooks/use-hello.ts",
|
|
"type": "registry:hook"
|
|
},
|
|
{
|
|
"path": "registry/new-york/hello-world/lib/format-date.ts",
|
|
"type": "registry:utils"
|
|
},
|
|
{
|
|
"path": "registry/new-york/hello-world/hello.config.ts",
|
|
"type": "registry:file",
|
|
"target": "~/hello.config.ts"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### 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.
|
|
|
|
```json showLineNumbers {10-18}
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
|
|
"name": "hello-world",
|
|
"title": "Hello World",
|
|
"type": "registry:block",
|
|
"description": "A complex hello world component",
|
|
"files": [
|
|
// ...
|
|
],
|
|
"cssVars": {
|
|
"light": {
|
|
"brand-background": "20 14.3% 4.1%",
|
|
"brand-accent": "20 14.3% 4.1%"
|
|
},
|
|
"dark": {
|
|
"brand-background": "20 14.3% 4.1%",
|
|
"brand-accent": "20 14.3% 4.1%"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
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`.
|
|
|
|
### 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.
|
|
|
|
```json showLineNumbers {10-15}
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
|
|
"name": "hello-world",
|
|
"title": "Hello World",
|
|
"type": "registry:block",
|
|
"description": "A complex hello world component",
|
|
"files": [
|
|
// ...
|
|
],
|
|
"cssVars": {
|
|
"theme": {
|
|
"text-base": "3rem",
|
|
"ease-in-out": "cubic-bezier(0.4, 0, 0.2, 1)",
|
|
"font-heading": "Poppins, sans-serif"
|
|
}
|
|
}
|
|
}
|
|
```
|