Skip to content
Frauthy Brand
Frauthy index

Go anywhere.

    No exact contract found. Try a component family, product name, prop, or keyboard key.

    ↑↓ move↵ openesc close

    08 · Data & navigation

    beta

    SideNav

    A labelled, sectioned navigation landmark with real links, current-page state, disabled text, and optional badges.

    Since
    1.0.0-next.0
    Owner
    Brand Core
    Export
    PRIVATE_BETA_PACKAGE_COORDINATE_REDACTED/SideNav
    Release
    Documentation version
    Deterministic fixture · default state

    Component studio

    light · comfortable · LTR
    Recent decisions3 events
    1. allow user:ada → portal:docs
    2. deny user:lin → key:prod
    3. allow service:sync → schema:main
    §01

    Contract

    Semantics first

    Anatomy

    Uses nav, section headings, lists, anchors, and aria-current=page; disabled destinations render as non-link text.

    Consumer classes, styles, and data attributes may extend the surface, but required roles, IDs, relationships, and handlers remain owned by the component.

    Keyboard

    • Tab reaches enabled links in document order.
    • Enter follows the focused link.
    • Disabled destinations are perceivable but are not tab stops.
    §02

    Public surface

    API & styling

    Props

    id
    Explicit IDs override stable generated IDs.
    class / style
    Consumer additions compose with required styles.
    ref
    Element or callback where focus control is expected.
    children
    Typed content; raw HTML strings are never rendered.

    Slots & events

    children
    Primary content slot.
    onChange
    Typed value plus a small reason object when state changes.
    native events
    Composed without overwriting required handlers.

    State attributes

    • data-fui-side-nav
    • data-fui-nav-section
    • data-fui-current
    • data-fui-disabled

    CSS tokens

    • --fui-navigation-*
    • --fui-side-nav-*
    • --fui-focus-color
    §03

    Consumption

    Solid, Vite & Astro

    Solid / VitePRIVATE_BETA_PACKAGE_COORDINATE_REDACTED/SideNav
    import SideNav from 'PRIVATE_BETA_PACKAGE_COORDINATE_REDACTED/SideNav';
    
    <SideNav>Frauthy content</SideNav>
    Astrostatic
    ---
    import SideNav from 'PRIVATE_BETA_PACKAGE_COORDINATE_REDACTED/SideNav';
    ---
    
    <SideNav>Frauthy content</SideNav>
    §04

    Verification

    Evidence record

    Scheduled

    Automated

    Batch D navigation tests cover landmark label, sections, real/current links, disabled non-links, badges, and deterministic source order.

    Target
    Brand 1.0.0-next.0 matrix
    Last verified
    Pending integrated G2 run
    Required

    Assistive technology

    Pending VoiceOver and NVDA landmark, section heading, and current-page sequence verification.

    Desktop
    VoiceOver/Safari · NVDA/Firefox
    Touch
    Not required for beta
    Open

    Known issues

    • Section labels render as h2; consumers must ensure that level fits the surrounding application outline.
    §05

    Editorial guidance

    Do / don’t

    Do

    Use durable URLs, one current page, and section labels that help users scan the product hierarchy.

    Don’t

    Do not install arrow-key navigation or hide disabled destinations behind inert anchors.

    Release activity

    SideNav · Brand Core

    1 recorded change · 26 weeks
    1. 1.0.0-next.3

      Baseline public component contract.

    Version & provenance

    New in the v2 architecture

    There is no stable predecessor for this explicit compiled subpath. The v1 compatibility layer remains tested separately; visual and API diffs begin with the next prerelease.

    Current
    1.0.0-next.0
    Previous
    compatibility surface
    Deprecation
    none
    Replacement
    not applicable
    Next in Data & navigationTopNav