dta.gov.au

The .gov.au means it’s official

Australian government websites always use a .gov.au domain. Before sharing sensitive information online, make sure you’re on a .gov.au site by inspecting your browser’s address (or 'location') bar.

This site is secure.

The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

Side nav

v5.0.0

A vertical list of links for site navigation typically placed next to the body content.

Default

The side navigation allows users to find other pages which share a similar topic or section. By default it supports three levels of nesting along with an accompanying heading.

On mobile and smaller viewports, the side navigation uses functionality from the accordion component to collapse down to an expandable element.

Tips

  • Only expand active subsections to help emphasise which section the user is in and to reduce visual complexity.

  • Keep the navigation link text short. They can be shorter versions of pages titles.

  • If the side navigation is too long, users may miss items at the bottom. If there are too many levels, users may miss items that require too many clicks. Conduct usability testing to find the right balance between breadth and depth.

  • Consider Web Content Accessibility Guidelines 2.1 Success Criterion 3.2.3 Consistent Navigation.

Example

<!--
  Light:  <aside class="au-side-nav">
  Dark:   <aside class="au-side-nav au-side-nav--dark">

  Note: Side nav requires feature detection to see if a user has javascript.
        Please add a `no-js` class on html and replace it with `js` if enabled
        https://www.paulirish.com/2009/avoiding-the-fouc-v3/
-->
<aside class="au-side-nav au-accordion" aria-label="side navigation">
  <button 
    class="au-side-nav__toggle au-accordion__title au-accordion--closed" 
    aria-controls="nav-default"
    aria-expanded="false" 
    aria-selected="false" 
    onclick="return AU.accordion.Toggle( this )"
  >
    In this section
  </button>
  <div id="nav-default" class="au-side-nav__content au-accordion--closed au-accordion__body">
    <h2 class="au-sidenav__title">
      <a href="#">Lodging your tax return</a>
    </h2>
    <ul class="au-link-list">
      <li><a href="#">Do you need to lodge a tax return?</a></li>
      <li><a href="#">Lodge online</a>
        <ul class="au-link-list">
          <li><a href="#">Pre-filling your online tax return</a></li>
        </ul>
      </li>
      <li><a href="#">What's new for individuals</a></li>
      <li><a href="#">Why you may receive a tax bill</a></li>
      <li><a href="#">In detail</a>
        <ul class="au-link-list">
          <li><a href="#">Record keeping</a>
            <ul class="au-link-list">
              <li class="active"><span>Keeping your tax records</span></li>
              <li><a href="#">Incorrect amounts</a></li>
            </ul>
          </li>
          <li><a href="#">Tax receipt</a></li>
          <li><a href="#">Pre-fill availability</a></li>
        </ul>
      </li>
      </ul>
  </div>
</aside>
/*
  Light:  <AUsideNav>
  Dark:   <AUsideNav dark>

  Note: Main nav requires feature detection to see if a user has javascript.
        Please add a `no-js` class on html and replace it with `js` if enabled
        https://www.paulirish.com/2009/avoiding-the-fouc-v3/
*/
<AUsideNav
  dark
  alt
  linkComponent={ Link }
  accordionHeader="In this section"
  menuHeaderLink="#"
  menuHeader="Lodging your tax return"
  items={[
    {
      link: 'one',
      text: 'Change to route one',
      children: [
        {
          link: 'two',
          text: 'Change to route two',
        },
        {
          link: 'three',
          text: 'Change to route three',
        },
      ],
    },
    {
      link: 'four',
      text: 'Change to route four',
    },
  ]}
/>