Side navigation
<gcds-side-nav>
Also called: sidebar menu, lefthand nav, vertical navigation.
A side navigation is a vertical list of page links on the left side of the screen.
-
GitHub -
Figma
Side navigation component preview
On this page
Coding and accessibility for side navigation
Place the side navigation in the page layouts
Implement the side navigation in the product layout so that it’s present on all pages.
Use the side navigation with other components
If using breadcrumbs, align the content hierarchy in both sets of links, so the components reflect a similar path through the site.
In this section
label
The label attribute defines the label for the navigation landmark.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
</gcds-side-nav>
menu-label (gcds-nav-group)
The menu-label attribute of the gcds-nav-group subcomponent defines the label for the nav group menu.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
<gcds-nav-group menu-label="Features" open-trigger="Features">
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
open-trigger (gcds-nav-group)
The open-trigger attribute of the gcds-nav-group subcomponent defines the label for the collapsed button trigger.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
<gcds-nav-group menu-label="Features" open-trigger="Features">
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
href (gcds-nav-link)
The href attribute of the gcds-nav-link subcomponent specifies the URL of the page the link goes to.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
</gcds-side-nav>
close-trigger (gcds-nav-group)
The close-trigger attribute of the gcds-nav-group subcomponent defines the label for the expanded button trigger.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
<gcds-nav-group menu-label="Features" open-trigger="Features" close-trigger="Close Features">
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
open (gcds-nav-group)
The open attribute of the gcds-nav-group subcomponent controls whether the nav group is expanded or not. By default, it is set to false.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
<gcds-nav-group menu-label="Features" open-trigger="Features" open>
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
current (gcds-nav-link)
The current attribute of the gcds-nav-link subcomponent indicates whether the page is current or not.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link current href="#">Contact us</gcds-nav-link>
</gcds-side-nav>
default
The default slot is for adding navigation groups and navigation links.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Why GC Forms</gcds-nav-link>
<gcds-nav-link href="#">Contact us</gcds-nav-link>
<gcds-nav-group menu-label="Features" open-trigger="Features">
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
home
The home slot is for adding the home link or site title.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-link href="#" slot="home">GC Forms</gcds-nav-link>
</gcds-side-nav>
default (gcds-nav-group)
The default slot of the gcds-nav-group subcomponent is for adding the list of navigation links.
<gcds-side-nav label="Side navigation component preview">
<gcds-nav-group menu-label="Features" open-trigger="Features">
<gcds-nav-link href="#">Review in both official languages side-by-side</gcds-nav-link>
<gcds-nav-link href="#">Get form responses delivered securely</gcds-nav-link>
</gcds-nav-group>
</gcds-side-nav>
default (gcds-nav-link)
The default slot of the gcds-nav-link subcomponent is for adding the navigation link content.
<gcds-nav-link href="#">GC Forms</gcds-nav-link>
Code builder
Generate an instance of the component you need by selecting its code properties.
-
Explore by choosing different code values to generate the instance you want.
-
Get the code and pull it into your environment.
-
Add any copy you need to the component (like text for a label).
Note: The code builder uses English for all code elements, which follows standard practice.
Help us improve
Have questions or a request? Give feedback on our contact form.
Something's wrong? Raise it through GitHub with an