link

Properties

Anchor to

active

boolean

Returns true if the link is active. Returns false if not.

A link is considered to be active if the current URL path matches, or contains, the link's url. For example, if the current URL path is /blog/potion-notions/new-potions-for-spring, then the following link URLs would be considered active:

• /blog/potion-notions/new-potions-for-spring
• /blog/potion-notions

Tip

The link.active property is useful for menu designs that highlight when top-level navigation categories are being viewed. For example, if a customer is viewing an article from the "Potion notions" blog, then the "Potion notions" link is highlighted in the menu.

Tip: The <code>link.active</code> property is useful for menu designs that highlight when top-level navigation categories are being viewed. For example, if a customer is viewing an article from the &quot;Potion notions&quot; blog, then the &quot;Potion notions&quot; link is highlighted in the menu.

Anchor to

child_active

boolean

Returns true if a link's child link is active. Returns false if not.

A link is considered to be active if the current URL path matches, or contains, the URL of the link.

For example, if the current URL path is /blog/potion-notions/new-potions-for-spring, then the following link URLs would be considered active:

• /blog/potion-notions/new-potions-for-spring
• /blog/potion-notions

Anchor to

child_current

boolean

Returns true if current URL path matches a link's child link URL. Returns false if not.

Note

URL parameters are ignored when determining a match.

Product URLs within the context of a collection and standard product URLs are treated the same.

Note: URL parameters are ignored when determining a match.</p> <p>Product URLs <a href="/docs/api/liquid/filters/within">within the context of a collection</a> and standard product URLs are treated the same.

Anchor to

current

boolean

Returns true if the current URL path matches the URL of the link. Returns false if not.

Note

URL parameters are ignored when determining a match.

Product URLs within the context of a collection are treated as equal to a standard product URL for the same product.

Note: URL parameters are ignored when determining a match.</p> <p>Product URLs <a href="/docs/api/liquid/filters/within">within the context of a collection</a> are treated as equal to a standard product URL for the same product.

Anchor to

data_sharing_opt_out_icon

string

The "Your Privacy Choices" opt-out icon (an <img>) for the data-sale opt-out link, or nil for any other link.

When a shop enables data-sale opt-out, Shopify automatically adds an opt-out link to the storefront, shown to buyers as "Your Privacy Choices". US state privacy laws (such as California's CCPA/CPRA) require the official "Your Privacy Choices" icon to appear next to that link. This attribute returns that icon for the opt-out link, and nil for every other link.

Render it next to {{ link.title }}, checking for it first so other links are unaffected:

Copy

1

{{ link.title }}{% if link.data_sharing_opt_out_icon %}{{ link.data_sharing_opt_out_icon }}{% endif %}

{{ link.title }}{% if link.data_sharing_opt_out_icon %}{{ link.data_sharing_opt_out_icon }}{% endif %}

See Customer privacy settings.

Anchor to

handle

string

The handle of the link.

Anchor to

levels

number

The number of nested levels under the link.

Anchor to

links

array of link

The child links of the link.

Example

Check the number of links

CodeData

Reset Code

1

2

3

4

5

6

7

{% for link in linklists.main-menu.links -%}

{% if link.links.size > 0 -%}

- {{ link.title }} ({{ link.links.size }} children)<br>

{%- else -%}

- {{ link.title }}<br>

{%- endif %}

{%- endfor %}

Code

{% for link in linklists.main-menu.links -%}
  {% if link.links.size > 0 -%}
    - {{ link.title }} ({{ link.links.size }} children)<br>
  {%- else -%}
    - {{ link.title }}<br>
  {%- endif %}
{%- endfor %}

Data

{
  "linklists": {
    "main-menu": {
      "links": [
        "LinkDrop",
        "LinkDrop",
        "LinkDrop"
      ]
    }
  }
}

Output

1

2

3

- Home<br>

- Catalog (2 children)<br>

- Contact<br>

Output

- Home<br>
- Catalog (2 children)<br>
- Contact<br>

Anchor to

object

The object associated with the link.

The object can be one of the following:

• article
• blog
• collection
• metaobject
• page
• policy
• product

Anchor to

title

string

The title of the link.

Anchor to

type

string from a set of values

The type of the link.

Possible values	Description
article_link	The link points to an article.
blog_link	The link points to an blog.
catalog_link	The link points to the catalog page.
collection_link	The link points to a collection.
collections_link	The link points to the collection list page.
customer_account_page_link	The link points to a customer account page.
frontpage_link	The link points to the home page.
http_link	The link points to an external web page, or a product type or vendor collection.
metaobject_link	The link points to a metaobject page.
page_link	The link points to a page.
policy_link	The link points to a policy page.
product_link	The link points to a product page.
search_link	The link points to the search page.

Anchor to

url

string

The URL of the link.