Skip to main content

​
Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.ThemePairConfig

​
Syntax

Mintlify.Core.Models.ColorsConfig

​
Summary

Represents the color configuration for Mintlify themes.

​
Remarks

The colors to use in your documentation. At the very least, you must define the primary color.

​
Constructors

​
.ctor

​
Syntax

public ColorsConfig()

​
.ctor Inherited

Inherited from Mintlify.Core.Models.ThemePairConfig

​
Syntax

public ThemePairConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Dark Inherited Virtual

Inherited from Mintlify.Core.Models.ThemePairConfig
Gets or sets the value for dark mode.

​
Syntax

public virtual string Dark { get; set; }

​
Property Value

Type: string?

​
Light Inherited Virtual

Inherited from Mintlify.Core.Models.ThemePairConfig
Gets or sets the value for light mode.

​
Syntax

public virtual string Light { get; set; }

​
Property Value

Type: string?

​
Primary

Gets or sets the primary color of the theme in hex format.

​
Syntax

public string Primary { get; set; }

​
Property Value

Type: string

​
Remarks

This is a required field. Must be a valid hex color in format #RRGGBB or #RGB.

​
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

Inherited from Mintlify.Core.Models.ThemePairConfig
Returns the string representation of the theme pair configuration.

​
Syntax

public override string ToString()

​
Returns

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

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?