Input
A labelled text input. .fnc runs on change with the new value.
Also written TextField; layr format rewrites these to Input.
A labelled field
Input is a text field with its label (always present for screen readers). .fnc { … } runs on every change with the new value; store it in state and show it anywhere. kind picks the keyboard and validation (email, password, number, search, tel, url), and multiline: true makes a text area.
Page(
.name(Signup)
.route('/')
var txt name = ''
Scaffold(
.config(color: canvas)
.body(
Column(
.config(w: 320, gap: 12, padding: all(24))
Input(
.preset(default)
.config(label: 'Your name', placeholder: 'Ada', value: name)
.fnc { name = value }
)
Text(
.config(color: muted)
.obj(name == '' ? 'Type your name above.' : 'Hello, $name.')
)
)
)
)
)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). | |
value | txt | Current value (bind a var to make it two-way). | |
label | txt | Label (required for accessibility). | |
placeholder | txt | Placeholder. | |
kind | text | email | password | number | search | tel | url | text | Input kind. |
multiline | bool | A multi-line text area. | |
rows | int | Visible rows for multiline. | |
disabled | bool | Disabled. | |
required | bool | Required. |
Group .border(align, color, width, style, sides): Border settings grouped: .border(align: in, color: #0d0d0d, width: 2).
Events
.fnc runs on change. .on(...) accepts tap, press, hover, hoverEnd, focus, blur, key, drag, swipe, mount, unmount, visible, submit.