Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Base class for all navigation items in Mintlify.Remarks
Provides common properties shared across all navigation elements including API specifications, icons, pages, and visibility settings.Constructors
.ctor Inherited
Inherited from
objectSyntax
Properties
AsyncApi
Gets or sets the AsyncAPI configuration.Syntax
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.Hidden
Gets or sets whether the current option is default hidden.Syntax
Property Value
Type:System.Nullable<bool>?
Remarks
When true, this navigation item will not be displayed in the navigation by default.Icon
Gets or sets the icon to be displayed in the section.Syntax
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
Gets or sets the OpenAPI configuration.Syntax
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
Gets or sets the pages for this navigation item.Syntax
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?