Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.ColorConfig

Summary

Represents a color configuration for Mintlify. Can be a simple hex color string or a complex color pair configuration with light and dark modes.

Constructors

.ctor

Initializes a new instance of the ColorConfig class.

Syntax

public ColorConfig()

.ctor

Initializes a new instance of the ColorConfig class with a single color.

Syntax

public ColorConfig(string color)

Parameters

NameTypeDescription
colorstring?The hex color string for both light and dark modes.

.ctor

Initializes a new instance of the ColorConfig class with separate light and dark colors.

Syntax

public ColorConfig(string light, string dark)

Parameters

NameTypeDescription
lightstring?The hex color string for light mode.
darkstring?The hex color string for dark mode.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Dark

Gets or sets the color in hex format to use in dark mode.

Syntax

public string Dark { get; set; }

Property Value

Type: string?

Light

Gets or sets the color in hex format to use in light mode.

Syntax

public string Light { get; set; }

Property Value

Type: string?

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 color configuration.

Syntax

public override string ToString()

Returns

Type: string The light color, dark color, or empty string.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?