Skip to main content
Version: 2.1.4

IListFormConfig

3p-core v2.1.4


3p-core / IListFormConfig

Interface: IListFormConfig

Configuration object for initializing the ListForm context.

This configuration controls how the form is initialized, including list metadata, SPFx context, behavior flags, and lifecycle hooks.

Properties

PropertyTypeDescription
disabled?booleanIf true, disables all controls in the form. The context's disabled flag will reflect this.
itemIdnumberID of the SharePoint list item to load into the form. Pass null or undefined to render the form in "new item" mode.
listNamestringThe display name of the SharePoint list.
onInit?(listFormContext) => void | Promise<void>Lifecycle hook called once before the form is shown. Use this to pre-fill form state or run initialization logic. If a Promise is returned, rendering will be delayed until the Promise resolves.
readonly?booleanIf true, renders the form in readonly mode (visually editable, but no actions are allowed). Unlike disabled, fields are not grayed out and can still be visually interacted with.
spSPFIPnPjs SPFI instance used for SharePoint REST API operations.
translate?(text) => stringOptional translation function for localizing UI text strings. If not provided, raw text values will be used.
webPartContextWebPartContextSPFx WebPart context, typically passed from the WebPart class.