Interface LabelArgs

The arguments for the Label constructor.

interface LabelArgs {
    allowTextSelection?: boolean;
    binding?: BindingBase;
    class?: string | string[];
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    flex?: boolean;
    flexBasis?: string;
    flexDirection?: string;
    flexGrow?: string;
    flexShrink?: string;
    flexWrap?: string;
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    nativeTooltip?: boolean;
    onChange?: ((value) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    parent?: Element;
    placeholder?: string;
    readOnly?: boolean;
    renderChanges?: boolean;
    style?: string;
    tabIndex?: number;
    text?: string;
    unsafe?: boolean;
    value?: string;
    values?: any[];
    width?: number;
}

Hierarchy (view full)

  • ElementArgs
  • IBindableArgs
  • IPlaceholderArgs
  • IFlexArgs
    • LabelArgs

Properties

allowTextSelection? binding? class? dom? enabled? error? flex? flexBasis? flexDirection? flexGrow? flexShrink? flexWrap? height? hidden? id? ignoreParent? isRoot? link? nativeTooltip? onChange? onClick? onRemove? parent? placeholder? readOnly? renderChanges? style? tabIndex? text? unsafe? value? values? width?

Properties

Optional allowTextSelection

allowTextSelection?: boolean

If true then the label can be clicked to select text. Defaults to false.

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 DOM element or its type to use for this component. Defaults to 'span'.

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 flex

flex?: boolean

Sets whether the element uses flex layout.

Optional flexBasis

flexBasis?: string

Sets the element's flexBasis CSS property.

Optional flexDirection

flexDirection?: string

Sets the element's flexDirection CSS property.

Optional flexGrow

flexGrow?: string

Sets the element's flexGrow CSS property.

Optional flexShrink

flexShrink?: string

Sets the element's flexShrink CSS property.

Optional flexWrap

flexWrap?: string

Sets the element's flexWrap CSS property.

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 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 nativeTooltip

nativeTooltip?: boolean

If true then use the text of the label as the native HTML tooltip. Defaults to false.

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 placeholder

placeholder?: string

Sets the placeholder label that appears on the right of the input.

Optional readOnly

readOnly?: boolean

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

Optional renderChanges

renderChanges?: boolean

If true each input will flash on changes.

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 Label. 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 value

value?: string

Sets the value of the Label. Defaults to ''.

Optional values

values?: any[]

Sets multiple values to the Element. It is up to the Element to determine how to display them.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

allowTextSelectionbindingclassdomenablederrorflexflexBasisflexDirectionflexGrowflexShrinkflexWrapheighthiddenidignoreParentisRootlinknativeTooltiponChangeonClickonRemoveparentplaceholderreadOnlyrenderChangesstyletabIndextextunsafevaluevalueswidth