Athanor

Hex.pmHexdocs.pmLicense: MIT

Host-agnostic page builder library for Phoenix LiveView apps.

Athanor gives you a turn-key drag-edit page editor — canvas, components panel, configure panel, viewport switcher, formatting tab — that you mount inside your own LiveView with a use macro. You declare your components as plain Elixir modules and Athanor handles the rest: serialization, render dispatch, form generation, edit chrome.

It is not an admin CMS. It does not ship a database, an HTTP endpoint, or an opinion about where pages get stored. It hands you a content tree (%{"content" => [%{"id" => _, "type" => _, "props" => _}, ...]}) and trusts your app to load/save it.

Inspired by Puck.js (React) — Athanor brings its resolveFields/resolveData mental model to the BEAM.

Status: early — 0.x. Public API may shift between minor versions. See CHANGELOG.md for what changed. Production-used by Amplify.

Install

def deps do
[
{:athanor, "~> 0.1"}
]
end

If you use Tailwind v4, point @source at Athanor so utility classes in the editor chrome get scanned:

/* assets/css/app.css */
@source "../../deps/athanor/lib/**/*.*ex";

60-second tour

1. Declare a component

defmodule MyApp.Components.Hero do
use Athanor.Component
use Phoenix.Component
@impl Athanor.Component
def metadata do
%{type: "hero", label: "Hero", icon: "fa-image", category: :content}
end
@impl Athanor.Component
def fields do
[
{"title", :text, label: "Title", placeholder: "Headline"},
{"subtitle", :textarea, label: "Subtitle"},
{"cta_label", :text, label: "Button label"}
]
end
@impl Athanor.Component
def render(:live, node, _ctx) do
assigns = node["props"]
~H"""
<section class="py-24 text-center">
<h1 class="text-5xl font-bold">{@title}</h1>
<p class="mt-4 text-lg text-base-content/70">{@subtitle}</p>
<button class="btn btn-primary mt-8">{@cta_label}</button>
</section>
"""
end
end

2. Register it

# config/config.exs
config :athanor, components: [MyApp.Components.Hero]

3. Mount the editor

defmodule MyAppWeb.PageEditorLive do
use Athanor.Editor.Live
@impl Athanor.Editor
def load(%{"id" => id}, _session, socket) do
page = MyApp.Pages.get_page!(id)
{:ok,
%{
content: page.content, # %{"content" => [...]}
metadata: page.metadata, # %{"title" => "...", ...}
ctx_assigns: %{account_id: socket.assigns.current_user.account_id}
}}
end
@impl Athanor.Editor
def save(socket, %{content: content, metadata: metadata}) do
page = socket.assigns.page
MyApp.Pages.update_page(page, %{content: content, metadata: metadata})
end
end

Add the route:

live "/admin/pages/:id/edit", MyAppWeb.PageEditorLive

That's the whole integration. Athanor renders the canvas, the components palette, the config panel with auto-generated forms (one input per fields/0 entry), the formatting tab (alignment / colors / padding / margin / borders), a viewport switcher, and a Save button wired to your save/2.

Concepts

ModuleRole
Athanor.TreePure-data manipulation of the content tree (insert, move, remove, find)
Athanor.ComponentBehaviour + use macro for declaring components
Athanor.RegistryRuntime lookup of components by "type" string
Athanor.RendererDispatches each node to its component's render/3
Athanor.CtxRender/edit context (account_id, brand_id, edit_mode?, etc.)
Athanor.Editor.Liveuse macro that injects the LiveView
Athanor.EditorFunction components (canvas, components_panel, config_panel, shell) for custom layouts
Athanor.FieldsAuto-renders a component's fields/0 schema into form inputs
Athanor.FieldBehaviour-style contract for custom field LiveComponents
Athanor.AutoEditorFormLiveComponent wrapping the auto-form plumbing

Field types

fields/0 returns a list of {key, type, opts} tuples. Built-in types:

Add if: fn props -> boolean end to any field to conditionally show/hide it.

Dynamic fields & data

Override resolve_fields/2 to compute the schema at render time — e.g. to add fields based on the current props["variant"]:

def resolve_fields(props, _ctx) do
fields() ++
case props["mode"] do
"advanced" -> [{"target", :text, label: "Target URL"}]
_ -> []
end
end

Override resolve_data/2 to compute derived props after every change — e.g. to look up display data from an id:

def resolve_data(_old, new) do
case new["product_id"] do
nil -> new
id -> Map.put(new, "product_name", MyApp.Products.get_name(id))
end
end

Same shapes as Puck.js's resolveFields / resolveData.

Page-level settings

Title, description, slug, social image, anything that lives outside the component tree — declare it as a regular Athanor.Component and pass it as :page_settings_component to your editor mount. It auto-renders at the top of the sidebar and round-trips through metadata in your save handler.

What Athanor does not do

Documentation

Full API documentation lives on Hexdocs.

Why "Athanor"?

The athanor was an alchemist's slow-burning furnace, used for transmutations that needed a constant, even heat over long periods. Page builders feel a lot like that.

License

MIT © Zarar Siddiqi