NUI Framework

Components

NUI components are source-authored UI building blocks for Unreal Engine. They are organized by category so NUI Script V2 reference pages stay easy to scan as the framework grows.

Implemented components have normal reference pages. Partial, planned, deprecated, and unsupported entries are clearly separated so they are not mistaken for stable usable syntax.

Categories

Status legend

Implemented

Documented as currently usable NUI Script V2 component syntax.

Partially implemented

Shown only with warnings because behavior is incomplete.

Planned

Not available yet and kept out of normal component pages.

Deprecated

Avoid using; follow the replacement guidance.

No current plan

Not part of the current NUI source model.

Needs verification

Not documented as supported until verified.

Contextual properties

Some properties are valid only when a component is authored as a direct child of a matching parent. These rules belong in callouts, not hidden footnotes.

Stack child properties

fill and auto are only valid when the component is an immediate child of Row, Column, HorizontalBox, VerticalBox, StackBox, or ScrollBox. Do not combine auto with fill.

nui
Row HeaderRow {
    gap: 8

    children {
        Text Title {
            text: "Inventory"
            fill: 1
        }

        Button CloseButton {
            text: "Close"
            command: "CloseInventory"
            auto: true
        }
    }
}

Canvas child properties

Canvas slot fields such as anchorMin, anchorMax, offsets, and alignment are only valid when the component is a direct child of CanvasPanel.

Grid child properties

row, column, spans, and nudge are only valid when the component is a direct child of GridPanel or UniformGridPanel inside children { ... }.

WrapBox child properties

fillEmptySpace, fillSpanWhenLessThan, and forceNewLine are only valid when the component is a direct child of WrapBox.

ExpandableArea slots

slot: "Header" and slot: "Body" are only valid for direct children of ExpandableArea.

nui
ExpandableArea Details {
    expanded: true

    children {
        Text HeaderText {
            slot: "Header"
            text: "Details"
        }

        Text BodyText {
            slot: "Body"
            text: "THIS IS THE CHILD COMPONENT"
        }
    }
}

Next steps