Container
A box: size, paint, border, corners, shadow and padding around one object.
Also written Box; layr format rewrites these to Container.
A card
A Container draws one box around one object: its size, paint, border, corners, shadow and padding. Most cards, tiles, chips and panels are a Container.
Container(
.config(
w: 280
.border(color: line, width: 1)
color: panel
cornerRadius: 14
padding: all(18)
shadow: shadow(y: 8, blur: 24, color: black.alpha(12%))
)
.obj(
Column(
.config(gap: 6)
Text(.config(size: 13, color: muted) .obj('Order 1042'))
Text(.config(size: 18, weight: semibold) .obj('Two items, ships Monday'))
)
)
)Placing its object
objAlign (also written align) places the object inside a box that is larger than it.
Container(
.config(
w: 280
h: 120
color: sunken
cornerRadius: 12
objAlign: bottomRight
padding: all(12)
)
.obj(Text(.config(size: 13, color: muted) .obj('bottom right')))
)Config keys
| Key | Type | Default | Meaning |
|---|---|---|---|
w (width) | len | fill | hug | Width: a length, fill (share the remaining space) or hug (fit content, default). | |
h (height) | len | fill | hug | Height: a length, fill or hug (default). | |
size (s) | size | Width and height together: size: 200 or size: (200, 120). | |
minW (minWidth) | len | Minimum width. | |
maxW (maxWidth) | len | Maximum width. | |
minH (minHeight) | len | Minimum height. | |
maxH (maxHeight) | len | Maximum height. | |
aspect (aspectRatio) | num | Aspect ratio (width / height), e.g. 16/9. | |
color (bg, background, colorBG) | paint | Background paint: a colour or gradient. | |
padding (pad) | insets | Space inside the object. | |
cornerRadius (radius, borderRadius, corner) | radius | Corner radius: one length or only(topLeft: 8, …). | |
borderWidth | len | Border width. | |
borderColor | color | Border colour. | |
borderAlign | in | mid | out | in | Where the border sits relative to the edge: in, mid or out. |
borderStyle | solid | dashed | dotted | solid | Border line style. |
borderSides | all | top | bottom | left | right | x | y | all | Which sides draw the border (inside the box). |
shadow | shadow | Drop shadow(s): shadow(y: 4, blur: 12, color: black.alpha(20%)). | |
clip | bool | Clip children to the object's bounds (and corner radius). | |
z | int | Stacking order among siblings. | |
margin | insets | Space outside the object: all(8), sym(x: 8, y: 4), only(top: 8). | |
opacity | num | Opacity from 0 to 1. | |
hide (hidden) | bool | Removes the object from layout and the accessibility tree. | |
shrink | num | 1 | Shrink priority when space runs out. Lower shrinks first; 0 never shrinks. |
flex | num | 1 | Share of remaining space for fill sizes. |
cursor | auto | pointer | text | grab | grabbing | move | notAllowed | crosshair | none | Pointer cursor. | |
className (class) | txt | Extra CSS class names: styling hooks for your own stylesheet (hover rules, third-party CSS). | |
objAlign (align, alignment, contentAlign) | align | topLeft | Where the object's content sits inside it. |
overflow | auto | wrap | stack | scroll | clip | shrink | warn | error | auto | What happens when content does not fit. auto adapts deterministically (see Layout & Adaptation). |
Group .border(align, color, width, style, sides): Border settings grouped: .border(align: in, color: #0d0d0d, width: 2).
Slots
.obj: one object, the default slot
Events
.on(...) accepts tap, press, hover, hoverEnd, focus, blur, key, drag, swipe, mount, unmount, visible.