Skip to main content

IConfirmOptions

@spartanfx/react v1.2.2


@spartanfx/react / index / IConfirmOptions

Interface: IConfirmOptions

Defines the configuration options for a confirm dialog instance.

Properties

Required

PropertyTypeDescription
messagestringMain message displayed in the dialog.
onConfirm(comment?, additionalFieldsValue?) => voidCallback executed when the user confirms.

Options

PropertyTypeDescription
additionalFields?IFieldConfig[]Additional fields to display in the dialog before confirmation.
commentType?"none" | "mandatory" | "optional"Comment input configuration: mandatory, optional, or none.
confirmButtonLabel?stringOptional label for the confirm button Default: Ok
rejectButtonLabel?stringOptional label for the reject button Default: Cancel
title?stringOptional dialog title. Defaults to "Confirm".

Events & callbacks

PropertyTypeDescription
onReject?() => voidOptional callback executed when the user rejects.

Advanced & escape hatches

PropertyTypeDescription
commentOptions?Partial<ITextFieldProps>Optional configuration props for the comment TextField.