Interface EditUserBasicInformationForMeOptions<TFormCustomFields, TUserCustomFields>

Represents the props for the EditEditUserBasicInformationForMePage component

interface EditUserBasicInformationForMeOptions<TFormCustomFields, TUserCustomFields> {
    services: {
        userApi: Pick<UserApi<TUserCustomFields>, "getUser" | "updateUser">;
    };
    settings: {
        apiToFormData?: ((user?) => Partial<BasicUserInformationInputFormData<TFormCustomFields>>);
        cancelRoute: string;
        formDataToApi?: ((formData) => UpdateUserDto<TUserCustomFields>);
        successRoute: string;
    };
    views?: {
        Form?: ComponentClass<{
            blockProps: BlockComponentProps;
            defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
            handleCancel: (() => void);
            handleSubmit: ((formData) => Promise<unknown>);
            isLoading: boolean;
            isSubmitting: boolean;
        }, any> | FunctionComponent<{
            blockProps: BlockComponentProps;
            defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
            handleCancel: (() => void);
            handleSubmit: ((formData) => Promise<unknown>);
            isLoading: boolean;
            isSubmitting: boolean;
        }>;
    };
}

Type Parameters

  • TFormCustomFields

  • TUserCustomFields

Properties

services settings views?

Properties

services

services: {
    userApi: Pick<UserApi<TUserCustomFields>, "getUser" | "updateUser">;
}

Type declaration

  • userApi: Pick<UserApi<TUserCustomFields>, "getUser" | "updateUser">

    The user API object with methods for getting and updating user information

settings

settings: {
    apiToFormData?: ((user?) => Partial<BasicUserInformationInputFormData<TFormCustomFields>>);
    cancelRoute: string;
    formDataToApi?: ((formData) => UpdateUserDto<TUserCustomFields>);
    successRoute: string;
}

Type declaration

Optional views

views?: {
    Form?: ComponentClass<{
        blockProps: BlockComponentProps;
        defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
        handleCancel: (() => void);
        handleSubmit: ((formData) => Promise<unknown>);
        isLoading: boolean;
        isSubmitting: boolean;
    }, any> | FunctionComponent<{
        blockProps: BlockComponentProps;
        defaultValues?: Partial<BasicUserInformationInputFormData<TFormCustomFields>>;
        handleCancel: (() => void);
        handleSubmit: ((formData) => Promise<unknown>);
        isLoading: boolean;
        isSubmitting: boolean;
    }>;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc