Definition

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

Syntax

Mintlify.Core.Models.GlobalDropdownConfig

Summary

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

Remarks

This configuration defines a dropdown menu that appears globally across all sections and pages, providing users with organized access to multiple related links or sections.

Constructors

.ctor

Syntax

public GlobalDropdownConfig()

Properties

Color

Gets or sets the color configuration for the dropdown.

Syntax

public Mintlify.Core.Models.ColorPairConfig Color { get; set; }

Property Value

Type: Mintlify.Core.Models.ColorPairConfig?

Remarks

Defines custom colors for the dropdown in light and dark modes. This allows the dropdown to have distinctive styling that matches your brand or indicates different types of content.

Description

Gets or sets the description text for the dropdown.

Syntax

public string Description { get; set; }

Property Value

Type: string?

Remarks

Optional descriptive text that can appear in the dropdown or as a tooltip. Provides additional context about what users will find in the dropdown menu. Gets or sets the display name for the dropdown button.

Syntax

public string Dropdown { get; set; }

Property Value

Type: string

Remarks

Specifies the text that will be shown on the dropdown button. Should be concise and descriptive of the dropdown’s contents, such as “Resources”, “Tools”, “Community”, etc. This is a required field.

Hidden

Gets or sets whether this dropdown is hidden by default.

Syntax

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

Property Value

Type: System.Nullable<bool>?

Remarks

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

Href

Gets or sets the primary URL or path for this dropdown.

Syntax

public string Href { get; set; }

Property Value

Type: string?

Remarks

Specifies where users should be directed when they click directly on the dropdown button (rather than selecting a specific item). Can be a relative path or absolute URL. This is optional if the dropdown only contains sub-items.

Icon

Gets or sets the icon to display alongside the dropdown 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 the dropdown text to provide visual context.