Skip to Content

Link

A navigation link including its URL, title, type, and related child links.

Type Definition

type Link { levels: Int links: [Link] title: String type: String url: String target: String product: Product productGroup: ProductGroup page: Page article: Article }

Fields

FieldTypeDescription
levelsIntThe maximum depth of nested child links below this link.
links[Link]The list of child links for this link. Each child link can itself have further children, forming a hierarchy.
titleStringThe display name of the link, typically shown as the link’s label in navigation components.
typeStringThe type of object this link points to, such as ‘product’, ‘category’, ‘page’, or ‘article’.
urlStringThe URL that this link points to. This can be an internal or external address.
targetStringThe target attribute for the link, indicating how the link should be opened (e.g., in a new tab).
productProductThe product object associated with this link, if the link points to a product.
productGroupProductGroupThe category object associated with this link, if the link points to a category.
pagePageThe page object associated with this link, if the link points to a page.
articleArticleThe article object associated with this link, if the link points to an article.

Relationships

The Link type represents a hierarchical navigation structure. It can point to various content types in the system through its optional relationship fields: Product, ProductGroup, Page, and Article. Links can contain child links through the links field, allowing for nested navigation hierarchies with configurable depth through the levels field.

Example

{ title url type target levels links { title url type } product { id name } productGroup { id name } }

Implements

None