The object for defining conditional properties for a component layout, and when the conditional properties are in effect.
- Apple News Format 1.9+
An instance or array of conditions that, when met, cause the conditional component layout properties to take effect.
A number that indicates how many columns the component spans, based on the number of columns in the document.
By default, the component spans the entire width of the document or the width of its container component.
A number that indicates which column the component's start position is in, based on the number of columns in the document or parent container.
By default, the component starts in the first column (note that the first column is
A value that indicates whether the gutters (if any) to the left and right of the component should be ignored. The gutter size is defined in the
Layout object at the root level of the document.
Use this option to position two components next to each other without a gutter between them. This property applies only when a gutter actually exists to the left or right of the component. The first column does not have a left gutter, and the last column does not have a right gutter.
none(default). Gutters are not ignored.
left. Left gutter is ignored.
right. Right gutter is ignored.
both. Gutters on both sides (if any) are ignored.
You can also set this property to
true to indicate that you want to ignore
both gutters, or set it to
false to ignore none of the gutters. By default,
none of the gutters are ignored.
A value that indicates whether a document’s margins should be respected or ignored by the parent container. Ignoring document margins positions the component at the edge of the display. This property affects the layout only if the component is in the first or last column.
none(default). Margins are not ignored.
left. Left margin is ignored.
right. Right margin is ignored.
both. Margins on both sides (if any) are ignored.
Instead of specifying margins, you can set this property to
true to indicate that both margins should be ignored, or set it to
false to ignore none of the gutters. By default, none of the document margins are ignored.
The margins for the top and bottom of the component, as a single integer that is applied to the top and bottom margins, or as an object containing separate properties for top and bottom.
The maximum width of the content within the component. Specify this value as a number in points, or use one of the available units of measure for components. See Specifying Measurements for Components.
The minimum height of the component. A component is taller than its defined
minimum when the contents require it. Specify this value as a number in points, or use one of the available units of measure for components. See Specifying Measurements for Components.
The minimum width of the layout when used within a container with HorizontalStackDisplay as the specified
The padding between the content of the component and the edges of the component.
A value that indicates whether the component should respect or ignore the viewport padding. Ignoring viewport padding positions the component at the edge of the display screen. This property affects the layout only if the component is in the first or last column.
none(default). Padding is not ignored.
left. Left padding is ignored.
right. Right padding is ignored.
both. Padding, if any, on both sides is ignored.
Instead of specifying padding, you can set this property to
true to indicate that paddings on both sides should be ignored, or set it to
false to ignore neither padding. By default, neither padding is ignored.
The layout of a parent component will always constrain any child components. Setting
true for a component will have no effect if it is inside of a container with
ignore set to
ignore is set to
both it overrides the layout’s
ignore value and spans the entire screen.
ignore is set to
none, the value of
ignore is accepted.
By default, components do not ignore the viewport padding, even if you previously specified
ignore to span the entire width of the screen. To achieve the same functionality, you must update your article to use
Conditional object to define an array of conditional component layout properties and the conditions under which to apply them. When a condition is met, the value of a property in
Conditional overrides the value of the same property if defined in the parent
Component object. See ComponentLayout.