Skip to content

Public API coverage map

Map of names in hedron.__all__ to documentation. Prefer imports from hedron for application code. Autodoc signatures: AUTODOC.md. Stability catalog: STABILITY.md.

App, routing, interaction

Export Primary docs
Hedron, mount_hedron_static HEDRON.md, Autodoc
MountPath, resolve_mount_path, resolve_mount_path_from_environ, normalize_mount_path, cookie_path_for_mount, mount_from_request, prefix_local_path MOUNT.md, deployment
HedronRouter, HedronRoute, ComponentRef, resolve_route_path ROUTER.md, ADDRESSABLE.md
InteractionResult, FragmentRegion, InteractionPolicy, HtmxRequest, HtmxAttrs, InteractionLowering, OobUpdate INTERACTION.md, HTMX/Alpine migration, Autodoc
ActionPhase, AsyncPhase, ActionState, ActionPolicy, OperationIdentity, ActionTrace, TraceEvent, ActionTransitionError INTERACTION.md, 0.61 implementation, 0.61 acceptance
begin_operation, complete_operation, transition_action INTERACTION.md, 0.61 implementation
AsyncRegion INTERACTION.md, component page, 0.61 acceptance
NavigationDecision, NavigationIdentity, NavigationMachine, NavigationPhase, NavigationPolicy, NavigationState, PrefetchDecision, decide_prefetch, is_safe_navigation_url INTERACTION_062.md, 0.62 acceptance
BoundaryDecision, BoundaryPhase, FailureBoundary, FailureDisposition, IdentityRegistry, IdentityTarget, StateTransfer, StateTransferPolicy INTERACTION_062.md, 0.62 acceptance
HEDRON_NAVIGATION_HEADER, HEDRON_NAVIGATION_PHASE_HEADER, HEDRON_NAVIGATION_TARGET_HEADER, HEDRON_NAVIGATION_TITLE_HEADER, HEDRON_PREFETCH_HEADER, apply_navigation_headers, evaluate_prefetch_request, navigation_identity_from_request INTERACTION_062.md, 0.62 acceptance
FragmentHandle, BoundFragment, ActionHandle, Refresh, refresh, patches, FragmentHost, Patch, PatchSet, RefreshIntent REFRESHABLE_VIEWS.md
ViewParams, FormBody, Control, Refreshes, Updates, OutcomeMap, case, CommandResult, RefreshableView, CommandHandler, Sensitive, InstanceKey, TypeSchema, DependsOn, DependencyLifetime, DependencyPlan, BoundaryBindingPlan, RequiresScopes TYPE_DRIVEN_AUTHORING.md, FASTAPI_PYDANTIC_CONVERGENCE.md
CatalogEntry, InteractionCatalog, InteractionManifest, PackageProjection, ProjectionCapability, CatalogVersionError INTERACTION_CATALOG.md
default_interaction_policy, form_sync_attrs, htmx_request, approved_headers, htmx_context INTERACTION.md, htmx-interactions
swap, swap_oob, retarget, redirect_htmx INTERACTION.md (day-1 ergonomics), Autodoc
action_attrs, oob_swap BUILT_INS.md, INTERACTION.md

Progressive feature and styling authoring (0.58)

