Login
Free Sign Up
Docs
/

Link

Type identifier: link Category: Experience Blocks

Description

Clickable navigational block. Its destination is set by to: a URL, an Experience, or an auth action. It also takes the shared block style, layout, and data properties, and it restricts which blocks it can contain.

Properties

Property

Type

Required

Notes

id

string

Yes

Shared block identifier.

type

"link"

Yes

Block discriminator.

to

Destination object

Yes

Destination: a URL, an Experience (ux:experience), or an auth action (ux:auth-action).

children

Array<text | image | video | audio | input | visualisation | box>

No

Constrained by recursive child validation.

states

State[]

No

Optional state-specific overrides.

The shared block style, layout, and data properties also apply to Link blocks.

Child Constraints

Link children cannot include Link or Button blocks at any nesting level.

  • Direct children are restricted to Text, Image, Video, Audio, Input, Visualisation, and Box blocks.
  • This applies at any depth, including inside nested Box blocks.

States

State entries follow the shared state shape (id, optional name, optional activation, overrides).

No states are currently available for Link blocks.

Minimal Valid Example

{
  "id": "link-1",
  "type": "link",
  "to": {
    "type": "url",
    "url": "https://example.com"
  }
}