For the complete documentation index, see llms.txt. This page is also available as Markdown.

Link

The Link control allows users to input a URL or link to another page within their RapidWeaver project.

{
  "title": "CTA Link",
  "id": "ctaLink",
  "link": {
    "subtitle": "Link to a product or signup page"
  }
}

Template Example

The following will give you access to the link object in your template file(s).

<a href="{{ctaLink.href}}" target="{{ctaLink.target}}">Get Started</a>

Getting the Absolute URL

By default the link attribute will return a relative URL. To get the full URL add the absoluteURL property.

{
  "title": "CTA Link",
  "id": "ctaLink",
  "link": {
    "absoluteURL": true
  }
}

Corresponding template example using the absoluteURL.

Supported Options

The link control supports the following options.

Key
Type
Notes

default

object

The default link. Supports the keys href, text, target, title, and rel.

subtitle

string

Helper text displayed underneath the control.

absoluteURL

boolean

When true, href returns the full URL instead of a relative one.

Value

The control returns a link object. Access its properties in templates with dot notation — for example {{pageLink.href}} and {{pageLink.target}} as shown above.

Last updated

Was this helpful?