Definition

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

Syntax

Mintlify.Core.Models.IconConfig

Summary

Represents an icon configuration in Mintlify.

Remarks

Icons can be simple string references or detailed configurations with style and library options. This matches the official Mintlify schema at https://mintlify.com/docs.json

Constructors

.ctor

Syntax

public IconConfig()

Properties

Library

Gets or sets the icon library.

Syntax

public string Library { get; set; }

Property Value

Type: string?

Remarks

Specifies which icon library to use. Defaults to “fontawesome” if not specified. Supported libraries include “fontawesome” and “lucide”.

Name

Gets or sets the icon name.

Syntax

public string Name { get; set; }

Property Value

Type: string

Remarks

This is the specific icon name, such as “home”, “folder”, “user”, etc.

Style

Gets or sets the icon style.

Syntax

public string Style { get; set; }

Property Value

Type: string?

Remarks

Specifies the style variant of the icon. Common styles include: “brands”, “duotone”, “light”, “regular”, “solid”.

Methods

ToString

Returns the string representation of the icon.

Syntax

public override string ToString()

Returns

Type: string The icon name or an empty string if null.