WP Kernel API / @wpkernel/ui / ResourceDataViewActionConfig
Interface: ResourceDataViewActionConfig<TItem, TInput, TResult>
Action configuration for ResourceDataView.
Type Parameters
TItem
TItem
TInput
TInput
TResult
TResult
= unknown
Properties
id
id: string;
Unique identifier, mirrored in events.
action
action: DefinedAction<TInput, TResult>;
Action implementation to invoke.
label
label: string | (items) => string;
Label shown in DataViews UI.
supportsBulk?
optional supportsBulk: boolean;
Whether bulk selection is supported.
isDestructive?
optional isDestructive: boolean;
Flag destructive styling.
isPrimary?
optional isPrimary: boolean;
Flag primary styling.
policy?
optional policy: string;
Policy key to gate rendering and execution.
disabledWhenDenied?
optional disabledWhenDenied: boolean;
When true, render disabled instead of hiding on policy denial.
getActionArgs()
getActionArgs: (context) => TInput;
Build action input payload from the current selection and items.
Parameters
context
selection
(string
| number
)[]
items
TItem
[]
Returns
TInput
buildMeta()?
optional buildMeta: (context) => Record<string, unknown> | undefined;
Optional meta object included in action triggered events.
Parameters
context
selection
(string
| number
)[]
items
TItem
[]
Returns
Record
<string
, unknown
> | undefined
invalidateOnSuccess()?
optional invalidateOnSuccess: (result, context) =>
| false
| CacheKeyPattern[];
Optional invalidate hook overriding the default behaviour.
Parameters
result
TResult
context
selection
(string
| number
)[]
items
TItem
[]
input
TInput
Returns
| false
| CacheKeyPattern
[]