Specs

as_html(ExTeal.Field.t()) :: ExTeal.Field.t()

Marks the field as safe to render as html

Specs

can_see?(ExTeal.Field.t(), (Plug.Conn.t() -> boolean())) :: ExTeal.Field.t()

Conditionally render a field on a resource as a whole based on the current request. Helpful for filtering out fields based on the current users permissions.

Specs

except_on_forms(ExTeal.Field.t()) :: ExTeal.Field.t()

Field is only visible on Details and Index

Specs

hide_from_detail(ExTeal.Field.t()) :: ExTeal.Field.t()

Hide field is hidden on the detail

Specs

hide_from_index(ExTeal.Field.t()) :: ExTeal.Field.t()

Hide field is hidden on the index

Specs

hide_when_creating(ExTeal.Field.t()) :: ExTeal.Field.t()

Hide field is hidden when creating a resource

Specs

hide_when_updating(ExTeal.Field.t()) :: ExTeal.Field.t()

Hide field is hidden when updating a resource

Specs

only_on_details(ExTeal.Field.t()) :: ExTeal.Field.t()

Field is only visible on Details

Specs

only_on_forms(ExTeal.Field.t()) :: ExTeal.Field.t()

Field is only visible on Create and New

Specs

only_on_index(ExTeal.Field.t()) :: ExTeal.Field.t()

Field is only visible on Index

Specs

searchable(ExTeal.Field.t()) :: ExTeal.Field.t()

Marks a relational field as searchable

Only applies to many to many relationships

Specs

show_on_index(ExTeal.Field.t()) :: ExTeal.Field.t()

Show field on the index