Backpex.Fields.Checkgroup (Backpex v0.22.0)

Copy Markdown View Source

A field for handling multiple checkboxes with predefined options.

This field stores selected values as an array.

Field-specific options

See Backpex.Field for general field options.

  • :options - Required. List of options or function that receives the assigns.

  • :readonly - Sets the field to readonly. Also see the panels guide.

Example

@impl Backpex.LiveResource
def fields do
  [
    roles: %{
      module: Backpex.Fields.Checkgroup,
      label: "Roles",
      options: [{"Admin", "admin"}, {"User", "user"}, {"Editor", "editor"}]
    }
  ]
end

Summary

Functions

Returns the schema of configurable options for this field.

Functions

config_schema()

Returns the schema of configurable options for this field.

This can be useful for reuse in other field modules.