Scroll
Scrolls its object along an axis.
Also written ScrollView, SingleChildScrollView; layr format rewrites these to Scroll.
A horizontal shelf
Scroll lets its object scroll along an axis (y by default, x, or both). snap stops items at a position, and fade softens the edges where content goes out of view.
Scroll(
.config(w: fill, axis: x, fade: 24, snap: start)
.obj(
Row(
.config(gap: 12, padding: sym(y: 4))
Container(.config(w: 180, h: 110, color: violet, cornerRadius: 14))
Container(.config(w: 180, h: 110, color: teal, cornerRadius: 14))
Container(.config(w: 180, h: 110, color: gold, cornerRadius: 14))
Container(.config(w: 180, h: 110, color: ember, cornerRadius: 14))
Container(.config(w: 180, h: 110, color: accent, cornerRadius: 14))
)
)
)A list with a fixed height
Scroll(
.config(
w: 280
h: 160
.border(color: line, width: 1)
color: panel
cornerRadius: 12
)
.obj(
Column(
.config(w: fill, gap: 2, padding: all(6))
Container(.config(w: fill, padding: all(10)) .obj(Text('Monday')))
Container(.config(w: fill, padding: all(10)) .obj(Text('Tuesday')))
Container(.config(w: fill, padding: all(10)) .obj(Text('Wednesday')))
Container(.config(w: fill, padding: all(10)) .obj(Text('Thursday')))
Container(.config(w: fill, padding: all(10)) .obj(Text('Friday')))
)
)
)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). | |
axis | y | x | both | y | Scroll direction. |
bar | auto | show | hide | auto | Scrollbar visibility. |
snap | none | start | mid | end | none | Scroll snapping. |
fade | len | Fades content out over this distance at the edges that can still scroll, so nothing ends in a hard cut. |
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.