ConditionalDocumentStyle
The object for defining conditional properties for a document style, and when the conditional properties are in effect.
Declaration
object ConditionalDocumentStyleProperties
| Name | Type | Description |
|---|---|---|
conditions Required | (Condition | [Condition]) | An instance or array of conditions that, when met, cause the conditional document style properties to take effect. |
backgroundColor | Color | The document’s background color. The value defaults to white. |
Mentioned in
Discussion
Use the ConditionalDocumentStyle object to define an array of conditional document-style properties and the conditions under which to apply them. When a condition is met, the value of a property in ConditionalDocumentStyle overrides the value of the same property if defined in the parent DocumentStyle object. See DocumentStyle.
Example
{
"documentStyle": {
"backgroundColor": "#FFF",
"conditional": [
{
"backgroundColor": "#000",
"conditions": [
{
"preferredColorScheme": "dark"
}
]
}
]
},
"components": [
{
"role": "title",
"text": "Apple News Format"
},
{
"role": "body",
"text": "Apple News Format allows publishers to craft beautiful editorial layouts. Galleries, audio, video, and fun interactions like animation make stories spring to life."
},
{
"role": "photo",
"URL": "bundle://image.jpg"
}
]
}