Skip to main content

​
Definition

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

​
Syntax

Mintlify.Core.Models.GlobalTabConfig

​
Summary

Represents a tab configuration for global navigation in the Mintlify documentation site.

​
Remarks

This configuration defines a tab that appears globally across all sections and pages, providing users with quick access to different areas or types of documentation.

​
Constructors

​
.ctor

​
Syntax

public GlobalTabConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Hidden

Gets or sets whether this tab is hidden by default.

​
Syntax

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

​
Property Value

Type: System.Nullable<bool>?

​
Remarks

When true, this tab will not be visible in the global navigation unless specifically shown. This can be useful for tabs that are in development or not ready for public access.

​
Href

Gets or sets the URL or path for this tab.

​
Syntax

public string Href { get; set; }

​
Property Value

Type: string?

​
Remarks

Specifies where users should be directed when they click on this tab. Can be a relative path (e.g., “/api/”) or an absolute URL for external content. This determines the landing page for the tab.

​
Icon

Gets or sets the icon to display alongside the tab name.

​
Syntax

public object Icon { get; set; }

​
Property Value

Type: object?

​
Remarks

Can be a string icon name from the configured icon library, or an object with detailed icon configuration including style and library properties. The icon appears before or alongside the tab text to provide visual context.

​
Tab

Gets or sets the display name for the tab.

​
Syntax

public string Tab { get; set; }

​
Property Value

Type: string

​
Remarks

Specifies the text that will be shown on the tab button. Should be concise and descriptive of the tab’s content or purpose, such as “API Reference”, “Guides”, “Examples”, etc. This is a required field.

​
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?