PrimaryNavigationConfig

Definition

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

Syntax

Mintlify.Core.Models.PrimaryNavigationConfig

Summary

Represents the primary navigation configuration for Mintlify navbar. Can be a button configuration or a GitHub configuration.

Constructors

.ctor

Initializes a new instance of the PrimaryNavigationConfig class.

Syntax

public PrimaryNavigationConfig()

.ctor

Initializes a new instance of the PrimaryNavigationConfig class for a button.

Syntax

public PrimaryNavigationConfig(string label, string href)

Parameters

Name	Type	Description
`label`	`string`	The button label.
`href`	`string`	The button href URL.

.ctor

Initializes a new instance of the PrimaryNavigationConfig class for GitHub.

Syntax

public PrimaryNavigationConfig(string href)

Parameters

Name	Type	Description
`href`	`string`	The GitHub URL.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Href

Gets or sets the href URL for the navigation item.

Syntax

public string Href { get; set; }

Property Value

Type: string?

Label

Gets or sets the label text for button-type navigation items.

Syntax

public string Label { get; set; }

Property Value

Type: string?

Type

Gets or sets the type of navigation item (e.g., “button”, “github”).

Syntax

public string Type { get; set; }

Property Value

Type: string?

Methods

Button

Creates a button-type navigation configuration.

Syntax

public static Mintlify.Core.Models.PrimaryNavigationConfig Button(string label, string href)

Parameters

Name	Type	Description
`label`	`string`	The button label.
`href`	`string`	The button href URL.

Returns

Type: Mintlify.Core.Models.PrimaryNavigationConfig A PrimaryNavigationConfig configured as a button.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

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

GitHub

Creates a GitHub-type navigation configuration.

Syntax

public static Mintlify.Core.Models.PrimaryNavigationConfig GitHub(string href)

Parameters

Name	Type	Description
`href`	`string`	The GitHub URL.

Returns

Type: Mintlify.Core.Models.PrimaryNavigationConfig A PrimaryNavigationConfig configured for GitHub.

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

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Override

Returns the string representation of the navigation configuration.

Syntax

public override string ToString()

Returns

Type: string The href URL or empty string.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ Href

​Syntax

​Property Value

​ Label

​Syntax

​Property Value

​ Type

​Syntax

​Property Value

​Methods

​ Button

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ GitHub

​Syntax

​Parameters

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Override

​Syntax

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Properties

Href

Syntax

Property Value

Label

Syntax

Property Value

Type

Syntax

Property Value

Methods

Button

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

GitHub

Syntax

Parameters

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Override

Syntax

Returns

ToString Inherited Virtual

Syntax

Returns