Interface OrganizationRegistrationProps<TFormCustomFields>

interface OrganizationRegistrationProps<TFormCustomFields> {
    customFields?: {
        organizationDetails?: FormCustomFieldDefinition<OrganizationRegistrationFormData<TFormCustomFields>, "customFields", string>[];
    };
    defaultValues?: Partial<OrganizationRegistrationFormData<TFormCustomFields>>;
    description?: ReactNode;
    errorMessages: Record<string, string>;
    isRequiredExplanation: string;
    isSubmitting?: boolean;
    labels: {
        organizationName: string;
        submitButton?: string;
    };
    modal: {
        description: string;
        submitButtonText: string;
        title: string;
    };
    onConfirm: (() => void);
    onSubmit: ((formData) => void);
    placeholders: {
        organizationName: string;
    };
    screenMode: "desktop" | "mobile";
    showModal: boolean;
    subtext?: ReactNode;
    title: string;
}

Type Parameters

  • TFormCustomFields

Properties

customFields? defaultValues? description? errorMessages isRequiredExplanation isSubmitting? labels modal onConfirm onSubmit placeholders screenMode showModal subtext? title

Properties

Optional customFields

customFields?: {
    organizationDetails?: FormCustomFieldDefinition<OrganizationRegistrationFormData<TFormCustomFields>, "customFields", string>[];
}

Custom fields to display in the form

Type declaration

Optional defaultValues

defaultValues?: Partial<OrganizationRegistrationFormData<TFormCustomFields>>

Initial values for the form

Optional description

description?: ReactNode

Description for the form

errorMessages

errorMessages: Record<string, string>

Error messages for this form

isRequiredExplanation

isRequiredExplanation: string

Text to explain what red asterisk means

Optional isSubmitting

isSubmitting?: boolean

Disables the form while submitting

labels

labels: {
    organizationName: string;
    submitButton?: string;
}

Labels for each field

Type declaration

  • organizationName: string
  • Optional submitButton?: string

modal

modal: {
    description: string;
    submitButtonText: string;
    title: string;
}

Type declaration

  • description: string
  • submitButtonText: string
  • title: string

onConfirm

onConfirm: (() => void)

Type declaration

    • (): void

    • Returns void

onSubmit

onSubmit: ((formData) => void)

Type declaration

placeholders

placeholders: {
    organizationName: string;
}

Placeholders for each field

Type declaration

  • organizationName: string

screenMode

screenMode: "desktop" | "mobile"

Screen mode

showModal

showModal: boolean

Optional subtext

subtext?: ReactNode

Description subtext for the form

title

title: string

Title text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc