Cinder.Refresh (Cinder v0.9.0)

Helper functions for refreshing Cinder collection data from parent LiveViews.

This module provides convenient functions to refresh collection data after performing CRUD operations, ensuring the collection reflects the latest state without requiring a full page reload.

Usage

After performing operations that modify data displayed in a collection:

def handle_event("delete", %{"id" => id}, socket) do
  MyApp.MyResource
  |> Ash.get!(id)
  |> Ash.destroy!()

  {:noreply, refresh_table(socket, "my-table-id")}
end

Or to refresh multiple collections:

def handle_event("bulk_delete", params, socket) do
  # ... perform bulk operations ...

  {:noreply, refresh_tables(socket, ["users-table", "orders-table"])}
end

Refresh Behavior

When a collection is refreshed:

Current filters are maintained
Sort order is preserved
Pagination state is kept (user stays on current page if possible)
Loading state is shown during refresh
Data is reloaded using the same query parameters

Summary

Functions

refresh_table(socket, collection_id)

Refreshes a specific collection by its ID.

refresh_tables(socket, collection_ids)

Refreshes multiple collections by their IDs.

update_if_visible(socket, collection_id, id, update_fn)

See Cinder.Update.update_if_visible/4.

update_item(socket, collection_id, id, update_fn)

See Cinder.Update.update_item/4.

update_items(socket, collection_id, ids, update_fn)

See Cinder.Update.update_items/4.

update_items_if_visible(socket, collection_id, ids, update_fn)

See Cinder.Update.update_items_if_visible/4.

Functions

refresh_table(socket, collection_id)

Refreshes a specific collection by its ID.

Sends a refresh message to the LiveComponent with the given ID. The collection will reload its data while maintaining current filters, sorting, and pagination state.

Parameters

socket - The LiveView socket
collection_id - The ID of the collection to refresh (string)

Returns

The socket (unchanged, but refresh message has been sent).

Examples

# Refresh a specific collection
{:noreply, refresh_table(socket, "users-table")}

# In a handle_event callback
def handle_event("delete_user", %{"id" => id}, socket) do
  MyApp.User
  |> Ash.get!(id)
  |> Ash.destroy!()

  {:noreply, refresh_table(socket, "users-table")}
end