Interface CreateOrgApplicationOptions<TFormCustomFields, TOrganizationCustomFields>

interface CreateOrgApplicationOptions<TFormCustomFields, TOrganizationCustomFields> {
    services: {
        organizationApi: Pick<OrganizationApi, "createOrganization">;
    };
    settings: {
        formDataToApi?: ((formData) => CreateOrganizationDto<TOrganizationCustomFields>);
        privacyPolicyUrl?: string;
        successRoute: string;
        userAgreementUrl?: string;
    };
    views?: {
        Form?: ComponentClass<{
            blockProps: BlockComponentProps;
            handleSubmit: ((formData) => Promise<unknown>);
            isSubmitting: boolean;
            privacyPolicyUrl?: string;
            userAgreementUrl?: string;
        }, any> | FunctionComponent<{
            blockProps: BlockComponentProps;
            handleSubmit: ((formData) => Promise<unknown>);
            isSubmitting: boolean;
            privacyPolicyUrl?: string;
            userAgreementUrl?: string;
        }>;
    };
}

Type Parameters

  • TFormCustomFields

  • TOrganizationCustomFields

Properties

services settings views?

Properties

services

services: {
    organizationApi: Pick<OrganizationApi, "createOrganization">;
}

Type declaration

  • organizationApi: Pick<OrganizationApi, "createOrganization">

    The client API for organizations

settings

settings: {
    formDataToApi?: ((formData) => CreateOrganizationDto<TOrganizationCustomFields>);
    privacyPolicyUrl?: string;
    successRoute: string;
    userAgreementUrl?: string;
}

Type declaration

  • Optional formDataToApi?: ((formData) => CreateOrganizationDto<TOrganizationCustomFields>)

    Callback to convert form data to API

  • Optional privacyPolicyUrl?: string

    When provided, a checkbox to confirm that the given privacy policy was read will be present

  • successRoute: string

    Route to redirect to after application success

  • Optional userAgreementUrl?: string

    When provided, a checkbox to confirm that the given user agreement was read will be present

Optional views

views?: {
    Form?: ComponentClass<{
        blockProps: BlockComponentProps;
        handleSubmit: ((formData) => Promise<unknown>);
        isSubmitting: boolean;
        privacyPolicyUrl?: string;
        userAgreementUrl?: string;
    }, any> | FunctionComponent<{
        blockProps: BlockComponentProps;
        handleSubmit: ((formData) => Promise<unknown>);
        isSubmitting: boolean;
        privacyPolicyUrl?: string;
        userAgreementUrl?: string;
    }>;
}

Type declaration

  • Optional Form?: ComponentClass<{
        blockProps: BlockComponentProps;
        handleSubmit: ((formData) => Promise<unknown>);
        isSubmitting: boolean;
        privacyPolicyUrl?: string;
        userAgreementUrl?: string;
    }, any> | FunctionComponent<{
        blockProps: BlockComponentProps;
        handleSubmit: ((formData) => Promise<unknown>);
        isSubmitting: boolean;
        privacyPolicyUrl?: string;
        userAgreementUrl?: string;
    }>

    View for the form

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc