navigationrail.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include <QtCore/qobject.h>
#include <QtQml/qqmlregistration.h>
 
#include "elevationtokens.h"
#include "shapetokens.h"
#include "statetokens.h"
 
// Component values map to the AndroidX Material 3 generated tokens:
// https://android.googlesource.com/platform/frameworks/support/+/5ba2cdd61be7b6945db999b238d14f3c626136fb/compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/tokens/
// NavigationRailBaselineItemTokens.kt, NavigationRailCollapsedTokens.kt,
// NavigationRailExpandedTokens.kt, NavigationRailHorizontalItemTokens.kt, and
// NavigationRailVerticalItemTokens.kt, VERSION: v0_11_0; ScrimTokens.kt, VERSION: v0_117.
// ItemHorizontalPadding follows the AndroidX WideNavigationRail implementation at:
// https://android.googlesource.com/platform/frameworks/support/+/8ac4ef277273e07d515f12ad4d71d517d7c57fef/compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/WideNavigationRail.kt
 
namespace Fluid {
 
struct NavigationRail
{
    Q_GADGET
    QML_ANONYMOUS
 
    Q_PROPERTY(qreal containerElevation READ containerElevation CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue containerShape READ containerShape CONSTANT FINAL)
    Q_PROPERTY(qreal collapsedContainerWidth READ collapsedContainerWidth CONSTANT FINAL)
    Q_PROPERTY(
            qreal expandedContainerWidthMinimum READ expandedContainerWidthMinimum CONSTANT FINAL)
    Q_PROPERTY(
            qreal expandedContainerWidthMaximum READ expandedContainerWidthMaximum CONSTANT FINAL)
    Q_PROPERTY(qreal modalContainerElevation READ modalContainerElevation CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue modalContainerShape READ modalContainerShape CONSTANT FINAL)
    Q_PROPERTY(qreal topSpace READ topSpace CONSTANT FINAL)
    Q_PROPERTY(qreal collapsedItemVerticalSpace READ collapsedItemVerticalSpace CONSTANT FINAL)
    Q_PROPERTY(qreal itemContainerHeight READ itemContainerHeight CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue itemContainerShape READ itemContainerShape CONSTANT FINAL)
    Q_PROPERTY(qreal itemContainerVerticalSpace READ itemContainerVerticalSpace CONSTANT FINAL)
    Q_PROPERTY(qreal headerSpaceMinimum READ headerSpaceMinimum CONSTANT FINAL)
    Q_PROPERTY(qreal iconSize READ iconSize CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue activeIndicatorShape READ activeIndicatorShape CONSTANT FINAL)
    Q_PROPERTY(
            qreal activeIndicatorIconLabelSpace READ activeIndicatorIconLabelSpace CONSTANT FINAL)
    Q_PROPERTY(qreal activeIndicatorLeadingSpace READ activeIndicatorLeadingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal activeIndicatorTrailingSpace READ activeIndicatorTrailingSpace CONSTANT FINAL)
    Q_PROPERTY(
            qreal verticalActiveIndicatorHeight READ verticalActiveIndicatorHeight CONSTANT FINAL)
    Q_PROPERTY(qreal verticalActiveIndicatorWidth READ verticalActiveIndicatorWidth CONSTANT FINAL)
    Q_PROPERTY(qreal verticalIconLabelSpace READ verticalIconLabelSpace CONSTANT FINAL)
    Q_PROPERTY(qreal verticalLeadingSpace READ verticalLeadingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal verticalTrailingSpace READ verticalTrailingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal horizontalActiveIndicatorHeight READ horizontalActiveIndicatorHeight CONSTANT
                       FINAL)
    Q_PROPERTY(qreal horizontalFullWidthLeadingSpace READ horizontalFullWidthLeadingSpace CONSTANT
                       FINAL)
    Q_PROPERTY(qreal horizontalFullWidthTrailingSpace READ horizontalFullWidthTrailingSpace CONSTANT
                       FINAL)
    Q_PROPERTY(qreal horizontalIconLabelSpace READ horizontalIconLabelSpace CONSTANT FINAL)
    Q_PROPERTY(qreal horizontalLeadingSpace READ horizontalLeadingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal itemHorizontalPadding READ itemHorizontalPadding CONSTANT FINAL)
    Q_PROPERTY(qreal hoverStateLayerOpacity READ hoverStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal focusStateLayerOpacity READ focusStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal pressedStateLayerOpacity READ pressedStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal disabledContentOpacity READ disabledContentOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal modalScrimOpacity READ modalScrimOpacity CONSTANT FINAL)
 
public:
    constexpr qreal containerElevation() const
    {
        return ElevationTokens{ }.level0();
    }
 
    constexpr ShapeValue containerShape() const
    {
        return ShapeTokens{ }.cornerNone();
    }
 
    constexpr qreal collapsedContainerWidth() const
    {
        return 96.0;
    }
 
    constexpr qreal expandedContainerWidthMinimum() const
    {
        return 220.0;
    }
 
    constexpr qreal expandedContainerWidthMaximum() const
    {
        return 360.0;
    }
 
    constexpr qreal modalContainerElevation() const
    {
        return ElevationTokens{ }.level2();
    }
 
    constexpr ShapeValue modalContainerShape() const
    {
        return ShapeTokens{ }.cornerLarge();
    }
 
    constexpr qreal topSpace() const
    {
        return 44.0;
    }
 
    constexpr qreal collapsedItemVerticalSpace() const
    {
        return 4.0;
    }
 
    constexpr qreal itemContainerHeight() const
    {
        return 64.0;
    }
 
    constexpr ShapeValue itemContainerShape() const
    {
        return ShapeTokens{ }.cornerNone();
    }
 
    constexpr qreal itemContainerVerticalSpace() const
    {
        return 6.0;
    }
 
    constexpr qreal headerSpaceMinimum() const
    {
        return 40.0;
    }
 
    constexpr qreal iconSize() const
    {
        return 24.0;
    }
 
    constexpr ShapeValue activeIndicatorShape() const
    {
        return ShapeTokens{ }.cornerFull();
    }
 
    constexpr qreal activeIndicatorIconLabelSpace() const
    {
        return 8.0;
    }
 
    constexpr qreal activeIndicatorLeadingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal activeIndicatorTrailingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal verticalActiveIndicatorHeight() const
    {
        return 32.0;
    }
 
    constexpr qreal verticalActiveIndicatorWidth() const
    {
        return 56.0;
    }
 
    constexpr qreal verticalIconLabelSpace() const
    {
        return 4.0;
    }
 
    constexpr qreal verticalLeadingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal verticalTrailingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal horizontalActiveIndicatorHeight() const
    {
        return 56.0;
    }
 
    constexpr qreal horizontalFullWidthLeadingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal horizontalFullWidthTrailingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal horizontalIconLabelSpace() const
    {
        return 8.0;
    }
 
    constexpr qreal horizontalLeadingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal itemHorizontalPadding() const
    {
        return 20.0;
    }
 
    constexpr qreal hoverStateLayerOpacity() const
    {
        return StateTokens{ }.hoverStateLayerOpacity();
    }
 
    constexpr qreal focusStateLayerOpacity() const
    {
        return StateTokens{ }.focusStateLayerOpacity();
    }
 
    constexpr qreal pressedStateLayerOpacity() const
    {
        return StateTokens{ }.pressedStateLayerOpacity();
    }
 
    constexpr qreal disabledContentOpacity() const
    {
        return 0.38;
    }
 
    constexpr qreal modalScrimOpacity() const
    {
        return 0.32;
    }
};
 
} // namespace Fluid