Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Converters Inheritance: System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.BackgroundImageConfig>Syntax
Summary
Handles JSON conversion for background image properties that can be either strings or objects.Remarks
Background image configurations in Mintlify can be specified as:- String: Single image URL (e.g., “https://example.com/image.png”)
- Object: Light/dark mode specific images with “light” and “dark” properties
Constructors
.ctor
Syntax
Methods
CanConvert
Determines whether the specified type can be converted by this converter.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
typeToConvert | System.Type | The type to convert. |
Returns
Type:bool
True if the type is BackgroundImageConfig; otherwise, false.
Read
Reads and converts the JSON to a BackgroundImageConfig object.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
reader | System.Text.Json.Utf8JsonReader | The JSON reader. |
typeToConvert | System.Type | The type to convert to. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |
Returns
Type:Mintlify.Core.Models.BackgroundImageConfig?
A BackgroundImageConfig for both simple URLs and theme-specific configurations.
Exceptions
| Exception | Description |
|---|---|
JsonException | Thrown when the JSON token type is not supported. |
Write
Writes the BackgroundImageConfig object to JSON.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
writer | System.Text.Json.Utf8JsonWriter | The JSON writer. |
value | Mintlify.Core.Models.BackgroundImageConfig? | The BackgroundImageConfig value to write. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |