Interface DesiredCompensationProps

interface DesiredCompensationProps {
    compensationInfo: {
        amounts: {
            key: string;
            label: string;
        }[];
        key: string;
        label: string;
    }[];
    defaultValues?: Partial<DesiredCompensationFormData>;
    disableCancelButton?: boolean;
    disableSubmitButton?: boolean;
    labels: {
        cancelButton?: string;
        compensationAmount: string;
        compensationType: string;
        submitButton?: string;
    };
    onCancel?: (() => void);
    onSubmit?: ((formData) => void);
    placeholders: {
        compensationAmount: string;
        compensationType: string;
    };
    progress?: {
        current: number;
        total: number;
    };
    progressCompletionText?: string;
    screenMode: "desktop" | "mobile";
    title: string;
}

Properties

compensationInfo defaultValues? disableCancelButton? disableSubmitButton? labels onCancel? onSubmit? placeholders progress? progressCompletionText? screenMode title

Properties

compensationInfo

compensationInfo: {
    amounts: {
        key: string;
        label: string;
    }[];
    key: string;
    label: string;
}[]

Configuration for compensation information (list of types, and amounts for each type)

Type declaration

  • amounts: {
        key: string;
        label: string;
    }[]
  • key: string
  • label: string

Optional defaultValues

defaultValues?: Partial<DesiredCompensationFormData>

Initial values for the form

Optional disableCancelButton

disableCancelButton?: boolean

disable cancel button override

Optional disableSubmitButton

disableSubmitButton?: boolean

disable submit button override

labels

labels: {
    cancelButton?: string;
    compensationAmount: string;
    compensationType: string;
    submitButton?: string;
}

Labels for each field

Type declaration

  • Optional cancelButton?: string
  • compensationAmount: string
  • compensationType: string
  • Optional submitButton?: string

Optional onCancel

onCancel?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onSubmit

onSubmit?: ((formData) => void)

Type declaration

placeholders

placeholders: {
    compensationAmount: string;
    compensationType: string;
}

Placeholders for each field

Type declaration

  • compensationAmount: string
  • compensationType: 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