---
title: 'Liquid objects: link'
description: >-
  A link in a
  [menu](https://help.shopify.com/manual/online-store/menus-and-links/drop-down-menus).
source_url:
  html: 'https://shopify.dev/docs/api/liquid/objects/link'
  md: 'https://shopify.dev/docs/api/liquid/objects/link.md'
api_name: liquid
---

# link

A link in a [menu](https://help.shopify.com/manual/online-store/menus-and-links/drop-down-menus).

To learn about how to implement navigation in a theme, refer to [Add navigation to your theme](https://shopify.dev/themes/navigation-search/navigation).

## Properties

* * **active**

    [boolean](https://shopify.dev/docs/api/liquid/basics#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](https://shopify.dev/docs/api/liquid/objects/link#link-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 \<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.

  * **child\_​active**

    [boolean](https://shopify.dev/docs/api/liquid/basics#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](https://shopify.dev/docs/api/liquid/objects/link#link-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`

  * **child\_​current**

    [boolean](https://shopify.dev/docs/api/liquid/basics#boolean)

  * Returns `true` if current URL path matches a link's child link [URL](https://shopify.dev/docs/api/liquid/objects/link#link-url). Returns `false` if not.

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

  * **current**

    [boolean](https://shopify.dev/docs/api/liquid/basics#boolean)

  * Returns `true` if the current URL path matches the [URL](https://shopify.dev/docs/api/liquid/objects/link#link-url) of the link. Returns `false` if not.

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

  * **data\_​sharing\_​opt\_​out\_​icon**

    [string](https://shopify.dev/docs/api/liquid/basics#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:

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

    See [Customer privacy settings](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#sales-opt-out).

  * **handle**

    [string](https://shopify.dev/docs/api/liquid/basics#string)

  * The [handle](https://shopify.dev/docs/api/liquid/basics#handles) of the link.

  * **levels**

    [number](https://shopify.dev/docs/api/liquid/basics#number)

  * The number of nested levels under the link.

  * **links**

    array of [link](https://shopify.dev/docs/api/liquid/objects/link)

  * The child links of the link.

    ExampleCheck the number of links

    ##### Code

    ```liquid
    {% 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

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

    ##### Output

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

  * **object**

  * The object associated with the link.

    The object can be one of the following:

    * [`article`](https://shopify.dev/docs/api/liquid/objects/article)
    * [`blog`](https://shopify.dev/docs/api/liquid/objects/blog)
    * [`collection`](https://shopify.dev/docs/api/liquid/objects/collection)
    * [`metaobject`](docs/api/liquid/objects/metaobject)
    * [`page`](https://shopify.dev/docs/api/liquid/objects/page)
    * [`policy`](https://shopify.dev/docs/api/liquid/objects/policy)
    * [`product`](https://shopify.dev/docs/api/liquid/objects/product)

  * **title**

    [string](https://shopify.dev/docs/api/liquid/basics#string)

  * The title of the link.

  * **type**

    [string](https://shopify.dev/docs/api/liquid/basics#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](https://help.shopify.com/manual/online-store/themes/customizing-themes/change-catalog-page). |
    | collection\_link | The link points to a collection. |
    | collections\_link | The link points to the [collection list page](https://shopify.dev/themes/architecture/templates/list-collections). |
    | customer\_account\_page\_link | The link points to a [customer account page](https://shopify.dev/docs/apps/build/customer-accounts/full-page-extensions). |
    | 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](https://help.shopify.com/manual/online-store/themes/theme-structure/pages). |
    | policy\_link | The link points to a [policy page](https://help.shopify.com/manual/checkout-settings/refund-privacy-tos#add-links-to-your-policies-within-pages-or-on-social-media). |
    | product\_link | The link points to a product page. |
    | search\_link | The link points to the search page. |

  * **url**

    [string](https://shopify.dev/docs/api/liquid/basics#string)

  * The URL of the link.

##### Example

```json
{
  "active": false,
  "child_active": false,
  "child_current": false,
  "current": false,
  "data_sharing_opt_out_icon": null,
  "handle": {},
  "levels": 0,
  "links": [],
  "object": {},
  "title": {},
  "type": "page_link",
  "url": "/pages/contact"
}
```