Export Primary docs
ScreenHandle, ScreenLayout HEDRON.md, whats-new-0.58, Autodoc
DashboardWorkspace, DashboardHistory, CachePolicy dashboards, whats-new-0.58, Autodoc
TaskFlow, JobScope, JobScopeProvider, PollPolicy, TaskUnavailablePolicy JOBS.md, whats-new-0.58, Autodoc
SessionAuthFlow, AuthResult, AuthSuccess, AuthDenied, RateLimitPolicy, SessionRotationPolicy AUTH.md, whats-new-0.58
UploadFlow file-upload, whats-new-0.58, Autodoc
DesignSystem, StyleRecipe, StyleScope PRESENTATION.md, StyleScope, whats-new-0.58
Color, ThemeSpec, ThemeBuilder, ThemePatch, ThemePackage, THEME_PACKAGE_COMPATIBILITY, ThemeValidationReport Theme platform, phase 0.60 implementation
ComponentThemeContract, CoverageProfile, RecipeFamily, StyleContext Theme platform, phase 0.60 contract
ScrollRegion, ThemePicker, ThemePreference Component demos, phase 0.60 acceptance
package_theme, load_theme_package, register_theme_package, conformance_report, diff_theme_specs, explain_theme_spec, validate_theme_spec, register_component_theme_contract, registered_component_theme_contracts, register_recipe_family, registered_recipe_families, resolve_theme_preference, theme_boot_asset, theme_markers Theme platform, phase 0.60 implementation
ComponentStateMatrix, StateMatrixEntry, ThemeExport, ThemeResolution, build_state_matrix, compatibility_theme_vars, component_contract_manifest, derived_theme_tokens, export_theme, inspect_theme_css, resolve_theme, theme_contract_report Theme platform, phase 0.63 implementation
TRACE_CONTRACT_SCHEMA, decode_interaction_trace, encode_interaction_trace, profile_interaction_trace, element_metadata_manifest, package_identity_manifest Phase 0.63 implementation

Phase 0.67 browser-local and interaction preview

Export Primary docs
AlpineAttrs, AlpineDirective, AlpineExpression, AlpineFeatureDemand, AlpineMaturity, BrowserFeaturePlan, BrowserPlanClosure, BrowserPlanError 0.67 Alpine integration, HTMX/Alpine boundary
Interaction, InteractionKind, LocalEffect, Outcome, OutcomeKind, RequestEffect, ReviewedExpression 0.67 interaction preview, Interaction
FutureWarningRecord, FutureWarningRegistry, HedronFutureWarning, PUBLIC_FUTURE_WARNINGS, emit_future_warning, warn_legacy_path 0.67 migration warnings, Exceptions

Inference and model demos (0.18)

Export / package Primary docs
ModelDemo, InferenceInterface, ActionRegistry, RegisteredAction INFERENCE.md, model demos, Autodoc
ExampleSet, PredictionFeedback, InferencePolicy, InferenceWorkflow INFERENCE.md, Autodoc
InteractionRecorder (hedron) INFERENCE.md
DashboardBinding, InteractionGraph, TriggerContext Import from hedron_core (not root hedron.__all__) — dashboards, Autodoc
hedron_gradio.GradioClientAdapter Gradio migration

Responses and live transport

Export Primary docs
HTML, ComponentResponse, PageResponse, FragmentResponse, FileComponentResponse RESPONSES.md
hedron_response, merge_htmx_headers RESPONSES.md

Live helpers are experimental — not in hedron.__all__

Import SSE / streaming / WebSocket / preload helpers from hedron.experimental (a root hedron.* compat shim exists via __getattr__). Prefer polling in production. See LIVE_DISPOSITION.

Symbol (via hedron.experimental) Primary docs
SseResponse, sse_response, job_status_sse_response, extension_script_tags SSE.md, Autodoc
StreamingComponentResponse, stream_tokens, stream_document, stream_chunked_list STREAMING.md
accept_page_session_channel, send_region_update, origin_allowed, ALLOW_MISSING_ORIGIN WEBSOCKET_CHANNEL.md
HX_PRELOADED, NavigationPreloadPolicy, apply_preload_headers, evaluate_preload_request PRELOAD.md

Security and CSRF

Export Primary docs
SecurityPolicy, SecurityProfile, SecurityHeadersPolicy SECURITY_TYPES.md, CSRF_COMPOSITION.md, security guide, Autodoc
CsrfField, Form, Hx, DoubleSubmitCookieCsrf, SessionTokenCsrf CSRF_COMPOSITION.md, minimal form, Autodoc
csrf_token_for_request Re-exported from hedron; minimal form (advanced), SECURITY_TYPES.md
SafeUrl, Secret, TrustedHtml, UrlPurpose SECURITY_TYPES.md
redirect_local, redirect_external, redirect_htmx SECURITY_TYPES.md, Autodoc
hedron.oidc (OidcClientConfig, PKCE/state/nonce, login_url, …) AUTH.md, authentication, Autodoc — not an IdP product
OAuthHelper, create_oauth_client AUTH.md (hedron[auth])

