link

The link object has the following attributes:

link.active

Returns true if the link object is active, or false if the link object is inactive.

link.links

Returns an array of the child links associated with the parent link.

link.title

Returns the title of the link.

link.type

Returns the type of the link. The possible values are:

  • blog_link: if the link points to a blog
  • catalog_link: if the link points to the catalog page /collections/all
  • collection_link: if the link points to a collection
  • collections_link: if the link points to the collection list page /collections
  • frontpage_link: if the link points to the home page /
  • http_link: if the link points to an external web page, or a type or vendor collection (ex: /collections/types?q=Pants)
  • page_link: if the link points to a page
  • policy_link: if the link points to a policy page /policies
  • product_link: if the link points to a product page
  • search_link: if the link points to the search page /search

link.url

Returns the URL of the link.


Did this page help you?