Interface TreeViewArgs

The arguments for the TreeView constructor.

interface TreeViewArgs {
    alignItems?: string;
    allowDrag?: boolean;
    allowRenaming?: boolean;
    allowReordering?: boolean;
    binding?: BindingBase;
    children?: ReactNode;
    class?: string | string[];
    dom?: string | HTMLElement;
    dragScrollElement?: HTMLElement;
    enabled?: boolean;
    error?: boolean;
    filter?: string;
    flex?: boolean;
    flexBasis?: string;
    flexDirection?: string;
    flexGrow?: string;
    flexShrink?: string;
    flexWrap?: string;
    grid?: boolean;
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    onChange?: ((value: any) => void);
    onClick?: (() => void);
    onContextMenu?: ((evt: MouseEvent, item: TreeViewItem) => void);
    onRemove?: (() => void);
    onReparent?: any;
    onResize?: (() => void);
    parent?: Element;
    readOnly?: boolean;
    resizable?: string;
    resizeMax?: number;
    resizeMin?: number;
    scrollable?: boolean;
    style?: string;
    tabIndex?: number;
    width?: number;
}

Hierarchy (view full)

Properties

alignItems? allowDrag? allowRenaming? allowReordering? binding? children? class? dom? dragScrollElement? enabled? error? filter? flex? flexBasis? flexDirection? flexGrow? flexShrink? flexWrap? grid? height? hidden? id? ignoreParent? isRoot? link? onChange? onClick? onContextMenu? onRemove? onReparent? onResize? parent? readOnly? resizable? resizeMax? resizeMin? scrollable? style? tabIndex? width?

Properties

OptionalalignItems

alignItems?: string

Sets the Container's align items property.

OptionalallowDrag

allowDrag?: boolean

Whether dragging a TreeViewItem is allowed. Defaults to true.

OptionalallowRenaming

allowRenaming?: boolean

Whether renaming TreeViewItems is allowed by double clicking on them. Defaults to false.

OptionalallowReordering

allowReordering?: boolean

Whether reordering TreeViewItems is allowed. Defaults to true.

Optionalbinding

binding?: BindingBase

A binding to use with this Element.

Optionalchildren

children?: ReactNode

The children of the current component.

Optionalclass

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optionaldom

dom?: string | HTMLElement

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

OptionaldragScrollElement

dragScrollElement?: HTMLElement

The element to scroll on drag. Defaults to this TreeView's DOM element.

Optionalenabled

enabled?: boolean

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

Optionalerror

error?: boolean

Sets whether the Element is in an error state.

Optionalfilter

filter?: string

A filter that searches TreeViewItems and only shows the ones that are relevant to the filter.

Optionalflex

flex?: boolean

Sets whether the element uses flex layout.

OptionalflexBasis

flexBasis?: string

Sets the element's flexBasis CSS property.

OptionalflexDirection

flexDirection?: string

Sets the element's flexDirection CSS property.

OptionalflexGrow

flexGrow?: string

Sets the element's flexGrow CSS property.

OptionalflexShrink

flexShrink?: string

Sets the element's flexShrink CSS property.

OptionalflexWrap

flexWrap?: string

Sets the element's flexWrap CSS property.

Optionalgrid

grid?: boolean

Sets whether the Container supports the grid layout.

Optionalheight

height?: number

Sets the initial height of the Element.

Optionalhidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optionalid

id?: string

The id attribute of this Element's HTMLElement.

OptionalignoreParent

ignoreParent?: boolean

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

OptionalisRoot

isRoot?: boolean

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

Optionallink

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

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

OptionalonChange

onChange?: ((value: any) => void)

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

OptionalonClick

onClick?: (() => void)

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

OptionalonContextMenu

onContextMenu?: ((evt: MouseEvent, item: TreeViewItem) => void)

A function to be called when we right click on a TreeViewItem.

OptionalonRemove

onRemove?: (() => void)

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

OptionalonReparent

onReparent?: any

A function to be called when we try to reparent tree items. If a function is provided then the tree items will not be reparented by the TreeView but instead will rely on the function to reparent them as it sees fit.

OptionalonResize

onResize?: (() => void)

Called when the Container has been resized.

Optionalparent

parent?: Element

Sets the parent Element.

OptionalreadOnly

readOnly?: boolean

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

Optionalresizable

resizable?: string

Sets whether the Container is resizable and where the resize handle is located. Can be one of 'top', 'bottom', 'right', 'left'. Defaults to null which disables resizing.

OptionalresizeMax

resizeMax?: number

Sets the maximum size the Container can take when resized in pixels.

OptionalresizeMin

resizeMin?: number

Sets the minimum size the Container can take when resized in pixels.

Optionalscrollable

scrollable?: boolean

Sets whether the Container should be scrollable.

Optionalstyle

style?: string

Sets an initial value for Element.dom.style.

OptionaltabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optionalwidth

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

On This Page

Properties