HybridForms API
    Preparing search index...

    Interface IFormButtonOptions

    BaseButton options.

    interface IFormButtonOptions {
        audioFeedback?: boolean;
        callbackFeedback?: boolean;
        clickHandler: (ev: any) => Promise<any>;
        disableOnClick?: boolean;
        heading?: string;
        icon?: string;
        label?: string;
        showProgress?: boolean;
        style?: FormButtonStyle;
        toggleButton?: boolean;
        type: FormButtonType;
        vibrationFeedback?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    audioFeedback? callbackFeedback? clickHandler disableOnClick? heading? icon? label? showProgress? style? toggleButton? type vibrationFeedback?

    Properties

    audioFeedback?: boolean

    Gives the user an audio feedback when the button is clicked

    callbackFeedback?: boolean

    Gives the user an audio feedback when the clickHandler promise is fullfilled.

    clickHandler: (ev: any) => Promise<any>

    A function that gets called when the button was clicked. Must return a Promise

    disableOnClick?: boolean

    If set to true, the button gets disabled when clicked

    heading?: string

    An optional heading for the button

    icon?: string

    The icon of the button. if omitted no icon gets printed

    label?: string

    The label of the button. If omitted no label gets printed.

    showProgress?: boolean

    Shows Progress rings on the butten when the button is clicked, until the clickHandler promise is fullfilled.

    style?: FormButtonStyle

    The style of the button.

    toggleButton?: boolean

    Toggles the state of the button.

    type: FormButtonType

    The type of the button.

    vibrationFeedback?: boolean

    If set to true, the device vibrates on a button click (only on devices/platforms that supports vibration).

    Settings

    Member Visibility

    On This Page

    Properties