Skip to main content

InterfaceCreateModalProps

Admin Docs


Interface: InterfaceCreateModalProps

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

Props for CreateModal template

Specialized template for creating new entities with form submission.

Extends

Properties

centered?

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

children: ReactNode

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

Form content to render inside the modal body


className?

optional className: string

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

Additional CSS class name for the modal

Inherited from

InterfaceCrudModalBaseProps.className


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)

Inherited from

InterfaceCrudModalBaseProps.data-testid


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

Inherited from

InterfaceCrudModalBaseProps.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

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


onSubmit()

onSubmit: (event) => void | Promise<void>

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

Callback function invoked when the form is submitted Should handle the creation logic and return a Promise

Parameters

event

FormEvent<HTMLFormElement>

Returns

void | Promise<void>


open?

optional open: 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?

optional primaryText: string

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

Text for the primary action button

Inherited from

InterfaceCrudModalBaseProps.primaryText


secondaryText?

optional secondaryText: string

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

Text for the secondary action button

Inherited from

InterfaceCrudModalBaseProps.secondaryText


size?

optional size: ModalSize

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

Modal size variant

Inherited from

InterfaceCrudModalBaseProps.size


submitDisabled?

optional submitDisabled: boolean

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

Whether the submit button should be disabled Useful for form validation


title

title: string

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

Modal title displayed in the header

Inherited from

InterfaceCrudModalBaseProps.title