Skip to main content
Version: 1.1.0

IListFormFieldProps

@spartanfx/react v1.1.0


@spartanfx/react / spfx / IListFormFieldProps

Interface: IListFormFieldProps

Props for the ListFormField component, which dynamically renders a SharePoint field.

Extends

  • ICommonProps

Properties

PropertyTypeDescriptionInherited from
className?stringOptional CSS class for the container element.-
controlProps?anyProps passed directly to the underlying field control.ICommonProps.controlProps
dependencies?any[]List of dynamic dependencies to watch for triggering re-render of the field.-
disabled?booleanWhether the field is disabled. Overrides form-level settings.ICommonProps.disabled
fieldInternalNamestringThe internal name of the SharePoint field to render.-
label?stringCustom label text. Defaults to the SharePoint field's display name if not provided.-
labelStyle?"none" | "inline" | "normal" | "invisible"Controls label rendering behavior. - normal: label is visible above or beside the control - none: no label is rendered - invisible: label is rendered but visually hidden (for accessibility) - inline: label is rendered beside the control-
noCopyToClipboard?booleanWhen true, hides the "Copy to Clipboard" button. Defaults to false.-
onChange?(newValue, oldValue?) => voidOptional callback triggered when the field value changes.ICommonProps.onChange
onRenderControl?(props) => ReactElementOptional custom renderer for the field control. Can be used to override default rendering behavior.-
onRenderTooltipContent?() => ReactElementOptional function to render tooltip content for the label.-
readonly?booleanIf true, renders the field in readonly mode without user interaction.ICommonProps.readonly
required?booleanWhether the field is required.ICommonProps.required