# Incant v0.1.1 - Table of Contents

> Elixir/Phoenix admin framework for resources, dashboards, datasets, actions, authorization, and service-owned remote admin surfaces.

## Pages

- [Incant](readme.md)
- [Changelog](changelog.md)

- Introduction
  - [Getting Started](getting-started.md)
  - [Library Mode](library-mode.md)
  - [Standalone Mode](standalone-mode.md)
  - [Project Structure](project-structure.md)

- Features
  - [Resources](resources.md)
  - [Dashboards](dashboards.md)
  - [Datasets](datasets.md)
  - [Authorization](authorization.md)
  - [Themes and LiveView](themes-and-liveview.md)
  - [Distributed Services](distributed-services.md)

- Deployment
  - [Standalone Deployment](standalone-deployment.md)

- Reference
  - [Configuration](configuration.md)
  - [Admin HTTP API](admin-http-api.md)

- Internals
  - [Architecture](architecture.md)

## Modules

- [Incant.ActionResult.Download](Incant.ActionResult.Download.md): Expose a prepared download.
- [Incant.ActionResult.Error](Incant.ActionResult.Error.md): A user-visible action error.
- [Incant.ActionResult.Job](Incant.ActionResult.Job.md): Expose a background job created by an action.
- [Incant.ActionResult.Navigate](Incant.ActionResult.Navigate.md): Navigate to a route.
- [Incant.ActionResult.OpenSurface](Incant.ActionResult.OpenSurface.md): Open another semantic Incant surface.
- [Incant.ActionResult.Refresh](Incant.ActionResult.Refresh.md): Refresh one or more semantic targets.
- [Incant.ActionResult.Reveal](Incant.ActionResult.Reveal.md): Reveal a one-time value (such as a newly created secret) to the user.
- [Incant.ActionResult.Toast](Incant.ActionResult.Toast.md): A user-visible notification.
- [Incant.Admin.Contract](Incant.Admin.Contract.md): Transport-safe description of an Incant admin surface.
- [Incant.Admin.Metadata](Incant.Admin.Metadata.md): Compiled metadata for an Incant admin surface.

- [Incant.Dashboard.Column](Incant.Dashboard.Column.md): Metadata for a dashboard table widget column.

- [Incant.Dashboard.Metadata](Incant.Dashboard.Metadata.md): Compiled metadata for an Incant dashboard.

- [Incant.Dashboard.Variable](Incant.Dashboard.Variable.md): Metadata for a dashboard variable.

- [Incant.Dashboard.Widget](Incant.Dashboard.Widget.md): Metadata for a dashboard widget.

- [Incant.Dataset.Dimension](Incant.Dataset.Dimension.md): Metadata for an analytical dataset dimension.

- [Incant.Dataset.Drilldown](Incant.Dataset.Drilldown.md): Metadata for a table drilldown path in an analytical dataset.

- [Incant.Dataset.Filter](Incant.Dataset.Filter.md): Metadata for an analytical dataset filter.

- [Incant.Dataset.Metadata](Incant.Dataset.Metadata.md): Compiled metadata for an Incant analytical dataset.

- [Incant.Dataset.Metric](Incant.Dataset.Metric.md): Metadata for an analytical dataset metric.

- [Incant.Dataset.Table](Incant.Dataset.Table.md): Metadata for the default table view of an analytical dataset.

- [Incant.Filters.Boolean](Incant.Filters.Boolean.md): Boolean filter implementation.

- [Incant.Filters.DateRange](Incant.Filters.DateRange.md): Date range filter implementation.

- [Incant.Filters.MultiSelect](Incant.Filters.MultiSelect.md): Multi-select filter implementation.

- [Incant.Filters.Select](Incant.Filters.Select.md): Single-select filter implementation.

- [Incant.Filters.Text](Incant.Filters.Text.md): Text filter implementation.

- [Incant.Form.Field](Incant.Form.Field.md): Metadata for a resource form field.

- [Incant.Live.Components](Incant.Live.Components.md): Shared Incant LiveView components for admin surfaces.

- [Incant.Naming](Incant.Naming.md): Configurable naming for inferred Incant labels and titles.
- [Incant.Options](Incant.Options.md): Normalizes option declarations into portable label/value maps.

- [Incant.Resource.Metadata](Incant.Resource.Metadata.md): Compiled metadata for an Incant resource.

