Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents a background image configuration in Mintlify.Remarks
Background images can be simple URL/path references or theme-specific configurations with separate images for light and dark modes. This matches the official Mintlify schema.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Dark
Gets or sets the background image for dark mode.Syntax
Property Value
Type:string?
Remarks
Can be an absolute URL or relative path to an image file. Used when the theme switches to dark mode.Light
Gets or sets the background image for light mode.Syntax
Property Value
Type:string?
Remarks
Can be an absolute URL or relative path to an image file. Used when the theme is in light mode.Url
Gets or sets the single image URL when not using theme-specific images.Syntax
Property Value
Type:string?
Remarks
Used internally when the background image is a simple string. Not serialized directly as it’s handled by the converter.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Override
Returns the string representation of the background image configuration.Syntax
Returns
Type:string
The URL, light image, dark image, or empty string.
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?