Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
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
.ctor Inherited
Inherited from
objectSyntax
Properties
Href
Gets or sets the destination URL for the navigation link.Syntax
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
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
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.Type
Gets or sets the link type for special social/service links.Syntax
Property Value
Type:string?
Remarks
When specified, displays a service-specific icon and styling. Common values include “github” and “discord”. When not specified, the link displays with its label and optional icon.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?