Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Converters Inheritance: System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.IconConfig>

Syntax

Summary

Handles JSON conversion for icon properties that can be either strings or objects.

Remarks

Icons in Mintlify can be specified as:
  • String: Simple icon name (e.g., “folder”, “home”)
  • Object: Icon configuration with name, style, and library properties

Constructors

.ctor

Syntax

Methods

CanConvert Override

Determines whether the specified type can be converted by this converter.

Syntax

Parameters

Returns

Type: bool True if the type is IconConfig; otherwise, false.

Read Override

Reads and converts the JSON to an IconConfig object.

Syntax

Parameters

Returns

Type: Mintlify.Core.Models.IconConfig? An IconConfig for both simple icon names and complex icon configurations.

Exceptions

Write Override

Writes the IconConfig object to JSON.

Syntax

Parameters