Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.MenuConfig

Summary

Represents a menu item configuration in Mintlify navigation.

Remarks

Menu items appear as dropdown menu options within tabs. The item name is required.

Constructors

.ctor

Syntax

public MenuConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Description

Gets or sets the description of the menu item.

Syntax

public string Description { get; set; }

Property Value

Type: string?

Remarks

Provides additional descriptive text for the menu item.

Groups

Gets or sets the groups for the menu item.

Syntax

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

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig>?

Icon

Gets or sets the icon to be displayed for the menu item.

Syntax

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

Property Value

Type: Mintlify.Core.Models.IconConfig?

Item

Gets or sets the name of the menu item.

Syntax

public string Item { get; set; }

Property Value

Type: string

Remarks

This is a required field that appears as the menu item label.

Pages

Gets or sets the pages for the menu 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.

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?