Header menu logo fable-electron-docs-api

Options Type

Constructors

Constructor Description

Options(?label, ?accessibilityLabel, ?backgroundColor, ?icon, ?iconPosition, ?click, ?enabled)

Full Usage: Options(?label, ?accessibilityLabel, ?backgroundColor, ?icon, ?iconPosition, ?click, ?enabled)

Parameters:
    ?label : string - Button text.
    ?accessibilityLabel : string - A short description of the button for use by screenreaders like VoiceOver.
    ?backgroundColor : string - Button background color in hex format, i.e #ABCDEF.
    ?icon : U2<NativeImage, string> - Button icon.
    ?iconPosition : IconPosition - Can be left, right or overlay. Defaults to overlay.
    ?click : unit -> unit - Function to call when the button is clicked.
    ?enabled : bool - Whether the button is in an enabled state. Default is true.

Returns: Options
?label : string

Button text.

?accessibilityLabel : string

A short description of the button for use by screenreaders like VoiceOver.

?backgroundColor : string

Button background color in hex format, i.e #ABCDEF.

?icon : U2<NativeImage, string>

Button icon.

?iconPosition : IconPosition

Can be left, right or overlay. Defaults to overlay.

?click : unit -> unit

Function to call when the button is clicked.

?enabled : bool

Whether the button is in an enabled state. Default is true.

Returns: Options

Instance members

Instance member Description

this.accessibilityLabel

Full Usage: this.accessibilityLabel

A short description of the button for use by screenreaders like VoiceOver.

this.backgroundColor

Full Usage: this.backgroundColor

Button background color in hex format, i.e #ABCDEF.

this.click

Full Usage: this.click

Function to call when the button is clicked.

this.enabled

Full Usage: this.enabled

Whether the button is in an enabled state. Default is true.

this.icon

Full Usage: this.icon

Button icon.

this.iconPosition

Full Usage: this.iconPosition

Can be left, right or overlay. Defaults to overlay.

this.label

Full Usage: this.label

Button text.

Type something to start searching.