Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationContainerBaseSyntax
Summary
Represents a product configuration in Mintlify navigation.Remarks
Products separate documentation into distinct product-specific sections. The product name is required.Constructors
.ctor
Syntax
.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.Description
Gets or sets the description of the product.Syntax
Property Value
Type:string?
Remarks
Provides additional context about the product section.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.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.Product
Gets or sets the name of the product.Syntax
Property Value
Type:string
Remarks
This is a required field that appears as the product label in 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?