ModelActionProps
Properties
action
Action identifier sent to the server.
Type: string
Source: client/lib/use/useModelAction.js:17
actionErrorSummary
Toast summary shown when the action fails.
Type: string
Source: client/lib/use/useModelAction.js:21
actionSuccessSummary
Toast summary shown on successful action completion.
Type: string
Source: client/lib/use/useModelAction.js:20
actionVerboseName
Human-readable action name.
Type: string
Source: client/lib/use/useModelAction.js:19
app
Django app label that owns the model.
Type: string
Source: client/lib/use/useModelAction.js:15
bannerDescription
Optional banner description.
Type: string
Source: client/lib/use/useModelAction.js:32
bannerTitle
Optional banner title.
Type: string
Source: client/lib/use/useModelAction.js:31
confirmMessage
Confirmation message shown to the user before submitting.
Type: string
Source: client/lib/use/useModelAction.js:22
enableDryRun
Whether to perform dry-run validation.
Type: boolean
Source: client/lib/use/useModelAction.js:29
fetchState
Selected-object fetch state.
Type: object
Source: client/lib/use/useModelAction.js:23
instanceList
List instance that holds the selected objects. Bulk actions use it to reconcile displayed rows after a real destroy. Omit it to use a private transport-only list.
Type: ListManager | ListInstance
Source: client/lib/use/useModelAction.js:24
model
Django model name the action targets.
Type: string
Source: client/lib/use/useModelAction.js:16
pk
Optional primary key or primary keys when no fetch state is ready.
Type: string | number | string[] | number[]
Source: client/lib/use/useModelAction.js:18
requestMethod
HTTP method used for non-destroy action requests.
Type: string
Source: client/lib/use/useModelAction.js:28
tone
Sentiment tone.
Type: "neutral" | "info" | "warning" | "success" | "danger"
Source: client/lib/use/useModelAction.js:30
transformSubmitDataFn
Optional form-value transform.
Type: (values: any) => any
Source: client/lib/use/useModelAction.js:27
Source
client/lib/use/useModelAction.js:14