Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationContainerBase

Syntax

Mintlify.Core.Models.NavigationSectionBase

Summary

Base class for top-level navigation sections (tabs, anchors, dropdowns).

Remarks

Extends NavigationContainerBase to add support for colors, descriptions, global navigation, versioning, and language support. Used by tabs, anchors, and dropdowns which are the primary navigation sections.

Constructors

.ctor Inherited

Inherited from Mintlify.Core.Models.NavigationContainerBase

Syntax

protected NavigationContainerBase()

.ctor Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase

Syntax

protected NavigationItemBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AsyncApi Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets the AsyncAPI configuration.

Syntax

public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; }

Property Value

Type: Mintlify.Core.Models.ApiSpecConfig?

Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties pointing to AsyncAPI specification files.

Color

Gets or sets the color configuration for this navigation section.

Syntax

public Mintlify.Core.Models.ColorPairConfig Color { get; set; }

Property Value

Type: Mintlify.Core.Models.ColorPairConfig?

Remarks

Defines the primary and secondary colors used for this section’s visual styling.

Description

Gets or sets the description of this navigation section.

Syntax

public string Description { get; set; }

Property Value

Type: string?

Remarks

Provides additional descriptive text about this navigation section. Gets or sets the dropdowns for this navigation section.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig> Dropdowns { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig>?

Remarks

Dropdowns create expandable menu sections within this navigation section.

Global

Gets or sets global navigation items that appear on all sections and pages.

Syntax

public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; }

Property Value

Type: Mintlify.Core.Models.GlobalNavigationConfig?

Remarks

Global navigation items persist across different tabs and pages for consistent navigation.

Groups Inherited

Inherited from Mintlify.Core.Models.NavigationContainerBase
Gets or sets the groups for this navigation container.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig> Groups { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig>?

Remarks

Groups organize pages into labeled sections within this navigation container.

Hidden Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets whether the current option is default hidden.

Syntax

public System.Nullable<bool> Hidden { get; set; }

Property Value

Type: System.Nullable<bool>?

Remarks

When true, this navigation item will not be displayed in the navigation by default.

Href Inherited

Inherited from Mintlify.Core.Models.NavigationContainerBase
Gets or sets the URL or path for this navigation container.

Syntax

public string Href { get; set; }

Property Value

Type: string?

Remarks

Can be used to link to an external URL or specify a path for this container.

Icon Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets the icon to be displayed in the section.

Syntax

public Mintlify.Core.Models.IconConfig Icon { get; set; }

Property Value

Type: Mintlify.Core.Models.IconConfig?

Remarks

Can be a Font Awesome icon name, Lucide icon name, JSX-compatible SVG code, URL to an externally hosted icon, or path to an icon file in your project.

Languages

Gets or sets the languages for this navigation section.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig> Languages { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig>?

Remarks

Allows partitioning navigation into different language-specific versions.

OpenApi Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets the OpenAPI configuration.

Syntax

public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; }

Property Value

Type: Mintlify.Core.Models.ApiSpecConfig?

Remarks

Can be a string URL, an array of URLs, or an object with source and directory properties pointing to OpenAPI specification files.

Pages Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets the pages for this navigation item.

Syntax

public System.Collections.Generic.List<object> Pages { get; set; }

Property Value

Type: System.Collections.Generic.List<object>?

Remarks

Pages can be strings (page paths) or nested GroupConfig objects for hierarchical navigation.

Versions

Gets or sets the versions for this navigation section.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig> Versions { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig>?

Remarks

Allows partitioning navigation into different version-specific documentation.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?