View Source ExTeal.Resource behaviour (ExTeal v0.28.1)

When used, includes all aspects of the functionality required to manage the resource.

Example usage in a ExTeal Resource:

defmodule ExampleWeb.ExTeal.BlogResource do
  use ExTeal.Resource

  alias Example.Content.Blog

  def resource, do: Blog

  def title, do: "blog"
end

Summary

Types

attributes()

id()

indexed_resource()

orderable_key()

orderable_option()

params()

pivot_resource()

record()

records()

t()

validation_errors()

Callbacks

cards(t)

Provide a list of action cards to render them above the resource index

default_order()

Override the default ordering of the index.

hide_from_nav()

Hide the Resource from the sidenav in the user interface, defaults to false.

nav_group(t)

If you would like to separate resources into different sidebar groups, you can override the nav_group/1 function on the resource.

navigate_to(arg1, t, indexed_resource)

Override the detail or edit link for a resource on the resource index.

skip_sanitize()

Allows skipping sanitize for all fields on a resource

sortable_by()

Specifies the field to use as the basis for a drag and drop interface for the collection.

Functions

map_to_json(resources, conn)

to_json(resource, conn)

Types

attributes()

@type attributes() :: map()

id()

@type id() :: String.t() | integer()

indexed_resource()

@type indexed_resource() :: struct() | pivot_resource()

orderable_key()

@type orderable_key() ::
  :asc
  | :asc_nulls_first
  | :asc_nulls_last
  | :desc
  | :desc_nulls_first
  | :desc_nulls_last

orderable_option()

@type orderable_option() :: {orderable_key(), atom()}

params()

@type params() :: map()

pivot_resource()

@type pivot_resource() :: %{_pivot: struct(), _row: struct(), pivot: true}

record()

@type record() :: struct()

records()

@type records() :: [record()]

t()

@type t() :: module()

validation_errors()

@type validation_errors() :: Ecto.Changeset.t() | keyword()

Callbacks

cards(t)

@callback cards(Plug.Conn.t()) :: [module()]

Provide a list of action cards to render them above the resource index

default_order()

@callback default_order() :: [orderable_option()]

Override the default ordering of the index.

hide_from_nav()

@callback hide_from_nav() :: boolean()

Hide the Resource from the sidenav in the user interface, defaults to false.

nav_group(t)

@callback nav_group(Plug.Conn.t()) :: String.t() | nil

If you would like to separate resources into different sidebar groups, you can override the nav_group/1 function on the resource.

navigate_to(arg1, t, indexed_resource)

@callback navigate_to(:detail | :edit, Plug.Conn.t(), indexed_resource()) :: %{
  resource_name: String.t(),
  resource_id: String.t()
}

Override the detail or edit link for a resource on the resource index.

When defining this callback, be aware that resources referenced by a many to many relationship will also call this function when rendering the index of that many to many.

skip_sanitize()

@callback skip_sanitize() :: boolean() | nil

Allows skipping sanitize for all fields on a resource

sortable_by()

@callback sortable_by() :: String.t() | nil

Specifies the field to use as the basis for a drag and drop interface for the collection.

Functions

map_to_json(resources, conn)

to_json(resource, conn)