Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Converters Inheritance: System.Text.Json.Serialization.JsonConverter<object>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 object; otherwise, false.
Read
Reads and converts the JSON to a background image 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:object?
A string for single image URLs or a Dictionary for theme-specific image objects.
Exceptions
| Exception | Description |
|---|---|
JsonException | Thrown when the JSON token type is not supported. |
Write
Writes the background image object to JSON.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
writer | System.Text.Json.Utf8JsonWriter | The JSON writer. |
value | object | The value to write. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |
Exceptions
| Exception | Description |
|---|---|
JsonException | Thrown when the value type is not supported. |