InterfaceCRUDModalTemplateProps
Interface: InterfaceCRUDModalTemplateProps
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:92
Props for the base CRUDModalTemplate component
This is the foundation component that all specialized modal templates build upon.
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:96
Content to render inside the modal body
className?
optionalclassName:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:73
Additional CSS class name for the modal
Inherited from
InterfaceCrudModalBaseProps.className
customFooter?
optionalcustomFooter:ReactNode
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:127
Custom footer content to replace the default action buttons When provided, primaryText, secondaryText, and onPrimary are ignored
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
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
hideSecondary?
optionalhideSecondary:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:121
Whether to hide the secondary (cancel) button
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
onPrimary()?
optionalonPrimary: () =>void
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:102
Callback function for the primary action button If not provided, the primary button will not be rendered
Returns
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
primaryDisabled?
optionalprimaryDisabled:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:115
Whether to disable the primary button Automatically disabled when loading is true
primaryText?
optionalprimaryText:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:43
Text for the primary action button
Inherited from
InterfaceCrudModalBaseProps.primaryText
primaryVariant?
optionalprimaryVariant:"primary"|"success"|"danger"
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:108
Variant style for the primary button
secondaryText?
optionalsecondaryText:string
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:49
Text for the secondary action button
Inherited from
InterfaceCrudModalBaseProps.secondaryText
showFooter?
optionalshowFooter:boolean
Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:133
Whether to show the modal footer at all
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