InterfaceDeleteModalProps
Interface: InterfaceDeleteModalProps
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:198
Props for DeleteModal template
Specialized template for delete confirmation dialogs.
Extends
Properties
centered?
optionalcentered:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:79
Whether to center the modal vertically on the page
Inherited from
InterfaceCrudModalBaseProps.centered
children?
optionalchildren:ReactNode
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:203
Optional custom content to display in the modal body If not provided, shows the confirmationMessage
className?
optionalclassName:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:73
Additional CSS class name for the modal
Inherited from
InterfaceCrudModalBaseProps.className
data-testid?
optionaldata-testid:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:84
Test ID for the modal container (useful for testing)
Inherited from
InterfaceCrudModalBaseProps.data-testid
entityName?
optionalentityName:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:215
Name of the entity being deleted (for display purposes) When provided, will be shown in the confirmation message
error?
optionalerror:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:62
Error message to display in the modal body When provided, shows an Alert component with the error
Inherited from
InterfaceCrudModalBaseProps.error
loading?
optionalloading:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:56
Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons
Inherited from
InterfaceCrudModalBaseProps.loading
onClose()
onClose: () =>
void
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:37
Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key
Returns
void
Inherited from
InterfaceCrudModalBaseProps.onClose
onDelete()
onDelete: () =>
void|Promise<void>
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:209
Callback function invoked when deletion is confirmed Should handle the delete logic and return a Promise
Returns
void | Promise<void>
open?
optionalopen:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:26
Controls whether the modal is visible (defaults to false)
Inherited from
InterfaceCrudModalBaseProps.open
primaryText?
optionalprimaryText:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:43
Text for the primary action button
Inherited from
InterfaceCrudModalBaseProps.primaryText
recurringEventContent?
optionalrecurringEventContent:ReactNode
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:227
Optional content to display for recurring event support Allows users to choose between deleting series or single instance
secondaryText?
optionalsecondaryText:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:49
Text for the secondary action button
Inherited from
InterfaceCrudModalBaseProps.secondaryText
showWarning?
optionalshowWarning:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:221
Whether to show warning styling (danger variant)
size?
optionalsize:ModalSize
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:68
Modal size variant
Inherited from
InterfaceCrudModalBaseProps.size
title
title:
string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:31
Modal title displayed in the header