Interface SkillSelectionProps

interface SkillSelectionProps {
    defaultValues?: Partial<SkillSelectionFormData>;
    labels: {
        cancelButton?: string;
        skills: string;
        submitButton?: string;
    };
    minimumSelection?: number;
    onCancel?: (() => void);
    onSubmit?: ((formData) => void);
    progress?: {
        current: number;
        total: number;
    };
    progressCompletionText?: string;
    screenMode: "desktop" | "mobile";
    skillGroupKey: string;
    skills: {
        key: string;
        label: string;
    }[];
    subtitle1: string;
    subtitle2?: string;
    title: string;
}

Properties

defaultValues? labels minimumSelection? onCancel? onSubmit? progress? progressCompletionText? screenMode skillGroupKey skills subtitle1 subtitle2? title

Properties

Optional defaultValues

defaultValues?: Partial<SkillSelectionFormData>

Initial values for the form

labels

labels: {
    cancelButton?: string;
    skills: string;
    submitButton?: string;
}

Labels for each field

Type declaration

  • Optional cancelButton?: string
  • skills: string
  • Optional submitButton?: string

Optional minimumSelection

minimumSelection?: number

Minimum number of selections required to submit. Default 0.

Optional onCancel

onCancel?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onSubmit

onSubmit?: ((formData) => void)

Type declaration

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)

skillGroupKey

skillGroupKey: string

Skill group key to group the skill form data by

skills

skills: {
    key: string;
    label: string;
}[]

List of skills to show in this form

Type declaration

  • key: string
  • label: string

subtitle1

subtitle1: string

Subtitle line 1 text

Optional subtitle2

subtitle2?: string

Subtitle line 2 text

title

title: string

Title text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc