Skip to content
ShopgateShopgateShopgate Documentation

NavMenu

Contains all portals for the navigation menu in the GMD theme and the “More” page of the iOS theme.

Default Portal Props

Section titled “Default Portal Props”

The following React components are passed to all of the NavMenu Portals as Props.

  • Section: Creates a section with potentially multiple entries and a dedicated section title. The Logout and My Account portals do not get this Prop.
  • Item: Inserts an entry into an already existing section or creates the entries within a custom section.

Content

Section titled “Content”

Wraps the contents of the Navigation Menu. Within the iOS theme, the Portal wraps the quicklinks, store-information and my-account sections.

Name Description Props
nav-menu.content.before Components are rendered before the NavMenu contents. Default Portal Props
nav-menu.content.after Components are rendered after the NavMenu contents. Default Portal Props

Entries

Section titled “Entries”

Home (only GMD)

Section titled “Home (only GMD)”
Name Description Props
nav-menu.home.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.home Components replace the NavMenu entry. Default Portal Props
nav-menu.home.after Components are rendered after the NavMenu entry. Default Portal Props

Categories (only GMD)

Section titled “Categories (only GMD)”
Name Description Props
nav-menu.categories.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.categories Components replace the NavMenu entry. Default Portal Props
nav-menu.categories.after Components are rendered after the NavMenu entry. Default Portal Props

Favorites (only GMD)

Section titled “Favorites (only GMD)”
Name Description Props
nav-menu.favorites.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.favorites Components replace the NavMenu entry. Default Portal Props
nav-menu.favorites.after Components are rendered after the NavMenu entry. Default Portal Props

Cart (only GMD)

Section titled “Cart (only GMD)”
Name Description Props
nav-menu.cart.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.cart Components replace the NavMenu entry. Default Portal Props
nav-menu.cart.after Components are rendered after the NavMenu entry. Default Portal Props

Scanner (only GMD)

Section titled “Scanner (only GMD)”
Name Description Props
nav-menu.scanner.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.scanner Components replace the NavMenu entry. Default Portal Props
nav-menu.scanner.after Components are rendered after the NavMenu entry. Default Portal Props

Shipping

Section titled “Shipping”
Name Description Props
nav-menu.shipping.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.shipping Components replace the NavMenu entry. Default Portal Props
nav-menu.shipping.after Components are rendered after the NavMenu entry. Default Portal Props

Payment

Section titled “Payment”
Name Description Props
nav-menu.payment.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.payment Components replace the NavMenu entry. Default Portal Props
nav-menu.payment.after Components are rendered after the NavMenu entry. Default Portal Props

Terms

Section titled “Terms”
Name Description Props
nav-menu.terms.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.terms Components replace the NavMenu entry. Default Portal Props
nav-menu.terms.after Components are rendered after the NavMenu entry. Default Portal Props

Privacy Policy

Section titled “Privacy Policy”
Name Description Props
nav-menu.privacy.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.privacy Components replace the NavMenu entry. Default Portal Props
nav-menu.privacy.after Components are rendered after the NavMenu entry. Default Portal Props

Return Policy

Section titled “Return Policy”
Name Description Props
nav-menu.return-policy.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.return-policy Components replace the NavMenu entry. Default Portal Props
nav-menu.return-policy.after Components are rendered after the NavMenu entry. Default Portal Props

Imprint

Section titled “Imprint”
Name Description Props
nav-menu.imprint.before Components are rendered before the NavMenu entry. Default Portal Props
nav-menu.imprint Components replace the NavMenu entry. Default Portal Props
nav-menu.imprint.after Components are rendered after the NavMenu entry. Default Portal Props

Logout

Section titled “Logout”
Name Description Props
nav-menu.logout.before Components are rendered before the NavMenu entry. Item - A React component which can be used as an entry for a section.
nav-menu.logout Components replace the NavMenu entry. Item - A React component which can be used as an entry for a section.
nav-menu.logout.after Components are rendered after the NavMenu entry. Item - A React component which can be used as an entry for a section.

Sections

Section titled “Sections”
Section titled “Quick Links”

Wraps the Quick Links section, which contains the entries of the quicklinks menu configured by the merchant. Both themes render the section between the user entries and the store information. When the menu contains no entries, the section is not rendered, and these Portals are not rendered either. Within the iOS theme, the section has the “More” headline, and an entry for the back in stock list is added when that feature is enabled.

Name Description Props
nav-menu.quick-links.before Components are rendered before the section content. Default Portal Props
nav-menu.quick-links Components replace the section content. Default Portal Props
nav-menu.quick-links.after Components are rendered after the section content. Default Portal Props
Section titled “Quick Links Items”

Wraps the entries within the Quick Links section, but not the section itself. Use these Portals to add an entry between the configured Quick Links. Use nav-menu.quick-links to replace the complete section including its headline.

Name Description Props
nav-menu.quick-links.items.before Components are rendered before the section entries. Default Portal Props
nav-menu.quick-links.items Components replace the section entries. Default Portal Props
nav-menu.quick-links.items.after Components are rendered after the section entries. Default Portal Props

Store Information

Section titled “Store Information”

The Store Information Portal wraps multiple store-related entries of the Navigation Menu. Within the iOS theme, the Portal wraps all available entries: shipping, payment, terms, privacy, return-policy and imprint. However, in the GMD theme, the list is split into two sections which are wrapped by the nav-menu.store-information-about and the nav-menu.store-information-more Portal.

Name Description Props
nav-menu.store-information.before Components are rendered before the section content. Default Portal Props
nav-menu.store-information Components replace the section content. Default Portal Props
nav-menu.store-information.after Components are rendered after the section content. Default Portal Props

Store Information More (GMD only)

Section titled “Store Information More (GMD only)”

Wraps the section containing the shipping and payment menu entries.

Name Description Props
nav-menu.store-information-more.before Components are rendered before the section content. Default Portal Props
nav-menu.store-information-more Components replace the section content. Default Portal Props
nav-menu.store-information-more.after Components are rendered after the section content. Default Portal Props

Store Information About (GMD only)

Section titled “Store Information About (GMD only)”

Wraps the whole section containing the terms, privacy, return-policy and imprint menu entries.

Name Description Props
nav-menu.store-information-about.before Components are rendered before the section content. Default Portal Props
nav-menu.store-information-about Components replace the section content. Default Portal Props
nav-menu.store-information-about.after Components are rendered after the section content. Default Portal Props

User Menu (iOS only)

Section titled “User Menu (iOS only)”

Wraps the NavMenu login and logout entries.

Name Description Props
user-menu.container.before Components are rendered before the section content. Default Portal Props
user-menu.container Components replace the section content. Default Portal Props
user-menu.container.after Components are rendered after the section content. Default Portal Props

My Account (iOS only)

Section titled “My Account (iOS only)”

Wraps the logout entry on iOS.

Name Description Props
nav-menu.my-account.before Components are rendered before the section content. Item - A React component which can be used as an entry for a section.
nav-menu.my-account Components replace the section content. Item - A React component which can be used as an entry for a section.
nav-menu.my-account.after Components are rendered after the section content. Item - A React component which can be used as an entry for a section.