ViewUpdateOptions
Overview
Required identification.
Properties
app
Django app label that owns the model.
Type: string
Source: client/lib/use/useViewUpdate.js:46
calculatedObjectRules
Rules for deriving calculated objects alongside the instance.
Optional form overrides.
Type: object
Source: client/lib/use/useViewUpdate.js:54
expand
Relations that the form renders as inline fieldsets. Replaces the model config list.
Type: string[]
Source: client/lib/use/useViewUpdate.js:60
expandDetails
Map of expand paths to detail overrides.
Type: any
Source: client/lib/use/useViewUpdate.js:61
fetchFields
Field names to request from the API, on retrieval and in the update response; overrides the model config default when non-empty.
Type: string[]
Source: client/lib/use/useViewUpdate.js:51
fieldComponents
Map of field paths to field component overrides.
Type: any
Source: client/lib/use/useViewUpdate.js:62
fieldDetails
Map of field paths to field detail overrides.
Type: any
Source: client/lib/use/useViewUpdate.js:59
fieldProps
Map of field paths to props for each field component.
Type: any
Source: client/lib/use/useViewUpdate.js:64
fields
Field names that the form renders. Replaces the model config list.
Type: string[]
Source: client/lib/use/useViewUpdate.js:58
formModelVariant
Theme variant that the FormModel component receives as variant.
Type: string
Source: client/lib/use/useViewUpdate.js:66
formProps
Extra props for the FormModel component. They win over the model config's formProps and lose to the form props below. The app, model, and view keys are ignored, because the view sets them.
Type: any
Source: client/lib/use/useViewUpdate.js:57
model
Django model name.
Type: string
Source: client/lib/use/useViewUpdate.js:47
pk
Primary key of the instance to fetch and edit.
Optional data-fetching overrides.
Type: string
Source: client/lib/use/useViewUpdate.js:48
redirectAfter
Named view to redirect to after a successful update; null stays on the current page.
Type: "list" | "read"
Source: client/lib/use/useViewUpdate.js:67
relatedObjectRules
Rules for fetching related objects alongside the instance.
Type: object
Source: client/lib/use/useViewUpdate.js:53
submitFields
Field paths sent in the update request body, which also carries the primary key. Overrides the model config default when non-empty.
Type: string[]
Source: client/lib/use/useViewUpdate.js:52
widgetComponents
Map of field paths to widget component overrides.
Type: any
Source: client/lib/use/useViewUpdate.js:63
widgetProps
Map of field paths to props for each widget component.
Type: any
Source: client/lib/use/useViewUpdate.js:65
Source
client/lib/use/useViewUpdate.js:43