- [Incant.Sensitive](Incant.Sensitive.md): Helpers for secret/sensitive Incant metadata.
- [Incant.Service.Describe](Incant.Service.Describe.md): Request to describe an Incant service.
- [Incant.Service.Entry](Incant.Service.Entry.md): A discovered Incant service endpoint and its loaded admin contract.
- [Incant.Service.Index](Incant.Service.Index.md): Request to index an Incant surface.
- [Incant.Service.Read](Incant.Service.Read.md): Request to read one item from an Incant surface.
- [Incant.Service.RunAction](Incant.Service.RunAction.md): Request to run an Incant surface action.
- [Incant.Service.RunWidget](Incant.Service.RunWidget.md): Request to run an Incant dashboard widget query.
- [Incant.Session.Local](Incant.Session.Local.md): Local BEAM-backed Incant admin session.
- [Incant.Table](Incant.Table.md): Metadata for a resource table.

- [Incant.Table.Action](Incant.Table.Action.md): Metadata for a table action.
- [Incant.Table.Column](Incant.Table.Column.md): Metadata for a resource table column.

- [Incant.Table.Filter](Incant.Table.Filter.md): Metadata for a resource table filter.

- [Incant.Tabular](Incant.Tabular.md): Normalizes common tabular data shapes into rows, columns, and metadata.

- [Incant.Theme.Metadata](Incant.Theme.Metadata.md): Compiled metadata for an Incant theme.

- [Incant.UI.Actions.Action](Incant.UI.Actions.Action.md): Semantic user-triggered command.

- [Incant.UI.Actions.Group](Incant.UI.Actions.Group.md): Group of related UI actions.

- [Incant.UI.Actions.Menu](Incant.UI.Actions.Menu.md): Action menu model for adapters that render compact command surfaces.

- [Incant.UI.Config](Incant.UI.Config.md): Reads Incant UI configuration.
- [Incant.UI.Controls](Incant.UI.Controls.md): Builders for semantic Incant UI controls.

- [Incant.UI.Controls.Boolean](Incant.UI.Controls.Boolean.md): Semantic Boolean control.

- [Incant.UI.Controls.Combobox](Incant.UI.Controls.Combobox.md): Semantic Combobox control.

- [Incant.UI.Controls.Date](Incant.UI.Controls.Date.md): Semantic Date control.

- [Incant.UI.Controls.DateRange](Incant.UI.Controls.DateRange.md): Semantic DateRange control.

- [Incant.UI.Controls.Hidden](Incant.UI.Controls.Hidden.md): Semantic Hidden control.

- [Incant.UI.Controls.MultiSelect](Incant.UI.Controls.MultiSelect.md): Semantic MultiSelect control.

- [Incant.UI.Controls.Number](Incant.UI.Controls.Number.md): Semantic Number control.

- [Incant.UI.Controls.Relation](Incant.UI.Controls.Relation.md): Semantic Relation control.

- [Incant.UI.Controls.Select](Incant.UI.Controls.Select.md): Semantic Select control.

- [Incant.UI.Controls.Text](Incant.UI.Controls.Text.md): Semantic Text control.

- [Incant.UI.Env](Incant.UI.Env.md): Runtime environment passed to UI adapters.

- [Incant.UI.Event](Incant.UI.Event.md): Normalized event envelope shared by Incant UI adapters.

- [Incant.UI.FilterState](Incant.UI.FilterState.md): Typed filter state normalized from portable URL and service filter values.

- [Incant.UI.FilterState.Condition](Incant.UI.FilterState.Condition.md): An applied filter condition.
- [Incant.UI.FilterState.Definition](Incant.UI.FilterState.Definition.md): A filter field available to the current surface.
- [Incant.UI.Focus](Incant.UI.Focus.md): Focus intent for adapters.
- [Incant.UI.Regions.Chart](Incant.UI.Regions.Chart.md): Semantic chart specification for dashboard widgets.

- [Incant.UI.Regions.FilterBar](Incant.UI.Regions.FilterBar.md): Search and filter controls for a resource or dashboard variables surface.

- [Incant.UI.Regions.Form](Incant.UI.Regions.Form.md): Resource form model.

- [Incant.UI.Regions.Header](Incant.UI.Regions.Header.md): Semantic header metadata for a surface.

- [Incant.UI.Regions.Inspector](Incant.UI.Regions.Inspector.md): Record detail/inspector model.

- [Incant.UI.Regions.Nav](Incant.UI.Regions.Nav.md): Admin navigation region.

- [Incant.UI.Regions.Table](Incant.UI.Regions.Table.md): Resource table model.

- [Incant.UI.Regions.WidgetGrid](Incant.UI.Regions.WidgetGrid.md): Dashboard widget grid model.

- [Incant.UI.Surfaces.Dashboard](Incant.UI.Surfaces.Dashboard.md): Dashboard surface model.

- [Incant.UI.Surfaces.DatasetIndex](Incant.UI.Surfaces.DatasetIndex.md): Dataset table surface.

- [Incant.UI.Surfaces.Empty](Incant.UI.Surfaces.Empty.md): Empty or unauthorized admin surface.