Media, browser, and downloads

Export Primary docs
Audio, Video, CameraCapture, MicrophoneCapture, IFrame, PdfViewer, Map, GeoJSONLayer, Gallery Component pages, BUILT_INS.md
media_file_response, safe_download_response Media downloads, Autodoc
BrowserContext, browser_context, browser_context_from_request Autodoc; request-scoped browser hints (not authorization)
BrowserStorage, BrowserStorageUnavailable Autodoc; client storage is spoofable — never authorize from it
GeolocationButton, GeolocationHint Component pages; coordinates are client-reported
InteractionRecorder, RecordedExchange, RecordingSnippet INFERENCE.md
render, render_component_response, render_interaction, RenderContext, RenderMode, RenderResult RENDERING.md, INTERACTION.md

Previously unmapped helpers and types

Export Primary docs
ByteRangeNotSatisfiable EXCEPTIONS.md, media-downloads
CsrfStrategy CSRF_COMPOSITION.md, EXCEPTIONS.md
CsrfValidationError EXCEPTIONS.md, CSRF_COMPOSITION.md
FragmentRegionError EXCEPTIONS.md, INTERACTION.md
Dialogue Dialogue
DialogueTurn EXCEPTIONS.md, INFERENCE.md
DirectoryUpload DirectoryUpload
DirectoryUploadFile EXCEPTIONS.md, DirectoryUpload
ExampleItem INFERENCE.md
FeedbackPolicy INFERENCE.md
GalleryItem EXCEPTIONS.md, Gallery
LoginCsrfField CSRF_COMPOSITION.md
ParameterViewer ParameterViewer
PredictionLabel PredictionLabel
PredictionScore EXCEPTIONS.md, INFERENCE.md
StorageQuotaExceeded EXCEPTIONS.md
ViewportHint EXCEPTIONS.md
download_all_zip media-downloads
parse_byte_range media-downloads
redact_cookie_value EXCEPTIONS.md
validate_directory_upload EXCEPTIONS.md

Built-in UI components (complete __all__ inventory)

