Documentation
Components
Box

Box

Box is a component that allows you to arrange children either horizontally or vertically.

      direction = "row"  ──────────────────────────────────────▶

    ┌────────────────────────────┐ ┌────────────────────────────┐
 │  │                            │ │                            │
 │  │    direction = "column"    │ │                            │
 │  │                            │ │                            │
 │  └────────────────────────────┘ │                            │
 │  ┌────────────────────────────┐ │                            │
 │  │                            │ │                            │
 │  │                            │ │                            │
 ▼  │                            │ │                            │
    └────────────────────────────┘ └────────────────────────────┘

Usage Example

n.box(<children>) -- flex = 1
n.box(2, <children>) -- flex = 2
n.box({ flex = 3, direction = "column" }, <children>)
n.box({ flex = 0 }, <children>)
n.box({ size = 10 }, <children>)

Properties

size

Type
number

flex

Type
number

direction

Default value
row
Type
'row' | 'column'
ComponentsBuffer