Incant.Admin (incant v0.1.0)

Copy Markdown

Defines the root Incant admin surface for an application.

Admin modules wire resources, dashboards, plugins, and global options together.

defmodule MyApp.Admin do
  use Incant.Admin,
    repo: MyApp.Repo,
    theme: MyApp.Admin.Themes.Default,
    policy: MyApp.Admin.Policy,
    actor_assign: :current_scope

  resource MyApp.Admin.Resources.Product
  dashboard MyApp.Admin.Dashboards.Operations
end

Summary

Functions

Returns resolved dashboard surfaces.

Returns resolved dataset surfaces.

Returns a transport-safe contract for an admin module or metadata struct.

Returns resolved resource surfaces.

Returns all resolved admin surfaces in declaration order.

Functions

dashboard(module)

(macro)

dashboards(admin_or_metadata)

Returns resolved dashboard surfaces.

dataset(module)

(macro)

datasets(admin_or_metadata)

Returns resolved dataset surfaces.

describe(admin_or_metadata)

Returns a transport-safe contract for an admin module or metadata struct.

expose(schema, opts \\ [])

(macro)

plugin(module)

(macro)

resource(module)

(macro)

resources(admin_or_metadata)

Returns resolved resource surfaces.

surfaces(admin_or_metadata)

Returns all resolved admin surfaces in declaration order.