Packages
ash_admin
0.9.5
1.1.0
1.0.0-rc.0
0.14.0
0.13.26
0.13.25
0.13.24
0.13.23
0.13.22
0.13.21
0.13.20
0.13.19
0.13.18
0.13.17
0.13.16
0.13.15
0.13.14
0.13.13
0.13.12
0.13.11
0.13.10
0.13.9
0.13.8
0.13.7
0.13.6
0.13.5
0.13.4
0.13.3
0.13.2
0.13.1
0.13.0
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
0.11.11
0.11.10
0.11.9
0.11.8
0.11.7
0.11.6
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.12
0.10.11
0.10.10
retired
0.10.10-rc.1
0.10.10-rc.0
0.10.9
0.10.8
0.10.7
0.10.6
0.10.5
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.8
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0-rc.2
0.6.0-rc.1
0.6.0-rc.0
0.5.2
0.5.1-rc.0
0.5.0
0.4.5-rc.0
0.4.4
0.4.2
0.4.0
0.3.0-rc.0
0.2.22
0.2.21
0.2.20
0.2.19
0.2.18
0.2.17
0.2.16-rc.1
0.2.16-rc.0
0.2.15
0.2.14
0.2.13
0.2.12
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.1
0.1.6
0.1.5
0.1.3
0.1.2
0.1.0
A super-admin UI for Ash Framework, built with Phoenix LiveView.
Current section
Files
Jump to
Current section
Files
lib/ash_admin/api.ex
defmodule AshAdmin.Api do
@admin %Spark.Dsl.Section{
describe: "Configure the admin dashboard for a given API.",
name: :admin,
schema: [
name: [
type: :string,
doc: "The name of the API in the dashboard. Will be derived if not set."
],
show?: [
type: :boolean,
default: false,
doc:
"Whether or not this API and its resources should be included in the admin dashboard."
],
default_resource_page: [
type: {:in, [:schema, :primary_read]},
default: :schema,
doc:
"Set the default page for the resource to be the primary read action or the resource schema. Schema is the default for backwards compatibility, if a resource doesn't have a primary read action it will fallback to the schema view."
],
resource_group_labels: [
type: :keyword_list,
default: [],
doc:
"Humanized names for each resource group to appear in the admin area. These will be used as labels in the top navigation dropdown. If a key for a group does not appear in this mapping, the label will not be rendered."
]
]
}
use Spark.Dsl.Extension, sections: [@admin]
@moduledoc """
An API extension to alter the behavior of an API in the admin UI.
Table of Contents:
#{Spark.Dsl.Extension.doc_index([@admin])}
DSL Docs:
#{Spark.Dsl.Extension.doc([@admin])}
"""
def name(api) do
Spark.Dsl.Extension.get_opt(api, [:admin], :name, nil, true) || default_name(api)
end
def show?(api) do
Spark.Dsl.Extension.get_opt(api, [:admin], :show?, false, true)
end
def default_resource_page(api) do
Spark.Dsl.Extension.get_opt(api, [:admin], :default_resource_page, :schema, true)
end
def resource_group_labels(api) do
Spark.Dsl.Extension.get_opt(api, [:admin], :resource_group_labels, [], true)
end
defp default_name(api) do
split = api |> Module.split()
case List.last(split) do
"Api" ->
Enum.at(split, -2)
last ->
last
end
end
end