mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-09 06:55:07 +00:00
9643db42cf
* chore: 2.2.0-canary.2 * feat: add docs for registry * docs(www): update registry docs * fix: update dep * docs(www): update docs * docs(www): update registry docs * feat: add new label * fix: lint
88 lines
2.0 KiB
Plaintext
88 lines
2.0 KiB
Plaintext
---
|
|
title: registry.json
|
|
description: Schema for running your own component registry.
|
|
---
|
|
|
|
The `registry.json` schema is used to define your custom component registry.
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry.json",
|
|
"name": "shadcn",
|
|
"homepage": "https://ui.shadcn.com",
|
|
"items": [
|
|
{
|
|
"name": "hello-world",
|
|
"type": "registry:block",
|
|
"title": "Hello World",
|
|
"description": "A simple hello world component.",
|
|
"files": [
|
|
{
|
|
"path": "registry/hello-world/hello-world.tsx",
|
|
"type": "registry:component"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Definitions
|
|
|
|
You can see the JSON Schema for `registry.json` [here](https://ui.shadcn.com/schema/registry.json).
|
|
|
|
### $schema
|
|
|
|
The `$schema` property is used to specify the schema for the `registry.json` file.
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry.json"
|
|
}
|
|
```
|
|
|
|
### name
|
|
|
|
The `name` property is used to specify the name of your registry. This is used for data attributes and other metadata.
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"name": "acme"
|
|
}
|
|
```
|
|
|
|
### homepage
|
|
|
|
The homepage of your registry. This is used for data attributes and other metadata.
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"homepage": "https://acme.com"
|
|
}
|
|
```
|
|
|
|
### items
|
|
|
|
The `items` in your registry. Each item must implement the [registry-item schema specification](https://ui.shadcn.com/schema/registry-item.json).
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"items": [
|
|
{
|
|
"name": "hello-world",
|
|
"type": "registry:block",
|
|
"title": "Hello World",
|
|
"description": "A simple hello world component.",
|
|
"files": [
|
|
{
|
|
"path": "registry/hello-world/hello-world.tsx",
|
|
"type": "registry:component"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
See the [registry-item schema documentation](/docs/registry/registry-item) for more information.
|