@snowpact/react-tanstack-query-table 1.5.1 → 1.5.3

package/README.md

@@ -197,7 +197,7 @@ const fetchUsers = async (params: ServerFetchParams) => {
 
 ## Actions
 
-Actions appear as buttons in each row. You have full control over what happens when an action is triggered.
+Actions appear as buttons in each row:
 
 ### Click Action
 
@@ -222,47 +222,43 @@ Actions appear as buttons in each row. You have full control over what happens w
 }
 ```
 
-### Click Action with Confirmation
+### Endpoint Action
 
-Handle confirmation dialogs yourself in the onClick handler:
+For API calls with built-in mutation handling:
 
 ```tsx
 {
-  type: 'click',
+  type: 'endpoint',
   icon: TrashIcon,
   label: 'Delete',
   variant: 'danger',
-  onClick: async (item) => {
-    // Use your own confirmation dialog
-    if (await myConfirmDialog(`Delete ${item.name}?`)) {
-      await api.deleteUser(item.id);
-      toast.success('User deleted');
-      queryClient.invalidateQueries(['users']);
-    }
+  endpoint: (item) => api.deleteUser(item.id),
+  onSuccess: () => {
+    toast.success('User deleted');
+    queryClient.invalidateQueries(['users']);
   },
+  onError: (error) => toast.error(error.message),
 }
 ```
 
-### Click Action with API Call
+### Endpoint with Confirmation
+
+Use `withConfirm` for optional confirmation before the endpoint is called:
 
 ```tsx
 {
-  type: 'click',
+  type: 'endpoint',
   icon: TrashIcon,
   label: 'Delete',
   variant: 'danger',
-  onClick: async (item) => {
-    try {
-      await api.deleteUser(item.id);
-      toast.success('User deleted');
-      queryClient.invalidateQueries(['users']);
-    } catch (error) {
-      toast.error('Failed to delete user');
-    }
-  },
+  endpoint: (item) => api.deleteUser(item.id),
+  withConfirm: (item) => myConfirmDialog(`Delete ${item.name}?`),
+  onSuccess: () => queryClient.invalidateQueries(['users']),
 }
 ```
 
+If `withConfirm` returns `false`, the endpoint is not called.
+
 ### Dynamic Actions
 
 ```tsx