Object

ConditionalText

The object for defining conditional properties for a text component, and when the conditional properties are in effect.

Properties

conditions
*
(Required)

An instance or array of conditions that, when met, cause the conditional text component properties to take effect.

anchor

An object that defines vertical alignment with another component.

animation
*

An object that defines an animation to be applied to the component.

To remove a previously set condition, use none.

behavior
*

An object that defines behavior for a component, like Parallax or Springy.

To remove a previously set condition, use none.

hidden
boolean

A Boolean value that determines whether the component is hidden.

inlineTextStyles
*

An array of InlineTextStyle objects that you can use to apply different text styles to ranges of text. For each InlineTextStyle object, supply rangeStart and rangeLength values, and either a text style or the identifier of a text style that is defined at the top level of the document.

Inline text styles are ignored when the format is set to html or markdown.

To remove a previously set condition, use none.

layout
*

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that is defined at the top level of the document.

If layout is not defined, size and position are based on various factors, such as the device type, the length of the content, and the role of this component.

style
*

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that is defined at the top level of the document.

To remove a previously set condition, use none.

textStyle
*

An inline ComponentTextStyle object that contains styling information, or a string reference to a ComponentTextStyle object that is defined at the top level of the document.

Discussion

Use the ConditionalText object to define an array of conditional text properties and the conditions under which to apply them. When a condition is met, the value of a property in ConditionalText overrides the value of the same property if defined in the parent Text component. See Text.

Example

{ "components": [ { "role": "text", "textStyle": "exampleTextStyleSmall", "text": "Apple News Format allows publishers to craft beautiful editorial layouts. Galleries, audio, video, and fun interactions like animation make stories spring to life.", "conditional": [ { "textStyle": "exampleTextStyleMedium", "conditions": [ { "minViewportWidth": 415 } ] }, { "textStyle": "exampleTextStyleLarge", "conditions": [ { "minViewportWidth": 769 } ] } ] } ], "componentTextStyles": { "exampleTextStyleSmall": { "fontSize": 16 }, "exampleTextStyleMedium": { "fontSize": 24 }, "exampleTextStyleLarge": { "fontSize": 48 } }}

Relationships

See Also

Conditional Design Elements

object Condition

The object for defining a condition that, when met, causes conditional properties to go into effect.

object ConditionalComponent

The object for defining conditional properties for a component, and when the conditional properties are in effect.

object ConditionalComponentLayout

The object for defining conditional properties for a component layout, and when the conditional properties are in effect.

object ConditionalAutoPlacement

The object for defining conditional properties for an automatically placed component, and when the conditional properties are in effect.

object ConditionalSection

The object for defining conditional properties for a section component, and when the conditional properties are in effect.

object ConditionalDocumentStyle

The object for defining conditional properties for a document style, and when the conditional properties are in effect.

object ConditionalTextStyle

The object for defining conditional properties for a text style, and when the conditional properties are in effect.

object ConditionalComponentTextStyle

The object for defining conditional properties for a component text style, and when the conditional properties are in effect.

object ConditionalComponentStyle

The object for defining conditional properties for a component style, and when the conditional properties are in effect.

object ConditionalContainer

The object for defining conditional properties for a container component, and when the conditional properties are in effect.

object ConditionalDivider

The object for defining conditional properties for a divider component, and when the conditional properties are in effect.

object ConditionalButton

The object for defining a button component's conditional properties, and when the conditional properties are in effect.