Link
Navigates to a page or URL.
To a page, or away
Link navigates. to names a Page of your app (it opens without a reload), href a URL; external: true opens it in a new tab. A Link holds text (label) or any object, so a whole card can be a link.
Page(
.name(Home)
.route('/')
Scaffold(
.config(color: canvas)
.body(
Column(
.config(gap: 14, padding: all(24))
Link(.config(label: 'Read about the studio', to: About))
Link(
.config(
external: true
href: 'https://github.com/nishanbhuinya/layr'
label: 'LAYR on GitHub'
)
)
Link(
.config(to: About, underline: false)
.obj(
Container(
.config(
w: 280
.border(color: line, width: 1)
color: panel
cornerRadius: 12
padding: all(16)
)
.obj(
Column(
.config(gap: 4)
Text(.config(weight: semibold) .obj('Room B'))
Text(
.config(size: 13, color: muted)
.obj('The whole card is the link.')
)
)
)
)
)
)
)
)
)
)
Page(
.name(About)
.route('/about')
Scaffold(
.config(color: canvas)
.body(
Column(
.config(gap: 12, padding: all(24))
Text('About the studio')
Link(.config(label: '← Back', to: Home))
)
)
)
)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). | |
to | page | Page to open, e.g. DemoPage. | |
href | txt | External URL. | |
label | txt | Link text (when there is no object). | |
external | bool | Open in a new tab. | |
underline | bool | Underline the link (browsers underline links by default). | |
objAlign (align, alignment, contentAlign) | align | topLeft | Where the object's content sits inside it. |
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
.fnc runs on press. .on(...) accepts tap, press, hover, hoverEnd, focus, blur, key, drag, swipe, mount, unmount, visible.