Skip to main content

ICADataFormInternalConfig

@spartanfx/react v1.2.2


@spartanfx/react / codeapps / ICADataFormInternalConfig

Interface: ICADataFormInternalConfig<TRecord, TId>

Internal shared config with concrete backend mode.

Extends

Type Parameters

TRecord

TRecord extends CADataFormRecord

TId

TId extends string | number = string

Properties

Required

PropertyTypeDescription
backendModeCADataFormMode-
serviceICATabularService<TRecord, TId>-

Options

PropertyTypeDescription
autoRefresh?booleanEnable auto-refresh after mutations (default: true).
cacheDuration?numberCache TTL for read results in ms (default: 60_000).
choiceColumns?string[]-
debug?booleanEnable verbose console logging (default: false).
disabled?boolean-
fieldInfo?IDataTableFieldType[]-
fields?IDataFormFieldDefinition<DataFormValues>[]-
idColumn?string-
itemId?TId-
lookupServices?Record<string, CADataverseLookupService>Referenced-table data sources for Dataverse lookup columns, keyed by the lookup column logical name (e.g. ps_company). The navigation property, referenced entity logical name, or entity-set name are also accepted as keys. Required for Dataverse lookup fields to populate their options, since the owning form's service cannot query the referenced table. Ignored for SharePoint (which resolves options via getReferencedEntity).
metadata?unknown-
mode?DataFormMode-
readonly?boolean-
record?TRecord-
retryPolicy?ICARetryPolicyRetry policy for transient failures.

Events & callbacks

PropertyTypeDescription
onError?(error) => voidError callback. Called for every operational failure.
onInit?(dataFormContext) => void | Promise<void>-
onLoaded?(record) => void | Promise<void>-
onNotify?CANotifyFnNotification callback. If omitted, hook errors surface via error state only.
onSave?(record, dataFormContext) => unknown-
onSaved?(record) => void | Promise<void>-