NavItem

Home
API Reference
Moka
Docs
Core
Configuration
NavItem

Record

public record NavItem : System.IEquatable<Moka.Docs.Core.Configuration.NavItem>

Namespace: Moka.Docs.Core.Configuration

Navigation sidebar item (can be auto-generated or manual override).

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Configuration.NavItem>

Properties

Name	Description
`AutoGenerate`	Auto-generate children from C# projects.
`Children`	Child navigation items.
`Expanded`	Whether this section is expanded by default.
`Icon`	Icon name.
`Label`	Display label.
`Path`	URL path for this nav item.

AutoGenerate

bool NavItem.AutoGenerate { get; init; }

Auto-generate children from C# projects.

Children

List<NavItem> NavItem.Children { get; init; }

Child navigation items.

Expanded

bool NavItem.Expanded { get; init; }

Whether this section is expanded by default.

Icon

string? NavItem.Icon { get; init; }

Icon name.

Label

string NavItem.Label { get; init; }

Display label.

Path

string? NavItem.Path { get; init; }

URL path for this nav item.

Type Relationships

classDiagram
                    style NavItem fill:#f9f,stroke:#333,stroke-width:2px
                    NavItem ..|> NavItem~ : implements

View Source

/// <summary>
///     Navigation sidebar item (can be auto-generated or manual override).
/// </summary>
public sealed record NavItem
{
    /// <summary>Display label.</summary>
    public required string Label { get; init; }
    /// <summary>URL path for this nav item.</summary>
    public string? Path { get; init; }
    /// <summary>Icon name.</summary>
    public string? Icon { get; init; }
    /// <summary>Whether this section is expanded by default.</summary>
    public bool Expanded { get; init; }
    /// <summary>Auto-generate children from C# projects.</summary>
    public bool AutoGenerate { get; init; }
    /// <summary>Child navigation items.</summary>
    public List<NavItem> Children { get; init; } = [];
}