useActionStatus

useActionStatus(descriptor): ActionHookResult

Defined in: packages/ui/src/hooks/use-action-status.ts:21

Returns the permission status and submit function for the first action in a descriptor.

Convenience wrapper around useActions() for single-action descriptors (e.g. a create action passed to EmptyState or a navigation item guard).

Parameters

descriptor

ClientDescriptor

Client-side action descriptor from @cfast/actions

Returns

ActionHookResult

The ActionHookResult with permitted, invisible, pending, and submit

Example

const status = useActionStatus(createPost.client);
if (status.permitted) {
  status.submit({ title: "New Post" });
}