Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationItemBaseSyntax
Summary
Represents a group configuration in Mintlify navigation.Remarks
Groups organize pages into sections in your navigation. The group name is required.Constructors
.ctor
Syntax
.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.Expanded
Gets or sets whether the group is expanded by default in the navigation sidebar.Syntax
Property Value
Type:System.Nullable<bool>?
Remarks
When true, the group will be expanded by default showing all its pages. When false or null, the group will be collapsed by default.Group
Gets or sets the name of the group.Syntax
Property Value
Type:string
Remarks
This is a required field that appears as the group title in navigation. Group names cannot be null. While empty string names are technically accepted, they are not recommended as Mintlify treats each empty group as a separate ungrouped navigation section rather than merging them together.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.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.Root
Gets or sets the root page for the group.Syntax
Property Value
Type:string?
Remarks
Specifies the default page to display when the group is selected.Tag
Gets or sets the tag for the group.Syntax
Property Value
Type:string?
Remarks
Displays a label tag (e.g., “NEW”, “BETA”) next to the group name.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?