DetailViewOptions

Overview

Required identification.

Properties

app

Django app label that owns the model.

Type: string

Source: client/lib/use/useDetailView.js:82

calculatedObjectRules

Rules for deriving calculated objects alongside the instance.

Optional form overrides.

Type: object

Source: client/lib/use/useDetailView.js:90

fetchFields

Field names to request from the API; overrides the model config default.

Type: string[]

Source: client/lib/use/useDetailView.js:88

formProps

Extra props merged into the FormModel component.

Type: any

Source: client/lib/use/useDetailView.js:93

model

Django model name.

Type: string

Source: client/lib/use/useDetailView.js:83

objectForm

The useObjectForm result; used to suppress re-fetching during submission and to surface submit errors.

Type: object

Source: client/lib/use/useDetailView.js:98

pk

Primary key of the instance to fetch.

Optional data-fetching overrides.

Type: string

Source: client/lib/use/useDetailView.js:85

primaryActions

Detail-level action names promoted to the filled hero CTA; defaults to ["update"].

Optional submit state (needed when the view has a submit button, e.g. update).

Type: string[]

Source: client/lib/use/useDetailView.js:95

relatedObjectRules

Rules for fetching related objects alongside the instance.

Type: object

Source: client/lib/use/useDetailView.js:89

viewName

View identifier used to load model config and build the form ID (e.g. "read" or "update").

Type: string

Source: client/lib/use/useDetailView.js:84

widgetProps

Extra props forwarded to every widget component inside the form.

Type: any

Source: client/lib/use/useDetailView.js:94

Source

client/lib/use/useDetailView.js:79