Interface OrganizationUpdateProps<TFormCustomFields>

interface OrganizationUpdateProps<TFormCustomFields> {
    customFields?: {
        organizationDetails?: FormCustomFieldDefinition<OrganizationUpdateFormData<TFormCustomFields>, "customFields", string>[];
    };
    defaultValues?: Partial<OrganizationUpdateFormData<TFormCustomFields>>;
    isSubmitting?: boolean;
    labels: {
        cityTownVillage: string;
        errorUploading: string;
        iconAddImage: string;
        iconUrl: string;
        logoAddImage: string;
        logoUrl: string;
        organizationName: string;
        phoneNumber: string;
        postcode: string;
        prefecture: string;
        removeImage: string;
        replaceImage: string;
        submitButton?: string;
        townStreetBuilding: string;
    };
    onSubmit: ((formData) => void);
    placeholders: {
        cityTownVillage: string;
        iconUrl: string;
        logoUrl: string;
        organizationName: string;
        phoneNumber: string;
        postcode: string;
        prefecture: string;
        townStreetBuilding: string;
    };
    screenMode: "desktop" | "mobile";
    subtitle: string;
    title: string;
}

Type Parameters

  • TFormCustomFields

Properties

customFields? defaultValues? isSubmitting? labels onSubmit placeholders screenMode subtitle title

Properties

Optional customFields

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

Custom fields to display in the form

Type declaration

Optional defaultValues

defaultValues?: Partial<OrganizationUpdateFormData<TFormCustomFields>>

Initial values for the form

Optional isSubmitting

isSubmitting?: boolean

Disables the form while submitting

labels

labels: {
    cityTownVillage: string;
    errorUploading: string;
    iconAddImage: string;
    iconUrl: string;
    logoAddImage: string;
    logoUrl: string;
    organizationName: string;
    phoneNumber: string;
    postcode: string;
    prefecture: string;
    removeImage: string;
    replaceImage: string;
    submitButton?: string;
    townStreetBuilding: string;
}

Labels for each field

Type declaration

  • cityTownVillage: string
  • errorUploading: string
  • iconAddImage: string
  • iconUrl: string
  • logoAddImage: string
  • logoUrl: string
  • organizationName: string
  • phoneNumber: string
  • postcode: string
  • prefecture: string
  • removeImage: string
  • replaceImage: string
  • Optional submitButton?: string
  • townStreetBuilding: string

onSubmit

onSubmit: ((formData) => void)

Type declaration

placeholders

placeholders: {
    cityTownVillage: string;
    iconUrl: string;
    logoUrl: string;
    organizationName: string;
    phoneNumber: string;
    postcode: string;
    prefecture: string;
    townStreetBuilding: string;
}

Placeholders for each field

Type declaration

  • cityTownVillage: string
  • iconUrl: string
  • logoUrl: string
  • organizationName: string
  • phoneNumber: string
  • postcode: string
  • prefecture: string
  • townStreetBuilding: string

screenMode

screenMode: "desktop" | "mobile"

Screen mode

subtitle

subtitle: string

subtitle text

title

title: string

Title text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc