You got your Ash in my Backpex. You got your Backpex in my Ash.
An integration library that brings together Ash Framework's powerful resource system with Backpex's admin interface capabilities. This library provides a clean DSL for creating admin interfaces directly from your Ash resources.
Backpex itself is pre-1.0 so expect the API to change in a breaking way! Also, it cannot currently take full advantage of Ash authorization policies. For now I would only recommend using it in a high-trust environment such as internal tooling.
This is a partial implementation - feel free to open a github issue to request additional features or submit a PR if you're into that kind of thing ;)
Add ash_backpex to your list of dependencies in mix.exs:
def deps do
[
{:ash_backpex, "~> 0.0.13"}
]
end# myapp_web/live/admin/post_live.ex
defmodule MyAppWeb.Live.Admin.PostLive do
use AshBackpex.LiveResource
backpex do
resource MyApp.Blog.Post
load [:author]
layout &MyAppWeb.Layouts.admin/1
fields do
field :title
field :published_at
field :author do
display_field(:name)
live_resource(MyAppWeb.Live.Admin.AuthorLive)
end
end
end
endAshBackpex automatically maps Ash types to Backpex field modules, but you can customize these mappings globally or per-application.
# config/config.exs
# Global config (applies to all apps using AshBackpex)
config :ash_backpex,
field_type_mappings: %{
MyApp.Types.Money => Backpex.Fields.Currency,
MyApp.Types.RichText => Backpex.Fields.Textarea
}
# Or use a function for conditional logic
config :ash_backpex,
field_type_mappings: fn type, constraints ->
case type do
MyApp.Types.Money -> Backpex.Fields.Currency
_ -> nil # Fall back to default
end
endField type resolution follows this order:
- Explicit
moduleoption in the field DSL - App-scoped config (
config :my_app, AshBackpex, ...) - Global config (
config :ash_backpex, ...) - Default Ash type mappings
See AshBackpex.LiveResource module docs for more examples and details.
Building this little integration seemed easier than any alternatives to get the admin I wanted, which is a credit to the great work of the Backpex team!