Appearance
Are you an LLM? You can read better optimized documentation at /docs/custom-widgets/v2/registry-reference.md for this page in Markdown format
Registry Reference
The extensions_registry.json file at the root of your repository declares every widget, script, and stylesheet you want to publish. This page documents the root object; each entry type has its own reference page linked below.
Root Object
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
widgets | array | No | [] | Widget definitions — see Widget Definition Reference |
scripts | array | No | [] | Script definitions — see Script Definition Reference |
stylesheets | array | No | [] | Stylesheet definitions — see Stylesheet Definition Reference |
All three arrays are optional. A registry with only widgets publishes no scripts or stylesheets; a registry with only scripts publishes no widgets. An empty array is valid and publishes nothing of that type.
json
{
"widgets": [ ... ],
"scripts": [ ... ],
"stylesheets": [ ... ]
}1
2
3
4
5
2
3
4
5
Minimal Example
The smallest valid registry:
json
{
"widgets": [],
"scripts": [],
"stylesheets": []
}1
2
3
4
5
2
3
4
5
This publishes nothing but passes validation. Use it to verify your repository connection before adding entries.
File Location
- The file must be at the root of your repository.
- Filename must be
extensions_registry.json.
Migration from `widget_registry.json`
If your repository uses the old widget_registry.json filename, it still works during the migration window. Rename it to extensions_registry.json at your earliest convenience — the old name is deprecated and will be removed in a future release.
Validation
- The root must be a JSON object.
widgets,scripts, andstylesheetsmust be arrays if present.- Each entry follows its own schema — see the per-type reference pages.
For validation errors, see Error Codes.
Next Steps
- Widget Definition Reference — fields for the
widgetsarray - Script Definition Reference — fields for the
scriptsarray - Stylesheet Definition Reference — fields for the
stylesheetsarray - Repository Layout — how to organize the files referenced from the registry

