Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.NavigationContainerBase

Syntax

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.NavigationContainerBase

Syntax

.ctor Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

AsyncApi Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
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.

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.NavigationContainerBase
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.NavigationItemBase
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.

Href Inherited

Inherited from Mintlify.Core.Models.NavigationContainerBase
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.NavigationItemBase
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 Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
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 Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
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.

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 object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?