# Backpex v0.17.4 - Table of Contents

Highly customizable administration panel for Phoenix LiveView applications.

## GUIDES

- [Translations](translations.md)

- Introduction
  - [Introduction](readme.md)

- About
  - [What is Backpex?](what-is-backpex.md)
  - [Why we built Backpex?](why-we-built-backpex.md)
  - [Contribute to Backpex](contribute-to-backpex.md)

- Get Started
  - [Installation](installation.md)

- Live Resource
  - [What is a LiveResource?](what-is-a-live-resource.md)
  - [Templates](templates.md)
  - [Item Query](item-query.md)
  - [Ordering](ordering.md)
  - [on_mount Hook](on_mount-hook.md)
  - [Hooks](hooks.md)
  - [Navigation](navigation.md)
  - [Panels](panels.md)
  - [Fluid Layout](fluid-layout.md)
  - [Listen to PubSub Events](listen-to-pubsub-events.md)
  - [Additional classes for index table rows](additional-classes-for-index-table-rows.md)

- Fields
  - [What is a Field?](what-is-a-field.md)
  - [Custom Fields](custom-fields.md)
  - [Alignment](alignment.md)
  - [Visibility](visibility.md)
  - [Defaults](defaults.md)
  - [Readonly](readonly.md)
  - [Custom Alias](custom-alias.md)
  - [Placeholder](placeholder.md)
  - [Debounce and Throttle](debounce-and-throttle.md)
  - [Index Edit](index-edit.md)
  - [Error Customization](error-customization.md)
  - [Computed Fields](computed-fields.md)

- Filter
  - [What is a Filter?](what-is-a-filter.md)
  - [How to add a Filter?](how-to-add-a-filter.md)
  - [Filter Presets](filter-presets.md)
  - [Custom Filter](custom-filter.md)
  - [Visibility and Authorization](visibility-and-authorization.md)

- Actions
  - [Item Actions](item-actions.md)
  - [Resource Actions](resource-actions.md)

- Authorization
  - [LiveResource Authorization](live-resource-authorization.md)
  - [Field Authorization](field-authorization.md)

- Searching
  - [Search](basic-search.md)
  - [Full-Text Search](full-text-search.md)

- Upgrade Guides
  - [Upgrading to v0.17](v0-17.md)
  - [Upgrading to v0.16](v0-16.md)
  - [Upgrading to v0.15](v0-15.md)
  - [Upgrading to v0.14](v0-14.md)
  - [Upgrading to v0.13](v0-13.md)
  - [Upgrading to v0.12](v0-12.md)
  - [Upgrading to v0.11](v0-11.md)
  - [Upgrading to v0.10](v0-10.md)
  - [Upgrading to v0.9](v0-9.md)
  - [Upgrading to v0.8](v0-8.md)
  - [Upgrading to v0.7](v0-7.md)
  - [Upgrading to v0.6](v0-6.md)
  - [Upgrading to v0.5](v0-5.md)
  - [Upgrading to v0.3](v0-3.md)
  - [Upgrading to v0.2](v0-2.md)

## Modules

- [Backpex](Backpex.md): Backpex provides an easy way to manage existing resources in your application.

- [Backpex.CookieController](Backpex.CookieController.md)
- [Backpex.FormComponent](Backpex.FormComponent.md): The form live component.

- [Backpex.InitAssigns](Backpex.InitAssigns.md): Ensures Backpex `assigns` are applied to all LiveViews attaching this hook.

- [Backpex.LiveResource](Backpex.LiveResource.md): A LiveResource makes it easy to manage existing resources in your application. It provides extensive configuration options in order to meet everyone's needs. In connection with `Backpex.Components` you can build an individual admin dashboard on top of your application in minutes.
- [Backpex.Mix.IgniterHelpers](Backpex.Mix.IgniterHelpers.md): Helper functions for the Backpex mix tasks.

- [Backpex.Resource](Backpex.Resource.md): Generic context module for Backpex resources.
- [Backpex.Router](Backpex.Router.md): Provides LiveView routing for Backpex resources.

- [Backpex.ThemeSelectorPlug](Backpex.ThemeSelectorPlug.md): Contains a plug that inserts the theme into the assigns

- [BackpexWeb](BackpexWeb.md): The entrypoint for defining the web interface of Backpex.

- Adapters
  - [Backpex.Adapter](Backpex.Adapter.md): Specification of the datalayer adapter.
  - [Backpex.Adapters.Ecto](Backpex.Adapters.Ecto.md): The `Backpex.Adapter` to connect your `Backpex.LiveResource` to an `Ecto.Schema`.

