View Source ExTeal.Panel (ExTeal v0.27.7)

Separates fields on the detail page into panels

Summary

options()

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

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

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

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

@spec 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

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

Add helper text for the panel

@spec 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

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

Creates a new panel