Skip to main content

Interface: InflowFormProps

Props for the InflowForm component

Properties​

onSubmit()​

onSubmit: (values) => Promise<void>

Callback function that handles form submission

Parameters​

values​

infer

The validated form values

Returns​

Promise<void>

A promise that resolves when the submission is complete

defaultValues?​

optional defaultValues: any

Optional initial values for the form fields

Remarks​

  • If provided, the form will be pre-filled with these values
  • Useful for edit mode where you want to show existing inflow data

isEditing?​

optional isEditing: boolean

Flag indicating if the form is in edit mode

Remarks​

Changes the form's behavior and UI elements to reflect editing an existing inflow

Default​

false

isSubmitting?​

optional isSubmitting: boolean

Flag indicating if the form is currently submitting

Remarks​

When true, disables form inputs and shows loading state

Default​

false

className?​

optional className: string

Optional CSS class name for styling the form container

title?​

optional title: string

Optional custom title for the form

Remarks​

If not provided, defaults to "Record New Inflow" or "Edit Inflow" based on isEditing

description?​

optional description: string

Optional custom description for the form

Remarks​

If not provided, defaults to a context-appropriate description based on isEditing