Skip to main content

InterfaceCrudModalBaseProps

Admin Docs


Interface: InterfaceCrudModalBaseProps

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:22

Base props shared by all CRUD modal templates

These properties are common across all modal types and provide the fundamental functionality for opening, closing, and displaying modals.

Extended by

Properties

centered?

optional centered: boolean

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:79

Whether to center the modal vertically on the page


className?

optional className: string

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:73

Additional CSS class name for the modal


data-testid?

optional data-testid: string

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:84

Test ID for the modal container (useful for testing)


error?

optional error: 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


loading?

optional loading: 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


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


open?

optional open: boolean

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:26

Controls whether the modal is visible (defaults to false)


primaryText?

optional primaryText: string

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:43

Text for the primary action button


secondaryText?

optional secondaryText: string

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:49

Text for the secondary action button


size?

optional size: ModalSize

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:68

Modal size variant


title

title: string

Defined in: src/types/shared-components/CRUDModalTemplate/interface.ts:31

Modal title displayed in the header