Interface BasicUserInformationInputProps<TFormCustomFields>

interface BasicUserInformationInputProps<TFormCustomFields> {
    customFields?: {
        afterPersonName?: FormCustomFieldDefinition<BasicUserInformationInputFormData<TFormCustomFields>, "customFields", string>[];
    };
    defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
    isRequiredExplanation: string;
    isSubmitting?: boolean;
    labels: {
        cancelButton?: string;
        cityTownVillage: string;
        contactPhone: string;
        personName: string;
        prefecture: string;
        submitButton?: string;
        townStreetBuilding: string;
        zipCode: string;
    };
    onCancel?: (() => void);
    onSubmit?: ((formData) => void);
    placeholders: {
        cityTownVillage: string;
        contactPhone: string;
        personName: string;
        prefecture: string;
        townStreetBuilding: string;
        zipCode: string;
    };
    progress?: {
        current: number;
        total: number;
    };
    progressCompletionText?: string;
    screenMode: "desktop" | "mobile";
    title: string;
}

Type Parameters

  • TFormCustomFields

Properties

customFields? defaultValues? isRequiredExplanation isSubmitting? labels onCancel? onSubmit? placeholders progress? progressCompletionText? screenMode title

Properties

Optional customFields

customFields?: {
    afterPersonName?: FormCustomFieldDefinition<BasicUserInformationInputFormData<TFormCustomFields>, "customFields", string>[];
}

Custom fields to display in the form

Type declaration

Optional defaultValues

defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>

Initial values for the form

isRequiredExplanation

isRequiredExplanation: string

Text to explain what red asterisk means

Optional isSubmitting

isSubmitting?: boolean

Disable the submission while submitting

labels

labels: {
    cancelButton?: string;
    cityTownVillage: string;
    contactPhone: string;
    personName: string;
    prefecture: string;
    submitButton?: string;
    townStreetBuilding: string;
    zipCode: string;
}

Labels for each field

Type declaration

  • Optional cancelButton?: string
  • cityTownVillage: string
  • contactPhone: string
  • personName: string
  • prefecture: string
  • Optional submitButton?: string
  • townStreetBuilding: string
  • zipCode: string

Optional onCancel

onCancel?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onSubmit

onSubmit?: ((formData) => void)

Type declaration

placeholders

placeholders: {
    cityTownVillage: string;
    contactPhone: string;
    personName: string;
    prefecture: string;
    townStreetBuilding: string;
    zipCode: string;
}

Placeholders for each field

Type declaration

  • cityTownVillage: string
  • contactPhone: string
  • personName: string
  • prefecture: string
  • townStreetBuilding: string
  • zipCode: string

Optional progress

progress?: {
    current: number;
    total: number;
}

Displays a progress indicator at the top of the page (with completion text, if desired)

Type declaration

  • current: number

    Current progress value

  • total: number

    Maximum progress value

Optional progressCompletionText

progressCompletionText?: string

Completion text to show when showing progress indicator

screenMode

screenMode: "desktop" | "mobile"

What size the screen currently is (affects page layout)

title

title: string

Title text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc