API Reference Pax v#0.0.1-dev.20251023

Pax is a toolkit for building CRUD interfaces in Phoenix LiveView applications.

This module is used to define an admin for your application.

Provides functionality for mounting Pax.Admin's in your router.

Handles serving static assets for Pax, including Pax.Admin.

Pax.Config is a module for defining configuration structs and functions for Pax. It has two main concerns

A field type is a module that implements the Pax.Field.Type behaviour. It is responsible for rendering a Pax.Field and other related behavior

Pax.Interface enables the creation of CRUD interfaces based on Phoenix.LiveView.

Configuration for a Pax Interface.

Pax.Interface.Plugin is a behaviour for defining plugins that can be used with Pax.Interface.

Pax.Plugin is a behaviour for defining plugins that can be used with Pax.Interface or Pax.Admin. This is the base behavior that all Plugins must implement. However, most plugins will use Pax.Interface.Plugin or use Pax.Admin.Plugin instead of implementing this behaviour directly.

Renders fieldsets for the detail view of a Pax.Interface. Fieldsets are a way to organize a detail page, by breaking it into sections, and allowing fields to be grouped together on the same horizontal line.

Renders a list of fields for the detail view of a Pax.Interface. The display is of a simple two column list, with the field name on the left and the field value on the right.

Renders a table for the index view of a Pax.Interface.

Utilities for inflecting the plural form of singular nouns. This isn't trying to be perfect, just good enough.

Watches and rebuilds Pax assets (JS and CSS) in dev mode.