Interface OrganizationApplicationProps<TFormCustomFields>

interface OrganizationApplicationProps<TFormCustomFields> {
    customFields?: {
        organizationSectionEnd?: FormCustomFieldDefinition<OrganizationApplicationFormData<TFormCustomFields>, "customFields", string>[];
        organizationSectionStart?: FormCustomFieldDefinition<OrganizationApplicationFormData<TFormCustomFields>, "customFields", string>[];
    };
    defaultValues?: Partial<OrganizationApplicationFormData<TFormCustomFields>>;
    description: string;
    errorMessages: {
        emailInvalid: string;
    };
    isRequiredExplanation: string;
    isSubmitting?: boolean;
    labels: {
        agreeToPrivacyPolicy?: string;
        agreeToUserAgreement?: string;
        applicationSection: string;
        applicationUserEmail: string;
        applicationUserName: string;
        applicationUserPhoneNumber: string;
        cityTownVillage: string;
        locationSection: string;
        organizationName: string;
        organizationSection: string;
        prefecture: string;
        representativePersonName: string;
        representativePhoneNumber: string;
        submitButton?: string;
        townStreetBuilding: string;
        zipCode: string;
    };
    onSubmit?: ((formData) => void);
    placeholders: {
        applicationUserEmail: string;
        applicationUserName: string;
        applicationUserPhoneNumber: string;
        cityTownVillage: string;
        organizationName: string;
        prefecture: string;
        representativePersonName: string;
        representativePhoneNumber: string;
        townStreetBuilding: string;
        zipCode: string;
    };
    privacyPolicyUrl?: string;
    screenMode: "desktop" | "mobile";
    title: string;
    userAgreementUrl?: string;
}

Type Parameters

  • TFormCustomFields

Properties

customFields? defaultValues? description errorMessages isRequiredExplanation isSubmitting? labels onSubmit? placeholders privacyPolicyUrl? screenMode title userAgreementUrl?

Properties

Optional customFields

customFields?: {
    organizationSectionEnd?: FormCustomFieldDefinition<OrganizationApplicationFormData<TFormCustomFields>, "customFields", string>[];
    organizationSectionStart?: FormCustomFieldDefinition<OrganizationApplicationFormData<TFormCustomFields>, "customFields", string>[];
}

Custom fields to display in the form

Type declaration

Optional defaultValues

defaultValues?: Partial<OrganizationApplicationFormData<TFormCustomFields>>

Initial values for the form

description

description: string

Description for the form

errorMessages

errorMessages: {
    emailInvalid: string;
}

Error messages for this form

Type declaration

  • emailInvalid: string

isRequiredExplanation

isRequiredExplanation: string

Text to explain what red asterisk means

Optional isSubmitting

isSubmitting?: boolean

Disables the form while submitting

labels

labels: {
    agreeToPrivacyPolicy?: string;
    agreeToUserAgreement?: string;
    applicationSection: string;
    applicationUserEmail: string;
    applicationUserName: string;
    applicationUserPhoneNumber: string;
    cityTownVillage: string;
    locationSection: string;
    organizationName: string;
    organizationSection: string;
    prefecture: string;
    representativePersonName: string;
    representativePhoneNumber: string;
    submitButton?: string;
    townStreetBuilding: string;
    zipCode: string;
}

Labels for each field

Type declaration

  • Optional agreeToPrivacyPolicy?: string

    For this label, place the text you want to be inside of a link inside of asterisks

  • Optional agreeToUserAgreement?: string

    For this label, place the text you want to be inside of a link inside of asterisks

  • applicationSection: string
  • applicationUserEmail: string
  • applicationUserName: string
  • applicationUserPhoneNumber: string
  • cityTownVillage: string
  • locationSection: string
  • organizationName: string
  • organizationSection: string
  • prefecture: string
  • representativePersonName: string
  • representativePhoneNumber: string
  • Optional submitButton?: string
  • townStreetBuilding: string
  • zipCode: string

Optional onSubmit

onSubmit?: ((formData) => void)

Type declaration

placeholders

placeholders: {
    applicationUserEmail: string;
    applicationUserName: string;
    applicationUserPhoneNumber: string;
    cityTownVillage: string;
    organizationName: string;
    prefecture: string;
    representativePersonName: string;
    representativePhoneNumber: string;
    townStreetBuilding: string;
    zipCode: string;
}

Placeholders for each field

Type declaration

  • applicationUserEmail: string
  • applicationUserName: string
  • applicationUserPhoneNumber: string
  • cityTownVillage: string
  • organizationName: string
  • prefecture: string
  • representativePersonName: string
  • representativePhoneNumber: string
  • townStreetBuilding: string
  • zipCode: string

Optional privacyPolicyUrl

privacyPolicyUrl?: string

URL to the privacy policy URL. If present, must tick checkbox to submit form

screenMode

screenMode: "desktop" | "mobile"

Screen mode

title

title: string

Title text

Optional userAgreementUrl

userAgreementUrl?: string

URL to the user agreement URL. If present, must tick checkbox to submit form

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc