Skip to main content

​
Definition

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

​
Syntax

Mintlify.Core.Models.NavbarLink

​
Summary

Represents a navigation link in the Mintlify navbar.

​
Remarks

Each navbar link consists of a label, optional icon, and destination URL. These links provide quick access to important pages or external resources.

​
Constructors

​
.ctor

​
Syntax

public NavbarLink()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Href

Gets or sets the destination URL for the navigation link.

​
Syntax

public string Href { get; set; }

​
Property Value

Type: string?

​
Remarks

Can be an absolute URL (https://example.com) or a relative path (/docs/page). This determines where users navigate when clicking the link.

​
Icon

Gets or sets the icon to display alongside the navigation link.

​
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 the label text.

​
Label

Gets or sets the display text for the navigation link.

​
Syntax

public string Label { get; set; }

​
Property Value

Type: string

​
Remarks

This text appears in the navbar and should be concise and descriptive of the link’s destination. 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?