AshBackpex.LiveResource.Info (ash_backpex v0.0.1)

View Source

Summary

Functions

The create action to be used when creating resources. Will default to the primary create action.

The create action to be used when creating resources. Will default to the primary create action.

Changeset to use when creating items. Additional metadata is passed as a keyword list via the third parameter

Changeset to use when creating items. Additional metadata is passed as a keyword list via the third parameter

The destroy action to be used when destroying resources. Will default to the primary destroy action.

The destroy action to be used when destroying resources. Will default to the primary destroy action.

backpex.fields DSL entities

backpex.filters DSL entities

backpex.item_actions DSL entities

backpex.item_actions DSL options

Default Backpex actions to remove from the live resource

Default Backpex actions to remove from the live resource

The liveview layout, e.g.: {MyAppWeb.Layouts, :admin}

The liveview layout, e.g.: {MyAppWeb.Layouts, :admin}

backpex DSL options

Any panels to be displayed in the admin create/edit forms.

Any panels to be displayed in the admin create/edit forms.

The plural label for the resource taht will appear i nthe admin. E.g., "Posts"

The plural label for the resource taht will appear i nthe admin. E.g., "Posts"

The read action to be used when reading resources. Will default to the primary read action.

The read action to be used when reading resources. Will default to the primary read action.

The Ash resource that the Backpex Live resource should be connect to.

The Ash resource that the Backpex Live resource should be connect to.

The singular label for the resource that will appear in the admin. E.g., "Post"

The singular label for the resource that will appear in the admin. E.g., "Post"

The update action to be used when updating resources. Will default to the primary update action.

The update action to be used when updating resources. Will default to the primary update action.

Changeset to use when updating items. Additional metadata is passed as a keyword list via the third parameter

Changeset to use when updating items. Additional metadata is passed as a keyword list via the third parameter

Functions

backpex_create_action(dsl_or_extended)

@spec backpex_create_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The create action to be used when creating resources. Will default to the primary create action.

backpex_create_action!(dsl_or_extended)

@spec backpex_create_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The create action to be used when creating resources. Will default to the primary create action.

backpex_create_changeset(dsl_or_extended)

@spec backpex_create_changeset(dsl_or_extended :: module() | map()) ::
  {:ok, (any(), any(), any() -> any())} | :error

Changeset to use when creating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.

backpex_create_changeset!(dsl_or_extended)

@spec backpex_create_changeset!(dsl_or_extended :: module() | map()) ::
  (any(), any(), any() -> any()) | no_return()

Changeset to use when creating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.

backpex_destroy_action(dsl_or_extended)

@spec backpex_destroy_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The destroy action to be used when destroying resources. Will default to the primary destroy action.

backpex_destroy_action!(dsl_or_extended)

@spec backpex_destroy_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The destroy action to be used when destroying resources. Will default to the primary destroy action.

backpex_fields(dsl_or_extended)

@spec backpex_fields(dsl_or_extended :: module() | map()) :: [struct()]

backpex.fields DSL entities

backpex_filters(dsl_or_extended)

@spec backpex_filters(dsl_or_extended :: module() | map()) :: [struct()]

backpex.filters DSL entities

backpex_item_actions(dsl_or_extended)

@spec backpex_item_actions(dsl_or_extended :: module() | map()) :: [struct()]

backpex.item_actions DSL entities

backpex_item_actions_options(dsl_or_extended)

@spec backpex_item_actions_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

backpex.item_actions DSL options

Returns a map containing the and any configured or default values.

backpex_item_actions_strip_default(dsl_or_extended)

@spec backpex_item_actions_strip_default(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Default Backpex actions to remove from the live resource

backpex_item_actions_strip_default!(dsl_or_extended)

@spec backpex_item_actions_strip_default!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Default Backpex actions to remove from the live resource

backpex_layout(dsl_or_extended)

@spec backpex_layout(dsl_or_extended :: module() | map()) ::
  {:ok, {:module, atom()}} | :error

The liveview layout, e.g.: {MyAppWeb.Layouts, :admin}

backpex_layout!(dsl_or_extended)

@spec backpex_layout!(dsl_or_extended :: module() | map()) ::
  {:module, atom()} | no_return()

The liveview layout, e.g.: {MyAppWeb.Layouts, :admin}

backpex_options(dsl_or_extended)

@spec backpex_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

backpex DSL options

Returns a map containing the and any configured or default values.

backpex_panels(dsl_or_extended)

@spec backpex_panels(dsl_or_extended :: module() | map()) ::
  {:ok, [String.t()]} | :error

Any panels to be displayed in the admin create/edit forms.

backpex_panels!(dsl_or_extended)

@spec backpex_panels!(dsl_or_extended :: module() | map()) ::
  [String.t()] | no_return()

Any panels to be displayed in the admin create/edit forms.

backpex_plural_label(dsl_or_extended)

@spec backpex_plural_label(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The plural label for the resource taht will appear i nthe admin. E.g., "Posts"

backpex_plural_label!(dsl_or_extended)

@spec backpex_plural_label!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The plural label for the resource taht will appear i nthe admin. E.g., "Posts"

backpex_read_action(dsl_or_extended)

@spec backpex_read_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The read action to be used when reading resources. Will default to the primary read action.

backpex_read_action!(dsl_or_extended)

@spec backpex_read_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The read action to be used when reading resources. Will default to the primary read action.

backpex_resource(dsl_or_extended)

@spec backpex_resource(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

The Ash resource that the Backpex Live resource should be connect to.

backpex_resource!(dsl_or_extended)

@spec backpex_resource!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Ash resource that the Backpex Live resource should be connect to.

backpex_singular_label(dsl_or_extended)

@spec backpex_singular_label(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The singular label for the resource that will appear in the admin. E.g., "Post"

backpex_singular_label!(dsl_or_extended)

@spec backpex_singular_label!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The singular label for the resource that will appear in the admin. E.g., "Post"

backpex_update_action(dsl_or_extended)

@spec backpex_update_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The update action to be used when updating resources. Will default to the primary update action.

backpex_update_action!(dsl_or_extended)

@spec backpex_update_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The update action to be used when updating resources. Will default to the primary update action.

backpex_update_changeset(dsl_or_extended)

@spec backpex_update_changeset(dsl_or_extended :: module() | map()) ::
  {:ok, (any(), any(), any() -> any())} | :error

Changeset to use when updating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.

backpex_update_changeset!(dsl_or_extended)

@spec backpex_update_changeset!(dsl_or_extended :: module() | map()) ::
  (any(), any(), any() -> any()) | no_return()

Changeset to use when updating items. Additional metadata is passed as a keyword list via the third parameter:

  • :assigns - the assigns
  • :target - the name of the form target that triggered the changeset call. Default to nil if the call was not triggered by a form field.