- [Incant.UI.Surfaces.ResourceIndex](Incant.UI.Surfaces.ResourceIndex.md): Resource index/list surface model.

- [Incant.UI.Surfaces.ServiceIndex](Incant.UI.Surfaces.ServiceIndex.md): Incant registry landing surface listing discovered services.

- [Incant.UI.Value](Incant.UI.Value.md): Display value helper for UI nodes.

- [Incant.Web.API](Incant.Web.API.md): Strict JSON HTTP API for the standalone Incant admin release.
- [Incant.Web.API.ActionPayload](Incant.Web.API.ActionPayload.md): Action invocation payload carried inside `Incant.Web.API.ActionRunRequest`.
- [Incant.Web.API.ActionRunRequest](Incant.Web.API.ActionRunRequest.md): Typed request contract for running Incant actions over the standalone HTTP API.
- [Incant.Web.API.QueryRequest](Incant.Web.API.QueryRequest.md): Typed request contract for standalone Incant resource queries.
- [Incant.Web.HealthPlug](Incant.Web.HealthPlug.md): Minimal health endpoint for standalone Incant deployments.

- [Incant.Web.Router](Incant.Web.Router.md): HTTP router for the standalone Incant admin release.

- Core
  - [Incant](Incant.md): Code-first admin, content, analytics, and operations surfaces for Phoenix applications.
  - [Incant.Admin](Incant.Admin.md): Defines the root Incant admin surface for an application.
  - [Incant.Dashboard](Incant.Dashboard.md): Defines a code-first dashboard with variables and widgets.
  - [Incant.Dataset](Incant.Dataset.md): Defines a code-first analytical dataset.
  - [Incant.Resource](Incant.Resource.md): Defines a code-first admin resource.
  - [Incant.Session](Incant.Session.md): Unified Incant admin session interface.
  - [Incant.Surface](Incant.Surface.md): Common envelope for top-level Incant admin surfaces.

- Data and Forms
  - [Incant.DataSource](Incant.DataSource.md): Behaviour for non-Ecto and analytical data sources.

  - [Incant.Ecto](Incant.Ecto.md): Small Ecto helpers for application-owned Incant resource queries.
  - [Incant.Form](Incant.Form.md): Metadata for resource create/edit forms.

  - [Incant.Forms](Incant.Forms.md): Helpers for resolving resource form fields and changesets.

  - [Incant.Query](Incant.Query.md): Normalized query request passed to Incant data sources.

  - [Incant.Result](Incant.Result.md): Normalized result returned by Incant data sources.

- Actions and Policy
  - [Incant.ActionResult](Incant.ActionResult.md): Semantic results returned by Incant actions.
  - [Incant.Filter](Incant.Filter.md): Behaviour and dispatcher for Incant table filters.

  - [Incant.Policy](Incant.Policy.md): Behaviour for Incant admin authorization policies.

- Distributed Services
  - [Incant.Service](Incant.Service.md): Behaviour for service-owned Incant admin surfaces.
  - [Incant.Service.Client](Incant.Service.Client.md): Client-side handle for an Incant service exposed through SafeRPC.
  - [Incant.Service.Registry](Incant.Service.Registry.md): Runtime registry for remotely discovered Incant services.
  - [Incant.Service.RegistryServer](Incant.Service.RegistryServer.md): Supervised process for a central Incant service registry.
  - [Incant.Service.Session](Incant.Service.Session.md): Admin UI session for one discovered Incant service entry.

- UI
  - [Incant.Design](Incant.Design.md): Design-token names and CSS defaults used by Incant renderers.
  - [Incant.Theme](Incant.Theme.md): Defines Tailwind 4 and CSS-variable-first theme metadata.
  - [Incant.UI](Incant.UI.md): Semantic admin UI layer used by Incant render adapters.
  - [Incant.UI.Adapter](Incant.UI.Adapter.md): Behaviour for Incant UI render adapters.
  - [Incant.UI.Adapters.LiveView](Incant.UI.Adapters.LiveView.md): Default Incant UI adapter backed by Phoenix LiveView components.

  - [Incant.UI.Document](Incant.UI.Document.md): A semantic description of the current Incant admin screen.

- Phoenix
  - [Incant.Live.Admin](Incant.Live.Admin.md): Generic LiveView renderer for an Incant admin surface.

  - [Incant.Router](Incant.Router.md): Router helpers for mounting Incant admin surfaces.

  - [Incant.Web.Endpoint](Incant.Web.Endpoint.md): Phoenix endpoint for standalone Incant deployments.

## Mix Tasks

- [mix incant.install](Mix.Tasks.Incant.Install.md): Generates starter Incant admin files and patches Phoenix setup when possible.