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)

Properties

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

Properties

OptionalaudioFeedback

audioFeedback?: boolean

Gives the user an audio feedback when the button is clicked

OptionalcallbackFeedback

callbackFeedback?: boolean

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

clickHandler

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

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

OptionaldisableOnClick

disableOnClick?: boolean

If set to true, the button gets disabled when clicked

Optionalheading

heading?: string

An optional heading for the button

Optionalicon

icon?: string

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

Optionallabel

label?: string

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

OptionalshowProgress

showProgress?: boolean

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

Optionalstyle

style?: FormButtonStyle

The style of the button.

OptionaltoggleButton

toggleButton?: boolean

Toggles the state of the button.

type

type: FormButtonType

The type of the button.

OptionalvibrationFeedback

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