> For the complete documentation index, see [llms.txt](https://docs.realmacsoftware.com/elements-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmacsoftware.com/elements-docs/elements-language/component/properties-json/ui-controls/link.md).

# Link

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

{% tabs %}
{% tab title="Control Example" %}

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

{% endtab %}

{% tab title="Group Example" %}

```json
{
  "groups": [{
    "title": "CTA Button",
    "properties": [{
      "title": "CTA Link",
      "id": "ctaLink",
      "link": {
        "subtitle": "Link to a product or signup page"
      }
    }]
  }]
}
```

{% endtab %}
{% endtabs %}

### Template Example

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

```html
<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.

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

Corresponding template example using the absoluteURL.

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

### 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.               |

```json
{
  "title": "Page Link",
  "id": "pageLink",
  "link": {
    "default": {
      "href": "",
      "text": "",
      "target": "_self",
      "title": "",
      "rel": ""
    }
  }
}
```

### 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmacsoftware.com/elements-docs/elements-language/component/properties-json/ui-controls/link.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.