Side Navigation (side_navigation)

Hierarchical, vertical navigation to place at the side of a page.

🔗 External documentation.

                        type: array
items:
    type: object
    properties:
        title:
            type: string
        attributes:
            $ref: '#/$defs/attributes_value'
        below:
            type: object

                      

            id: side_navigation
label: 'Side Navigation'
description: 'Hierarchical, vertical navigation to place at the side of a page.'
group: Navigation
homepage: 'https://designsystem.digital.gov/components/side-navigation/'
props:
    items:
        id: items
        label: 'Menu items'
        description: 'Full-height and lightweight navigation (including support for dropdowns).'
        schema:
            type: array
            items:
                type: object
                properties:
                    title:
                        type: string
                    attributes:
                        $ref: '#/$defs/attributes_value'
                    below:
                        type: object
examples:
    preview:
        id: preview
        label: Preview
        renderable:
            '@component': side_navigation
            items:
                -
                    title: Home
                    url: 'https://example.com'
                -
                    title: Library
                    url: 'https://example.com'
                    is_expanded: true
                    in_active_trail: true
                    below:
                        -
                            title: 'Sub 1'
                            url: 'https://example.com'
                            in_active_trail: true
                        -
                            title: 'Sub 2'
                            url: 'https://example.com'
                -
                    title: Data
                    url: 'https://example.com'