Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve item action guide #760

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Improve item action guide #760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions guides/actions/item-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ defmodule DemoWeb.ItemAction.Show do
end

@impl Backpex.ItemAction
def label(_assigns, _item), do: Backpex.translate("Show")
def label(_assigns, _item), do: "Show"

@impl Backpex.ItemAction
def handle(socket, [item | _items], _data) do
Expand Down Expand Up @@ -124,6 +124,8 @@ Next, we need to implement the item action module.
defmodule DemoWeb.ItemAction.SoftDelete do
use BackpexWeb, :item_action

import Ecto.Changeset

alias Backpex.Resource

@impl Backpex.ItemAction
Expand All @@ -147,20 +149,23 @@ defmodule DemoWeb.ItemAction.SoftDelete do
@required_fields ~w[reason]a

@impl Backpex.ItemAction
def changeset(change, attrs) do
def changeset(change, attrs, _meta) do
change
|> cast(attrs, @required_fields)
|> validate_required(@required_fields)
end

@impl Backpex.ItemAction
def label(_assigns, _item), do: Backpex.translate("Delete")
def confirm(_assigns), do: "Why do you want to delete this item?"

@impl Backpex.ItemAction
def label(_assigns, _item), do: "Delete"

@impl Backpex.ItemAction
def confirm_label(_assigns), do: Backpex.translate("Delete")
def confirm_label(_assigns), do: "Delete"

@impl Backpex.ItemAction
def cancel_label(_assigns), do: Backpex.translate("Cancel")
def cancel_label(_assigns), do: "Cancel"

@impl Backpex.ItemAction
def handle(socket, items, data) do
Expand Down Expand Up @@ -194,4 +199,6 @@ In the above example, we define an item action to soft delete users. The item ac

The `c:Backpex.ItemAction.handle/3` function is called when the item action is triggered. The handle function receives the socket, the items that should be affected by the action, and the parameters that were submitted by the user.

By default an item action is triggered immediately when the user clicks on the corresponding icon in the resource table or in the show view, but an item actions also supports a confirmation dialog. To enable the confirmation dialog you need to implement the `c:Backpex.ItemAction.confirm_label/1` function and return a string that will be displayed in the confirmation dialog. The confirmation dialog will be displayed when the user clicks on the icon in the resource table.
By default an item action is triggered immediately when the user clicks on the corresponding icon in the resource table or in the show view, but an item actions also supports a confirmation dialog. To enable the confirmation dialog you need to implement the `c:Backpex.ItemAction.confirm/1` function and return a string that will be displayed in the confirmation dialog. The confirmation dialog will be displayed when the user clicks on the icon in the resource table.

You might want to use the `c:Backpex.ItemAction.cancel_label/0` (defaults to "Cancel") and `c:Backpex.ItemAction.confirm_label/0` (defaults to "Apply") functions to set the labels of the buttons in the dialog.
Loading