PCUI API Reference - v5.2.0
    Preparing search index...

    Interface MenuArgs

    The arguments for the Menu constructor.

    interface MenuArgs {
        alignItems?: string;
        binding?: BindingBase;
        children?: ReactNode;
        class?: string | string[];
        dom?: string | HTMLElement;
        enabled?: boolean;
        error?: boolean;
        flex?: boolean;
        flexBasis?: string;
        flexDirection?: string;
        flexGrow?: string;
        flexShrink?: string;
        flexWrap?: string;
        grid?: boolean;
        height?: number;
        hidden?: boolean;
        id?: string;
        ignoreParent?: boolean;
        isRoot?: boolean;
        items?: MenuItemArgs[];
        link?: { observer: Observer | Observer[]; path: string | string[] };
        onChange?: (value: any) => void;
        onClick?: () => void;
        onRemove?: () => void;
        onResize?: () => void;
        parent?: Element;
        readOnly?: boolean;
        resizable?: string;
        resizeMax?: number;
        resizeMin?: number;
        scrollable?: boolean;
        style?: string;
        tabIndex?: number;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    alignItems?: string

    Sets the Container's align items property.

    binding?: BindingBase

    A binding to use with this Element.

    children?: ReactNode

    The children of the current component.

    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.

    flex?: boolean

    Sets whether the element uses flex layout.

    flexBasis?: string

    Sets the element's flexBasis CSS property.

    flexDirection?: string

    Sets the element's flexDirection CSS property.

    flexGrow?: string

    Sets the element's flexGrow CSS property.

    flexShrink?: string

    Sets the element's flexShrink CSS property.

    flexWrap?: string

    Sets the element's flexWrap CSS property.

    grid?: boolean

    Sets whether the Container supports the grid layout.

    height?: number

    Sets the initial height of the Element.

    hidden?: boolean

    Sets whether this Menu is hidden. Defaults to true.

    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.

    items?: MenuItemArgs[]

    An array of MenuItemArgs. If these are passed then new MenuItems will be created and appended to the menu.

    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.

    onResize?: () => void

    Called when the Container has been resized.

    parent?: Element

    Sets the parent Element.

    readOnly?: boolean

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

    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.

    resizeMax?: number

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

    resizeMin?: number

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

    scrollable?: boolean

    Sets whether the Container should be scrollable.

    style?: string

    Sets an initial value for Element.dom.style.

    tabIndex?: number

    Sets the tabIndex of the Menu. Defaults to 1.

    width?: number

    Sets the initial width of the Element.

    Settings

    Member Visibility

    On This Page

    Properties