Skip to main content

IImagePicker

@spartanfx/react v1.2.2


@spartanfx/react / spfx / IImagePicker

Interface: IImagePicker

Props for the ImagePicker component.

Properties

Required

PropertyTypeDescription
imageFieldValueanyThe current image field value (stringified or parsed object) from the SharePoint list item.
onFileSelected(file) => anyCallback triggered when a file is selected.
spSPFIInstance of PnP JS SPFI used to interact with SharePoint.

Options

PropertyTypeDescription
inline?booleanIf true, the image picker is rendered inline (horizontal layout).
label?stringOptional label shown above the image selector.
loading?booleanWhether to show a loading spinner.
readOnly?booleanWhen true, disables the image selection interaction.

Appearance & theming

PropertyTypeDescription
className?stringOptional CSS class names.
style?anyOptional style overrides.