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

    Interface MenuItemArgs

    The arguments for the MenuItem constructor.

    interface MenuItemArgs {
        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;
        hasChildren?: boolean;
        height?: number;
        hidden?: boolean;
        icon?: string;
        id?: string;
        ignoreParent?: boolean;
        isRoot?: boolean;
        items?: MenuItemArgs[];
        link?: { observer: Observer | Observer[]; path: string | string[] };
        menu?: any;
        onChange?: (value: any) => void;
        onClick?: () => void;
        onIsEnabled?: () => boolean;
        onIsVisible?: () => boolean;
        onRemove?: () => void;
        onResize?: () => void;
        onSelect?: (evt?: MouseEvent) => void;
        parent?: Element;
        readOnly?: boolean;
        resizable?: string;
        resizeMax?: number;
        resizeMin?: number;
        scrollable?: boolean;
        style?: string;
        tabIndex?: number;
        text?: string;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alignItems? binding? children? class? dom? enabled? error? flex? flexBasis? flexDirection? flexGrow? flexShrink? flexWrap? grid? hasChildren? height? hidden? icon? id? ignoreParent? isRoot? items? link? menu? onChange? onClick? onIsEnabled? onIsVisible? onRemove? onResize? onSelect? parent? readOnly? resizable? resizeMax? resizeMin? scrollable? style? tabIndex? text? 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.

    hasChildren?: boolean

    Whether the MenuItem has any child MenuItems.

    height?: number

    Sets the initial height of the Element.

    hidden?: boolean

    Sets whether this Element is hidden. Defaults to false.

    icon?: string

    Sets the CSS code for an icon for the MenuItem. e.g. 'E401' (notice we omit the '\' character).

    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 MenuItem constructor data. If defined then child MenuItems will be created and added to the MenuItem.

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

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

    menu?: any

    Sets the parent Menu 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.

    onIsEnabled?: () => boolean

    Sets the function that determines whether the MenuItem should be enabled when the Menu is shown.

    onIsVisible?: () => boolean

    Sets the function that determines whether the MenuItem should be visible when the Menu is shown.

    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.

    onSelect?: (evt?: MouseEvent) => void

    Sets the function called when we select the MenuItem.

    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 Element.

    Optionaltext

    text?: string

    Sets the text shown on the MenuItem.

    width?: number

    Sets the initial width of the Element.

    Settings

    Member Visibility

    On This Page

    Properties