---
url: "https://vueda.dev/v3/reference/api/js/use/useModelAction/types/ModelActionProps.md"
title: "ModelActionProps"
---

# ModelActionProps

## Properties

### action {#action}

Action identifier sent to the server.

Type: `string`

Source: `client/lib/use/useModelAction.js:17`

### actionErrorSummary {#actionErrorSummary}

Toast summary shown when the action fails.

Type: `string`

Source: `client/lib/use/useModelAction.js:21`

### actionSuccessSummary {#actionSuccessSummary}

Toast summary shown on successful action completion.

Type: `string`

Source: `client/lib/use/useModelAction.js:20`

### actionVerboseName {#actionVerboseName}

Human-readable action name.

Type: `string`

Source: `client/lib/use/useModelAction.js:19`

### app {#app}

Django app label that owns the model.

Type: `string`

Source: `client/lib/use/useModelAction.js:15`

### bannerDescription {#bannerDescription}

Optional banner description.

Type: `string`

Source: `client/lib/use/useModelAction.js:32`

### bannerTitle {#bannerTitle}

Optional banner title.

Type: `string`

Source: `client/lib/use/useModelAction.js:31`

### confirmMessage {#confirmMessage}

Confirmation message shown to the user before submitting.

Type: `string`

Source: `client/lib/use/useModelAction.js:22`

### enableDryRun {#enableDryRun}

Whether to perform dry-run validation.

Type: `boolean`

Source: `client/lib/use/useModelAction.js:29`

### fetchState {#fetchState}

Selected-object fetch state.

Type: `object`

Source: `client/lib/use/useModelAction.js:23`

### instanceList {#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 {#model}

Django model name the action targets.

Type: `string`

Source: `client/lib/use/useModelAction.js:16`

### pk {#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 {#requestMethod}

HTTP method used for non-destroy action requests.

Type: `string`

Source: `client/lib/use/useModelAction.js:28`

### tone {#tone}

Sentiment tone.

Type: `"neutral" | "info" | "warning" | "success" | "danger"`

Source: `client/lib/use/useModelAction.js:30`

### transformSubmitDataFn {#transformSubmitDataFn}

Optional form-value transform.

Type: `(values: any) => any`

Source: `client/lib/use/useModelAction.js:27`

## Source

`client/lib/use/useModelAction.js:14`
