Component metadata

Query public component records for documentation, design-system tooling, search, and agent guidance.

Metadata query API

tsimport {
  componentMetadata,
  findComponentsForIntent,
  getAgentComponentGuide,
  getComponentMetadata,
  getComponentsByCategory
} from "@tavojs/ui/metadata";

const button = getComponentMetadata("button");
const formComponents = getComponentsByCategory("forms");
const suggestions = findComponentsForIntent("search with clear action");
const compactGuide = getAgentComponentGuide("SearchInput");

API / option	Type	Default	Behavior
`componentMetadata`	`ComponentMetadata[]`	80 records	Complete public web component registry.
`getComponentMetadata(name)`	`ComponentMetadata \| undefined`	—	Case-insensitive lookup by component name or slug.
`getComponentsByCategory(category)`	`ComponentMetadata[]`	[]	Returns a copy of one category collection.
`findComponentsForIntent(query)`	`ComponentMetadata[]`	[]	Ranks exact names, slugs, search terms, categories, descriptions, props, examples, and accessibility guidance.
`getAgentComponentGuide(name)`	`AgentComponentGuide \| undefined`	—	Returns compact imports, usage advice, props, examples, accessibility, and related components.

Read a component record

Identity: name, slug, category, importPath, cssImportPath, description, summary, and status.
Decision support: whenToUse, avoidWhen, searchTerms, and related components.
API: prop names, types, required flags, documented defaults, descriptions, and examples.
Composition: compound members, common pairings, and related components.
Accessibility: summary and checklist for the reusable component contract.

Category values are layout, forms, data, feedback, content, recipes, and navigation. Status supports stable and experimental; every component in the current 80-component web catalog is stable.