amenui
en·中 github ↗ v0.0.1
01docs 02components 03lab 04works
en·中github ↗
×

docs / reference / registry schema docs / reference /

Registry schema

05.2

registry.json lists every component as source to copy, the way shadcn/ui's registry does. amenui add reads it; the documentation's component pages are made from it.

FieldTypeMeaning
namestringThe component's name, as amenui add takes it (dialog, scroll_area).
titlestringIts name in Chinese.
groupstringWhere the docs list it: inputs, display, feedback, navigation, layout or data.
description, description_enstringOne sentence in each language.
functionsstring[]The functions it exports (dialog, dialog_sized).
filesstring[]Source files, relative to the repository root, copied to the same paths.
dependenciesstring[]Other registry items it needs (copied with it).
responsestringHow it answers fronts (nudge, loosen, ignore).
recomposestringWhat recomposes when its text changes.
recipesstring[]Recipes that use it.

An item named base holds the files every component needs (the element tree, the runtime).

sh
cargo run --release --bin amenui -- add dialog --to ../my-app