# PhoenixFilament v0.1.0 - Table of Contents

Rapid application development framework for Phoenix — declarative admin panels from Ecto schemas

## Pages

- Guides
  - [Getting Started with PhoenixFilament](getting-started.md)
  - [Resource Customization](resources.md)
  - [Plugin Development](plugins.md)
  - [Theming Guide](theming.md)

## Modules

- [PhoenixFilament.Column](PhoenixFilament.Column.md): A plain data struct representing a table column declaration.
- [PhoenixFilament.Components](PhoenixFilament.Components.md): Imports all PhoenixFilament UI components.
- [PhoenixFilament.Field](PhoenixFilament.Field.md): A plain data struct representing a form field declaration.
- [PhoenixFilament.Naming](PhoenixFilament.Naming.md): Shared naming utilities for humanizing atoms into user-facing labels.

- [PhoenixFilament.Panel.Router](PhoenixFilament.Panel.Router.md): Provides the `phoenix_filament_panel/2` router macro.
- [PhoenixFilament.Resource.Authorize](PhoenixFilament.Resource.Authorize.md): Wraps authorization checks around Resource CRUD operations.
- [PhoenixFilament.Resource.CRUD](PhoenixFilament.Resource.CRUD.md): Pure CRUD operations against an Ecto repo.
- [PhoenixFilament.Resource.Lifecycle](PhoenixFilament.Resource.Lifecycle.md): LiveView lifecycle management for Resource CRUD pages.
- [PhoenixFilament.Resource.Renderer](PhoenixFilament.Resource.Renderer.md): Renders Resource CRUD pages based on live_action.
- [PhoenixFilament.Schema](PhoenixFilament.Schema.md): Introspects Ecto schemas at runtime to extract field metadata,
associations, embeds, and virtual fields.

- Core
  - [PhoenixFilament](PhoenixFilament.md): Rapid application development framework for Phoenix.
  - [PhoenixFilament.Panel](PhoenixFilament.Panel.md): Declares an admin panel that wraps Resources in a shell with sidebar navigation,
breadcrumbs, responsive layout, and a dashboard.
  - [PhoenixFilament.Resource](PhoenixFilament.Resource.md): Declares an admin resource backed by an Ecto schema.

- Components
  - [PhoenixFilament.Components.Badge](PhoenixFilament.Components.Badge.md): Badge component with color variants. Styled with daisyUI 5.

  - [PhoenixFilament.Components.Button](PhoenixFilament.Components.Button.md): Button component with variant, size, loading, and disabled support.
Styled with daisyUI 5 semantic classes.

  - [PhoenixFilament.Components.Card](PhoenixFilament.Components.Card.md): Card component with hybrid slot strategy.
Simple mode: pass `title` attr. Complex mode: use named slots.

  - [PhoenixFilament.Components.FieldRenderer](PhoenixFilament.Components.FieldRenderer.md): Dispatches %PhoenixFilament.Field{} structs to input components.
Bridges Phase 1 data structures to Phase 2 UI components.

  - [PhoenixFilament.Components.Icon](PhoenixFilament.Components.Icon.md): Icon component that renders Heroicons using CSS class names.
  - [PhoenixFilament.Components.Input](PhoenixFilament.Components.Input.md): Form input components styled with daisyUI 5.
  - [PhoenixFilament.Components.Modal](PhoenixFilament.Components.Modal.md): Modal dialog component using daisyUI modal classes.
Uses `show` boolean and `on_cancel` event for control.
Designed for LiveView 1.1 portals (Phase 6 integration).

  - [PhoenixFilament.Components.Theme](PhoenixFilament.Components.Theme.md): Theme utilities for daisyUI 5 CSS variable theming.

- Form Builder
  - [PhoenixFilament.Form.Columns](PhoenixFilament.Form.Columns.md): Arranges form fields in a CSS grid with N columns.
  - [PhoenixFilament.Form.FormBuilder](PhoenixFilament.Form.FormBuilder.md): Renders a complete form from a form schema.
  - [PhoenixFilament.Form.Hooks](PhoenixFilament.Form.Hooks.md): JavaScript hooks for PhoenixFilament Form Builder.
  - [PhoenixFilament.Form.Section](PhoenixFilament.Form.Section.md): Groups form fields under a labeled heading.
  - [PhoenixFilament.Form.Visibility](PhoenixFilament.Form.Visibility.md): Helpers for rendering visible_when conditional visibility.

- Table Builder
  - [PhoenixFilament.Table.Action](PhoenixFilament.Table.Action.md): Represents a row action in a table (view, edit, delete, or custom).

  - [PhoenixFilament.Table.Filter](PhoenixFilament.Table.Filter.md): Represents a table filter declaration. Types: :select, :boolean, :date_range.
  - [PhoenixFilament.Table.Params](PhoenixFilament.Table.Params.md): Parses and encodes URL query params for table state.
  - [PhoenixFilament.Table.QueryBuilder](PhoenixFilament.Table.QueryBuilder.md): Composes Ecto queries from table params.
Pure functions — no DB calls, no LiveView dependency.

  - [PhoenixFilament.Table.TableLive](PhoenixFilament.Table.TableLive.md): LiveComponent that renders a complete data table.
  - [PhoenixFilament.Table.TableRenderer](PhoenixFilament.Table.TableRenderer.md): Stateless function components for table UI elements.

- Widgets
  - [PhoenixFilament.Widget.Chart](PhoenixFilament.Widget.Chart.md): A widget that displays a Chart.js chart.

  - [PhoenixFilament.Widget.Custom](PhoenixFilament.Widget.Custom.md): A free-form widget for custom content on the dashboard.
  - [PhoenixFilament.Widget.StatsOverview](PhoenixFilament.Widget.StatsOverview.md): A widget that displays statistics as cards.
  - [PhoenixFilament.Widget.Table](PhoenixFilament.Widget.Table.md): A widget that displays a simple read-only table on the dashboard.

- Plugin System
  - [PhoenixFilament.Plugin](PhoenixFilament.Plugin.md): Plugin behaviour for extending PhoenixFilament panels.

- Exceptions
  - [PhoenixFilament.Resource.UnauthorizedError](PhoenixFilament.Resource.UnauthorizedError.md)

## Mix Tasks

- Mix Tasks
  - [mix phx_filament.gen.resource](Mix.Tasks.PhxFilament.Gen.Resource.md): Generates a PhoenixFilament resource for an Ecto schema.
  - [mix phx_filament.install](Mix.Tasks.PhxFilament.Install.md): Installs PhoenixFilament admin panel in your Phoenix app.