ExTeal.Panel (ExTeal v0.21.0) View Source

Separates fields on the detail page into panels

Link to this section Summary

t()

Given a resource, uses the fields definition to find the panels

Given a list of fields and a list of panels, assigns the panel to each field

Add helper text for the panel

Limit the amount of fields that show by default on the detail page Other fields are hidden behind a "Show more" button

Creates a new panel

options() :: %{
  optional(:helper_text) => String.t(),
  optional(:limit) => non_neg_integer(),
  optional(:apply_to_all) => map()
}

t() :: %ExTeal.Panel{
  field: term(),
  fields: term(),
  key: term(),
  name: term(),
  options: term()
}

Given a resource, uses the fields definition to find the panels

give_panel_to_fields([ExTeal.Field.t()], module()) :: [ExTeal.Field.t()]

Given a list of fields and a list of panels, assigns the panel to each field

helper_text(t(), String.t()) :: t()

Add helper text for the panel

limit(t(), integer()) :: t()

Limit the amount of fields that show by default on the detail page Other fields are hidden behind a "Show more" button

new(String.t(), [ExTeal.Field.t()], options()) :: t()

Creates a new panel