---
title: API reference
url: https://citry.dev/reference/
description: "The citry public API, by area."
---
# API reference

The citry public API, by area.

- [Component](/reference/component/) - The base class every component subclasses.
- [Component introspection](/reference/component-introspection/) - Frozen metadata records for component catalogs, schemas, assets, and extensions.
- [Component graph](/reference/component-graph/) - Authored component dependencies, reverse references, source locations, and partial-analysis problems.
- [Component libraries](/reference/component-libraries/) - Engine-neutral component definitions, explicit manifests, and per-Citry installations.
- [Citry instance and config](/reference/citry/) - The `Citry` instance that scopes components, settings, and caches.
- [Rendering](/reference/rendering/) - The render pipeline, its output structs, and Citry's trusted-HTML marker. `citry.Markup` is exactly [`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup). `Markup(value)` trusts the complete value without sanitizing or validating anything.
- [Slots](/reference/slots/) - The slot value and fill types.
- [Nodes](/reference/nodes/) - The runtime node classes the compiled template instantiates.
- [Template analysis](/reference/template-analysis/) - Discovery, analysis, source mapping, and formatting for Python-embedded templates.
- [Preview](/reference/preview/) - Component examples, layouts, and metadata for command-owned preview pages.
- [Extensions](/reference/extensions/) - The plugin system: the extension base, its commands, and the hook context objects.
- [Dependencies](/reference/dependencies/) - The JS/CSS dependency types collected and placed at serialize time, and the built-in `citry.ext.dependencies` extension that owns them.
- [Render cache keys](/reference/cache-keys/) - Exact key helpers and errors for component and named-fragment render caches.
- [Internationalization](/reference/internationalization/) - Locale contexts, messages, named formats, and strict localized-input parsers.
- [Events](/reference/events/) - Event handlers declared on components: the `class Events:` contract, the typed base for it, and the built-in `citry.ext.events` extension that owns it.
- [Browser APIs](/reference/browser-apis/) - Component JavaScript, Citry's Alpine magics, and page-wide browser methods.
- [HTML attributes](/reference/attributes/) - Helpers for Vue-like class/style merging on HTML elements.
- [Web integration](/reference/web/) - The route table a web framework mounts, and the request/response types handlers use (see `citry.contrib`).
- [Contrib integrations](/reference/contrib/) - Adapters mounting citry into web frameworks, and cache adapters for shared stores (the `citry.contrib.<name>` modules).
- [Built-in tags](/reference/builtins/) - The built-in `<c-*>` tags every component can use.