Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationItemBaseSyntax
Summary
Base class for navigation items that can contain groups and have external links.Remarks
Extends NavigationItemBase to add support for nested groups and external URLs. Used by products and other container-level navigation elements.Constructors
.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.Groups
Gets or sets the groups for this navigation container.Syntax
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
Gets or sets the URL or path for this navigation container.Syntax
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.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.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?