Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.NavigationContainerBase

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

Syntax

protected NavigationItemBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AsyncApi Inherited

Inherited from Mintlify.Core.Models.NavigationItemBase
Gets or sets the AsyncAPI configuration.

Syntax

public Mintlify.Core.Models.ApiSpecConfig AsyncApi { get; set; }

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

public System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig> Groups { get; set; }

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

public System.Nullable<bool> Hidden { get; set; }

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

public string Href { get; set; }

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

public Mintlify.Core.Models.IconConfig Icon { get; set; }

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

public Mintlify.Core.Models.ApiSpecConfig OpenApi { get; set; }

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

public System.Collections.Generic.List<object> Pages { get; set; }

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 object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?