Interface ButtonArgs

The arguments for the Button constructor.

interface ButtonArgs {
    binding?: BindingBase;
    class?: string | string[];
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    height?: number;
    hidden?: boolean;
    icon?: string;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    onChange?: ((value) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    readOnly?: boolean;
    size?: "small";
    style?: string;
    tabIndex?: number;
    text?: string;
    unsafe?: boolean;
    width?: number;
}

Hierarchy (view full)

Properties

binding? class? dom? enabled? error? height? hidden? icon? id? ignoreParent? isRoot? link? onChange? onClick? onRemove? parent? readOnly? size? style? tabIndex? text? unsafe? width?

Properties

Optional binding

binding?: BindingBase

A binding to use with this Element.

Optional class

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optional dom

dom?: string | HTMLElement

The HTMLElement to create this Element with. If not provided this Element will create one.

Optional enabled

enabled?: boolean

Sets whether it is possible to interact with this Element and its children.

Optional error

error?: boolean

Sets whether the Element is in an error state.

Optional height

height?: number

Sets the initial height of the Element.

Optional hidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optional icon

icon?: string

The CSS code for an icon for the button. e.g. 'E401' (notice we omit the '\' character). Defaults to ''.

Optional id

id?: string

The id attribute of this Element's HTMLElement.

Optional ignoreParent

ignoreParent?: boolean

If true, this Element will ignore its parent's enabled value when determining whether this element is enabled. Defaults to false.

Optional isRoot

isRoot?: boolean

Sets whether this Element is at the root of the hierarchy.

Optional link

link?: {
    observer: Observer | Observer[];
    path: string | string[];
}

Links the observer attribute at the path location in the given observer to this Element.

Type declaration

  • observer: Observer | Observer[]
  • path: string | string[]

Optional onChange

onChange?: ((value) => void)

If provided and the Element is changeable, this function will be called each time the element value is changed.

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Optional onClick

onClick?: (() => void)

If provided and the Element is clickable, this function will be called each time the element is clicked.

Type declaration

    • (): void

    • Returns void

Optional onRemove

onRemove?: (() => void)

If provided and the Element is removable, this function will be called each time the element is removed.

Type declaration

    • (): void

    • Returns void

Optional parent

parent?: Element

Sets the parent Element.

Optional readOnly

readOnly?: boolean

Whether this Element is read only or not. Defaults to false.

Optional size

size?: "small"

Sets the 'size' type of the button. Can be 'small' or null. Defaults to null.

Optional style

style?: string

Sets an initial value for Element.dom.style.

Optional tabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optional text

text?: string

Sets the text of the button. Defaults to ''.

Optional unsafe

unsafe?: boolean

If true, the innerHTML property will be used to set the text. Otherwise, textContent will be used instead. Defaults to false.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

bindingclassdomenablederrorheighthiddeniconidignoreParentisRootlinkonChangeonClickonRemoveparentreadOnlysizestyletabIndextextunsafewidth