Constructor/props live on the component catalog. Index: BUILT_INS.md. FastAPI-only builtins also under Autodoc: AutoForm, ErrorState, InfiniteScroll, Loading, Pagination, ChatInput, DownloadButton, FileUpload, safe_download_response, plus layout helpers such as Page, Stack, Grid, Form, TextInput, RefreshButton, Poll, Lazy (error template outside #…-body), Metric, Toast (danger dismiss), ToastHost (covered in sections above / component pages).

Export Primary docs
AutoForm, ErrorState, InfiniteScroll, Loading, Pagination, ChatInput, DownloadButton, FileUpload Components, BUILT_INS.md, Autodoc
Page, Stack, Grid, TextInput, RefreshButton, Poll, Lazy, Metric, Toast, ToastHost Components, BUILT_INS.md, Autodoc
ActionDock, Alert, AmbientBackdrop, AmbientCanvas, AmbientLayer, AppShell, AppShellChrome, Aside, AttrHost, Badge Components, BUILT_INS.md
AccountSummary, AppFooter, Avatar, Brand, EnvironmentBanner, NavStatus Components, PRESENTATION.md
BottomDock, Button, Card, Carousel, ChatMessage, Checkbox Components, BUILT_INS.md
ChipInput, CircularProgress, ClipboardCopy, CodeBlock, CodeViewer, ColorInput Components, BUILT_INS.md
ConfirmButton, Container, ContextMenu, DateInput, DateTimeInput, DescriptionList Components, BUILT_INS.md
Dialog, Divider, Expander, Footer, FormErrors, FormField, SecretField Components, BUILT_INS.md
Fragment, Head, Header, Heading, Help, HelpInspector Components, BUILT_INS.md
GridItem, Identity, ResourceList, ResourceRow, Surface Components, Identity, PRESENTATION.md
HtmxLink, IconButton, Image, Inline, JSONViewer, Label Components, BUILT_INS.md
Link, LinkButton, List, Logo, Main, MainPanel Components, BUILT_INS.md
MarkerSpec, Math, MenuButton, MultiSelect, Nav, NavGroup, NavLink Components, BUILT_INS.md
NumberInput, OobHost, PageIcon, Pills, Popover, Progress Components, BUILT_INS.md
RadioGroup, RangeInput, RatingInput, Section, SegmentedControl, Select Components, BUILT_INS.md
SelectSlider, Sidebar, Skeleton, Spacer, Status, SubmitButton Components, BUILT_INS.md
Table, Tabs, Text, TextArea, Theme, TimeInput Components, Tabs, BUILT_INS.md
Timeline, Title, ToggleSwitch, Tooltip Components, BUILT_INS.md
PageHeader, SplitView, MasterDetail, FormGrid, ActionGroup AUTHORING_LOOP.md, WORKFLOW.md, Components
Capability / CapabilityProvider / enforce_capability WORKFLOW.md
IdempotencyPolicy / MemoryReplayStore WORKFLOW.md
UploadField / UploadHandle / materialize_upload WORKFLOW.md
NonceContext / compose_csp / ingest_csp_report WORKFLOW.md
WorkflowManifest / hedron upgrade-report WORKFLOW.md, CLI.md
SkipLink, RequestIndicator, ProcessFlow, FlowStep, ConnectorFlow, ConnectorNode, ConnectorTrack AUTHORING_LOOP.md, Components
Icon, Typography, StateView, TableColumn AUTHORING_LOOP.md, Components

Data and charts (extras)

Export Extra Primary docs
Auto none AUTO.md
DataTable, DataEditor, DataChanges, DataPage, DataQuery, DataSaveResult, InMemoryDataSource hedron[data] DATA.md, DATA_SOURCE.md, data-apps
LineChart, AreaChart, BarChart, ScatterChart, MatplotlibChart, PlotlyChart, AltairChart hedron[charts] (Stable package; first-party/Matplotlib Supported, Plotly/Altair Experimental) CHART.md

SQLAlchemy adapter: hedron_data.sqlalchemy_source.SQLAlchemyDataSource — see data-apps (not a top-level hedron re-export).

Cache, state, color, assets

Export Primary docs
cache_component, cache_data, invalidate_tags CACHE.md
SessionState, session_state STATE.md
ColorMode, ColorModeToggle, apply_color_mode_cookie, read_color_mode_preference, resolve_color_mode, resolved_theme_from_request COLORMODE.md, THEME.md
compile_css, styles_from_manifest, StyleSymbols THEME.md, CONFIGURATION.md
compile_palette, contrast_diagnostics, contrast_ratio THEME.md, AUTHORING_LOOP.md
get_icon, list_icons, register_icon, register_first_party_icons, trusted_svg Component / theme docs; icons live in hedron_core

Async helpers and misc

Export Primary docs
await_if_needed, gather, run_sync Autodoc; sync/async boundary in handlers
addressable, Field, Model, Props, FormModel, Component, render, RenderContext, RenderMode, RenderResult COMPONENT.md, FIELD.md, MODELS.md, RENDERING.md
html Tag helpers used in guides
Markdown, highlight_code, process_image, validate_email_address CONTENT.md
OAuthHelper, create_oauth_client AUTH.md
__version__ Package metadata

Phase 0.13 surfaces (hedron_core / hedron.tracing)

Symbol Primary docs
PrepareContext, PartialFailurePolicy, prepare_tree PREPARE.md
SecurityAuditSink, set_security_audit_sink, emit_security_audit, … AUDIT.md
configure_tracing, span, TraceConfig TRACING.md

Gaps policy

Every name in hedron.__all__ should appear in a table on this page. If a symbol has no deep contract page, treat the component page, guide, or EXCEPTIONS.md as normative, and open an issue when a signature or error matrix is missing. Prefer expanding Autodoc members over duplicating narrative.

Intentionally thin (Autodoc / guide / component page only): icon helpers (get_icon, list_icons, register_icon, trusted_svg), most UI component props (component pages), and FastAPI-only builtin wrappers covered by BUILT_INS.md.