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) => void);
    onClick?: (() => void);
    onContextMenu?: ((evt, item) => 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

Optional alignItems

alignItems?: string

Sets the Container's align items property.

Optional allowDrag

allowDrag?: boolean

Whether dragging a TreeViewItem is allowed. Defaults to true.

Optional allowRenaming

allowRenaming?: boolean

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

Optional allowReordering

allowReordering?: boolean

Whether reordering TreeViewItems is allowed. Defaults to true.

Optional binding

binding?: BindingBase

A binding to use with this Element.

Optional children

children?: ReactNode

The children of the current component.

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 dragScrollElement

dragScrollElement?: HTMLElement

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

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 filter

filter?: string

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

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 grid

grid?: boolean

Sets whether the Container supports the grid layout.

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

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

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

Type declaration

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 onReparent

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.

Optional onResize

onResize?: (() => void)

Called when the Container has been resized.

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 resizable

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.

Optional resizeMax

resizeMax?: number

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

Optional resizeMin

resizeMin?: number

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

Optional scrollable

scrollable?: boolean

Sets whether the Container should be scrollable.

Optional style

style?: string

Sets an initial value for Element.dom.style.

Optional tabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

alignItemsallowDragallowRenamingallowReorderingbindingchildrenclassdomdragScrollElementenablederrorfilterflexflexBasisflexDirectionflexGrowflexShrinkflexWrapgridheighthiddenidignoreParentisRootlinkonChangeonClickonContextMenuonRemoveonReparentonResizeparentreadOnlyresizableresizeMaxresizeMinscrollablestyletabIndexwidth