NavigationItemV2

Required access

read_false access scope

A navigation item, holding basic link attributes, extra configuration, and nested navigation items.

Show definition
# A navigation item, holding basic link attributes, extra configuration, and nested navigation items.
type NavigationItemV2 {
  # Sub-navigation items for this navigation.
  children: [NavigationItemV2!]!

  # Flag that indicates if the navigation is disabled or not.
  disabled: Boolean!

  # Extra paths that should be used to not highlight the navigation as selected.
  excludePaths: [String!]!

  # Flag indicating that the store front link must be shown within this navigation.
  hasStorefrontLink: Boolean!

  # The SVG icon body to be displayed as the navigation's icon.
  iconBody: String!

  # The navigation's label to be displayed.
  label: String!

  # Flag indicating that an exact match of the path is required to highlight the navigation.
  matchExactPath: Boolean!

  # Extra paths that should be used to highlight the navigation as selected.
  matchPaths: [String!]!

  # The URL that the navigation points to.
  url: URL!
}

Fields

children   ([NavigationItemV2!]!)

Sub-navigation items for this navigation.

Required access

read_ access scope

disabled   (Boolean!)

Flag that indicates if the navigation is disabled or not.

Required access

read_ access scope

excludePaths   ([String!]!)

Extra paths that should be used to not highlight the navigation as selected.

Required access

read_ access scope

Flag indicating that the store front link must be shown within this navigation.

Required access

read_ access scope

iconBody   (String!)

The SVG icon body to be displayed as the navigation's icon.

Required access

read_ access scope

label   (String!)

The navigation's label to be displayed.

Required access

read_ access scope

matchExactPath   (Boolean!)

Flag indicating that an exact match of the path is required to highlight the navigation.

Required access

read_ access scope

matchPaths   ([String!]!)

Extra paths that should be used to highlight the navigation as selected.

Required access

read_ access scope

url   (URL!)

The URL that the navigation points to.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up