layout advanced
Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.
Other functions and constants11
isAccountMenuItemAllowed | Whether the buyer may see an item: every one of permissions held, and at least one of anyPermissions.@evolve-storefront/layout/account-menu-sheet |
buildBreadcrumbJsonLd | Build a schema.org BreadcrumbList for the given trail (Home at position 1).@evolve-storefront/layout/breadcrumb-json-ld |
toAbsoluteUrl | Resolve a trail href to an absolute URL for JSON-LD.@evolve-storefront/layout/breadcrumb-json-ld |
brandsByLetter | Groups brands for an A–Z list: [letter, brands] pairs sorted in locale's order, each brand under its first letter with accents folded (É under E).@evolve-storefront/layout/brands-by-letter |
footerLinkTarget | Where a footer link goes and how: href with the anchor in place of any it had, whether the site's router follows it, and the target and rel for a new tab.@evolve-storefront/layout/footer |
siteFooterColumns | The footer's menu as link columns: each top-level entry is a column, headed by its label, with its linked children as the links. @evolve-storefront/layout/site |
siteFooterTrust | The trust row's payment brands, review rating and socials, for FooterTrust.@evolve-storefront/layout/site |
siteLinkHref | Where a site link leads: its URL, its page by pageHref, the product's page by productHref, or its storefront route by routeHrefs.@evolve-storefront/layout/site |
siteMegaMenuItems | The header's menu as mega menu items, each entry's promo as the item's promo.@evolve-storefront/layout/site |
siteUspBarItems | The header bar's selling points, with their icon and second line where the CMS gives them. @evolve-storefront/layout/site |
LayoutGetSite | The store's menus, selling points, socials, payment brands, review rating and SEO templates; site is null without a site entry.@evolve-storefront/layout/site-documents |
Types43
AccountMenuSheetGroup | A heading in the menu that items join through their group, the account shell's group shape.@evolve-storefront/layout/account-menu-sheet |
AccountMenuSheetItem | @evolve-storefront/layout/account-menu-sheet |
AccountMenuSheetLinkRenderer | Renders a menu link with the app's router; defaults to a plain anchor. @evolve-storefront/layout/account-menu-sheet |
CountryOption | A country the store sells to. @evolve-storefront/layout/country-language-picker |
LoadSearchSuggestions | @evolve-storefront/layout/header-search |
SearchCategorySuggestion | @evolve-storefront/layout/header-search |
SearchProductSuggestion | @evolve-storefront/layout/header-search |
SearchSuggestions | What the panel shows for a query: each group is left out when empty. @evolve-storefront/layout/header-search |
LocalePicker | Picks which of a language's offered locales its entry switches to. @evolve-storefront/layout/locale-switcher |
BreadcrumbTrailItem | One rung of a breadcrumb trail. @evolve-storefront/layout/breadcrumb-json-ld |
MegaMenuBrand | A brand in the menu: a link with an optional logo, and whether it is popular. @evolve-storefront/layout/mega-menu |
MegaMenuBrandsItem | The brands entry: the all-brands page as href, the brands as its children.@evolve-storefront/layout/mega-menu |
MegaMenuItem | One entry of the menu, from any CMS: a link, a group of entries, or both. @evolve-storefront/layout/mega-menu |
MegaMenuLinkRenderer | Renders a link, so a host can use its router's own (next/link).@evolve-storefront/layout/mega-menu |
MegaMenuPromoRenderer | Renders a top-level item's promo block. @evolve-storefront/layout/mega-menu |
MegaMenuIcons | An icon set by name, which the site supplies; the package ships no glyphs. @evolve-storefront/layout/mega-menu-icons |
MegaMenuBrand | A brand in the menu: a link with an optional logo, and whether it is popular. @evolve-storefront/layout/mega-menu-drill-down |
MegaMenuBrandsItem | The brands entry: the all-brands page as href, the brands as its children.@evolve-storefront/layout/mega-menu-drill-down |
FooterLink | A footer link as the CMS authored it. @evolve-storefront/layout/footer |
FooterLinkGroup | @evolve-storefront/layout/footer |
FooterLinkRenderer | Renders a routed link with the site's router (next/link).@evolve-storefront/layout/footer |
FooterLinkType | What a CMS link points at (schema ResourceLinkType), verbatim.@evolve-storefront/layout/footer |
FooterPaymentMethod | @evolve-storefront/layout/footer |
FooterRating | @evolve-storefront/layout/footer |
FooterSocialLink | @evolve-storefront/layout/footer |
Site | The store's settings (schema Site).@evolve-storefront/layout/site |
SiteContentVersion | @evolve-storefront/layout/site |
SiteLink | A link with its own label, to a page, a product, a storefront route or a URL (schema Link).@evolve-storefront/layout/site |
SiteLinkResolver | Turns a site link into a path, localized as the app's router needs; null leaves it unlinked.@evolve-storefront/layout/site |
SiteMenuItem | One menu entry: a link, or a heading for the entries below it (schema MenuItem).@evolve-storefront/layout/site |
SiteNavigation | A menu: the header's, its secondary one or the footer's (schema Navigation).@evolve-storefront/layout/site |
SitePage | A link's page: its type tells a catalog page, which a site may route apart, from a content page. @evolve-storefront/layout/site |
SitePageType | The kind of page a link opens: the schema's Page implementations, verbatim.@evolve-storefront/layout/site |
SitePaymentBrand | A way to pay the store shows (schema PaymentBrandType), verbatim.@evolve-storefront/layout/site |
SitePromo | A card beside a menu entry (schema Promo).@evolve-storefront/layout/site |
SiteRouteHrefs | The site's own path for each storefront route it serves; a route left out is not linked. @evolve-storefront/layout/site |
SiteSocialLink | The store's profile on a social network (schema SocialLink).@evolve-storefront/layout/site |
SiteSocialPlatform | A social network (schema SocialPlatformType), verbatim.@evolve-storefront/layout/site |
SiteStorefrontRoute | A page the storefront serves itself, which the site maps to its own path (schema StorefrontRouteType).@evolve-storefront/layout/site |
SiteTrustRating | The store's score at a review service, such as 9.2 of 10 (schema TrustRating).@evolve-storefront/layout/site |
SiteUsp | A selling point in the header bar (schema Usp), with the CMS's resource link.@evolve-storefront/layout/site |
UspBarIcon | A selling point's icon: the framework's UspIconType values, verbatim.@evolve-storefront/layout/usp-bar |
UspBarItem | One selling point, linked where the CMS gave it a link. @evolve-storefront/layout/usp-bar |
Not listed: 28 props and options types. They appear as the tables on the pages of what they type.