Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

Syntax

Mintlify.Core.Models.NavigationItemBase

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 object

Syntax

public Object()

Properties

AsyncApi

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.

Hidden

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.

Icon

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

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

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?