Side Nav

Design System - Side nav component

The Side Nav component acts as the primary navigation pattern, helping users access modules, submodules, and utilities in a compact, vertically stacked structure. Designed for both accessibility and scalability, it accommodates icons, labels, tree structures, and persistent actions, ensuring a consistent experience across municipal and citizen-facing interfaces.

// Sample code

  <CheckBox
    label="Label"
    onChange={(e)=>{console.log(e.target.checked}}
  />

// Sample code

DigitAccordion(
              header: Text('Accordion'),
              content: Text('This is the content of Accordion'),
              initiallyExpanded: false,
              divider: true,
              showBorder: true,
            ),

Anatomy

Variants

Light

Ideal for interfaces with brighter UIs, ensuring visual consistency and high contrast with dark icons and text.

Dark Best suited for dashboards or applications requiring reduced eye strain or a focused visual hierarchy.

Properties

Enable Search Provides a quick-filtering input field at the top of the side nav, enabling users to locate modules and nested items efficiently. Particularly helpful in apps with deep or large information architectures.

Universal Action Includes persistent utilities like Help, Settings, and Logout; these remain accessible regardless of scroll or nav state, improving usability.

Tree Selection for Children Supports hierarchical navigation by displaying submodules or inner navigation when parent items are expanded. Allows users to interact with nested items.

Property Configuration Table

Each design component offers a range of configurable options. These options are intentionally platform-agnostic, allowing implementations to adapt and tailor them to align with the specific requirements of the chosen framework.

Property

Value

Default

items

text

theme

text

variant

yes/no

collapsedWidth

yes/no

expandedWidth

number

transitionDuration

yes/no

styles

yes/no

hideAccessbilityTools

yes/no

enableSearch

yes/no

onSelect

yes/no

onBottomItemClick

number

className

yes/no

Usage Guide

Hierarchical Structure

Enable tree selection for complex apps where submodules need to be grouped contextually.  Don’t flatten deep hierarchies if users need to frequently access child modules—it hinders navigation efficiency.

Change log

Date

Number

Notes

Design Checklist

PreviousPop Ups NextSide Panel

Last updated 7 days ago

Was this helpful?