- Components
  - [Backpex.HTML](Backpex.HTML.md): Contains common HTML functions.

  - [Backpex.HTML.CoreComponents](Backpex.HTML.CoreComponents.md): Provides core components for Backpex.

  - [Backpex.HTML.Form](Backpex.HTML.Form.md): Contains all Backpex form components.

  - [Backpex.HTML.ItemAction](Backpex.HTML.ItemAction.md): Item action-specific UI components.

  - [Backpex.HTML.Layout](Backpex.HTML.Layout.md): Contains all Backpex layout components.

  - [Backpex.HTML.Resource](Backpex.HTML.Resource.md): Contains all Backpex resource components.

- Fields
  - [Backpex.Field](Backpex.Field.md): Behaviour implemented by all fields.
  - [Backpex.Fields.BelongsTo](Backpex.Fields.BelongsTo.md): A field for handling a `belongs_to` relation.
  - [Backpex.Fields.Boolean](Backpex.Fields.Boolean.md): A field for handling a boolean value.
  - [Backpex.Fields.Currency](Backpex.Fields.Currency.md): A field for handling a currency value.
  - [Backpex.Fields.Date](Backpex.Fields.Date.md): A field for handling a date value.
  - [Backpex.Fields.DateTime](Backpex.Fields.DateTime.md): A field for handling a date time value.
  - [Backpex.Fields.Email](Backpex.Fields.Email.md): A field for handling an email value.
  - [Backpex.Fields.HasMany](Backpex.Fields.HasMany.md): A field for handling a `has_many` or `many_to_many` relation.
  - [Backpex.Fields.HasManyThrough](Backpex.Fields.HasManyThrough.md): A field for handling a `has_many` (`through`) relation.
  - [Backpex.Fields.InlineCRUD](Backpex.Fields.InlineCRUD.md): A field to handle inline CRUD operations. It can be used with either an `embeds_many` or `has_many` (association) type column.
  - [Backpex.Fields.MultiSelect](Backpex.Fields.MultiSelect.md): A field for handling a multi select with predefined options.
  - [Backpex.Fields.Number](Backpex.Fields.Number.md): A field for handling a number value.
  - [Backpex.Fields.Select](Backpex.Fields.Select.md): A field for handling a select value.
  - [Backpex.Fields.Text](Backpex.Fields.Text.md): A field for handling a text value.
  - [Backpex.Fields.Textarea](Backpex.Fields.Textarea.md): A field for handling long text values.
  - [Backpex.Fields.Time](Backpex.Fields.Time.md): A field for handling a time value.
  - [Backpex.Fields.URL](Backpex.Fields.URL.md): A field for handling an URL value.
  - [Backpex.Fields.Upload](Backpex.Fields.Upload.md): A field for handling uploads.

- Actions
  - [Backpex.ItemAction](Backpex.ItemAction.md): Behaviour implemented by all item actions.

  - [Backpex.ItemActions.Delete](Backpex.ItemActions.Delete.md): Inline item action to delete the item.

  - [Backpex.ItemActions.Edit](Backpex.ItemActions.Edit.md): Inline item action to redirect to edit view.

  - [Backpex.ItemActions.Show](Backpex.ItemActions.Show.md): Inline item action to redirect to show view.

  - [Backpex.ResourceAction](Backpex.ResourceAction.md): Behaviour implemented by all resource action modules.

- Filters
  - [Backpex.Filter](Backpex.Filter.md): The base behaviour for all filters. Injects also basic layout, form and delete button for a filters rendering.

  - [Backpex.Filters.Boolean](Backpex.Filters.Boolean.md): The boolean filter renders one checkbox per given option, hence multiple options can apply at the same time.
Instead of implementing a `query` callback, you need to define predicates for each option leveraging [`Ecto.Query.dynamic/2`](https://hexdocs.pm/ecto/Ecto.Query.html#dynamic/2).
  - [Backpex.Filters.MultiSelect](Backpex.Filters.MultiSelect.md): The multi select filter renders checkboxes for a given list of options, hence allowing the user to select multiple values.
  - [Backpex.Filters.Range](Backpex.Filters.Range.md): The range filter renders two input fields of the same type. Backpex offers the `:date`, `:datetime` and the `number` type.
  - [Backpex.Filters.Select](Backpex.Filters.Select.md): The select filter renders a select box for the implemented `options/1` and `prompt/0` callbacks. The `prompt/0` callback defines the key for the `nil` value added as first option.

- Metrics
  - [Backpex.Metric](Backpex.Metric.md): Behaviour implemented by all metrics.
  - [Backpex.Metrics.Value](Backpex.Metrics.Value.md): Value metrics display only a single value. This value is generated from the current index query by applying the given
aggregate function. The selected value is processed by the specified formatting function and output in the frontend.

- Exceptions
  - [Backpex.ForbiddenError](Backpex.ForbiddenError.md): Raised when action can not be performed due to missing permission.
  - [Backpex.NoResultsError](Backpex.NoResultsError.md): Raised when no results can be found.

## Mix Tasks

- [mix backpex.install](Mix.Tasks.Backpex.Install.md): Installs and sets up Backpex according to the installation guide