# filament v0.2.1 - API Reference

## Modules

- [Filament](Filament.md): Filament — a process-aware UI framework for Phoenix LiveView.
- [Filament.LiveComponent](Filament.LiveComponent.md): Phoenix LiveComponent adapter for embedding a Filament component inside a regular
Phoenix LiveView.
- [Filament.SigilFFormatter](Filament.SigilFFormatter.md): Format `~F` templates via `mix format`.
- [Filament.Test](Filament.Test.md): Rung 2 test API for Filament components.
- [Filament.Test.LiveView](Filament.Test.LiveView.md): Rung 4 test helpers for Filament components running in a full LiveView.
- [Filament.Test.LiveView.Helpers](Filament.Test.LiveView.Helpers.md): Helper functions for Rung 4 integration tests.
- [Filament.Test.Stub](Filament.Test.Stub.md): Convenience API for creating and driving observable stubs in tests.

- Components
  - [Filament.Component](Filament.Component.md): Behaviour and macro for defining Filament components.
  - [Filament.Defcomponent](Filament.Defcomponent.md): The defcomponent macro implementation.
  - [Filament.SigilF](Filament.SigilF.md): Implements the ~F sigil for compiling HEEx-style templates into VNode IR.

- Hooks
  - [Filament.Hooks](Filament.Hooks.md): Hooks for Filament components.

- Observables
  - [Filament.Observable](Filament.Observable.md): Behaviour for observable GenServer processes.
  - [Filament.Observable.GenServer](Filament.Observable.GenServer.md): Macro that makes a GenServer observable by Filament components.

- LiveView
  - [Filament.LiveView](Filament.LiveView.md): Phoenix LiveView adapter for Filament components.

- Exceptions
  - [Filament.ReconcilerError](Filament.ReconcilerError.md): Exception raised when reconciliation fails.

  - [Filament.VNode.Error](Filament.VNode.Error.md): Exception raised when VNode validation fails