PCUI API Reference - v6.1.3
    Preparing search index...

    Interface ButtonArgs

    The arguments for the Button constructor.

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

    Hierarchy (View Summary)

    Index

    Properties

    alignItems? alignSelf? binding? class? dom? enabled? error? flexBasis? flexDirection? flexGrow? flexShrink? flexWrap? height? hidden? icon? id? ignoreParent? isRoot? justifyContent? justifySelf? link? onChange? onClick? onRemove? parent? readOnly? size? style? tabIndex? text? unsafe? width?

    Properties

    alignItems?: string

    Sets the element's alignItems CSS property.

    alignSelf?: string

    Sets the element's alignSelf CSS property.

    binding?: BindingBase

    A binding to use with this Element.

    class?: string | string[]

    The class attribute of this Element's HTMLElement.

    dom?: string | HTMLElement

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

    enabled?: boolean

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

    error?: boolean

    Sets whether the Element is in an error state.

    flexBasis?: string | number

    Sets the element's flexBasis CSS property.

    flexDirection?: string

    Sets the element's flexDirection CSS property.

    flexGrow?: string | number

    Sets the element's flexGrow CSS property.

    flexShrink?: string | number

    Sets the element's flexShrink CSS property.

    flexWrap?: string

    Sets the element's flexWrap CSS property.

    height?: number

    Sets the initial height of the Element.

    hidden?: boolean

    Sets whether this Element is hidden. Defaults to false.

    icon?: string

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

    id?: string

    The id attribute of this Element's HTMLElement.

    ignoreParent?: boolean

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

    isRoot?: boolean

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

    justifyContent?: string

    Sets the element's justifyContent CSS property.

    justifySelf?: string

    Sets the element's justifySelf CSS property.

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

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

    onChange?: (value: any) => void

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

    onClick?: () => void

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

    onRemove?: () => void

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

    parent?: Element

    Sets the parent Element.

    readOnly?: boolean

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

    size?: "small"

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

    style?: string

    Sets an initial value for Element.dom.style.

    tabIndex?: number

    Sets the tabIndex of the Element.

    Optionaltext

    text?: string

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

    unsafe?: boolean

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

    width?: number

    Sets the initial width of the Element.

    Settings

    Member Visibility

    On This Page

    Properties