Skip to content

API by task

Use this page when you know what you want to build but not which Hedron symbol to use. The full API reference is organized by contract and package; this page is organized by intent.

Start here

I want to… Start with Then read
Create an application Hedron, @app.screen Build your first app
Render a complete page Page, @app.page Core concepts
Update one part of a page @app.refreshable, status.refresh_button(...) What is HTMX?
Add a second interaction @app.refreshable, @app.command HTMX interactions
Accept a form safely @app.form_command, FormBody, CsrfField Minimal form POST
Choose a lower-level interaction API region, @app.fragment, InteractionResult Which interaction API?
Build a reusable typed component Component, Props, NodeLike Component demos
Style a product surface DesignSystem, StyleRecipe, StyleScope Presentation · Modern CSS in 0.59
Add data and tables DataWorkspace, DataTable, Auto Data applications · Data API
Add authentication SessionAuthFlow, AuthResult Authentication · Auth API
Test requests and fragments AppScenario, TestClient, HTMX assertions Testing API
Inspect routes or diagnose a build hedron routes, hedron check, hedron style CLI · Troubleshooting
Deploy behind a proxy mount_hedron_static, path-prefix configuration Deployment · Mount API

Choose the right level

Start with the highest-level contract that solves the problem:

  1. Use a guide and a facade such as @app.screen, @app.refreshable, or @app.form_command for a new application.
  2. Use a component page when you need an exact constructor, prop, or accessibility contract.
  3. Use the API reference when you need return types, errors, response headers, or stability information.
  4. Use Autodoc for the complete signature surface after the hand-maintained contract page has answered the design question.

Do not begin with the largest catalog unless you are auditing an existing application. The learning path is the better starting point for a new project.

A useful API page should answer

For any symbol, look for these six pieces:

  • a short, runnable example;
  • the signature or members;
  • parameters and defaults;
  • return values and response behavior;
  • errors, HTTP status, and HED-* diagnostics;
  • related guides and the next abstraction to consider.

If a page does not answer one of those questions, use the linked guide or Autodoc and treat the omission as a documentation issue worth reporting.

Related entry points