Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationContainerBaseSyntax
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.NavigationContainerBaseSyntax
.ctor Inherited
Inherited from
Mintlify.Core.Models.NavigationItemBaseSyntax
.ctor Inherited
Inherited from
objectSyntax
Properties
AsyncApi Inherited
Inherited from
Mintlify.Core.Models.NavigationItemBaseSyntax
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
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
Property Value
Type:string?
Remarks
Provides additional descriptive text about this navigation section.Dropdowns
Gets or sets the dropdowns for this navigation section.Syntax
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
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.NavigationContainerBaseSyntax
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.NavigationItemBaseSyntax
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.NavigationContainerBaseSyntax
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.NavigationItemBaseSyntax
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
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.NavigationItemBaseSyntax
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.NavigationItemBaseSyntax
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
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
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?