Skip to main content

​
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()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
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

​
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 Override

Returns the string representation of the icon.

​
Syntax

public override string ToString()

​
Returns

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

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?