Skip to content

DetailViewInstanceGroup ​

Properties ​

combinedError ​

The first active error across prop validation, model config, instance fetch, and form submission; null when none.

Type: Error

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

combinedErrored ​

True when combinedError is non-null.

Type: boolean

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

combinedFormProps ​

Every prop for the FormModel component, from module:use/useFormModelProps. Bind it as the form's only prop source. A form prop that the options leave undefined keeps the model config value. When the object has calculated values, they join the merged widgetProps map.

Type: any

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

combinedWhileText ​

Human-readable description of the operation that produced combinedError; empty string when no error.

Type: string

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

currentActionAvailable ​

Whether the fetched object's available_actions permits the current view's action. True (optimistic) until the object has loaded.

Type: boolean

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

formId ​

Stable HTML id for the <form> element; use as :id on the form and :form on submit buttons.

Type: string

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

pageLoading ​

Combined loading state (model config + instance fetch).

Type: boolean

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

recordName ​

The fetched object's formatted_name, which names the record in the view's header. Empty when the model has no formatted name, when the object has not loaded, or when the name is blank.

Type: string

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

recordNamePending ​

True while the model has a formatted name and the object that carries it is still loading. A view shows a skeleton in place of the name during this time.

Type: boolean

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

titleStr ​

Formatted page title derived from the view name and model verbose name. Empty until the verbose name is known.

Type: string

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

validAndActive ​

True when the component is mounted and all required props are set and model config has loaded.

Type: boolean

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

Source ​

client/lib/use/useDetailView.js:108