Builder
Functions
Ports setAccessibilityHeading into components world. However, since the aforementioned ViewCompat's method is available only on API 19 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being treated as a heading. The AccessibilityHeading property allows accessibility services to help users navigate directly from one heading to the next. See setHeading for more information.
The AlignSelf property has the same options and effect as AlignItems but instead of affecting the children within a container, you can apply this property to a single child to change its alignment within its parent. See https://www.yogalayout.dev/docs/styling/align-content for more information.
The AlignItems property describes how to align children along the cross axis of their container. AlignItems is very similar to JustifyContent but instead of applying to the main axis, it applies to the cross axis. See https://www.yogalayout.dev/docs/styling/align-items-self for more information.
Controls how a child aligns in the cross direction, overriding the alignItems of the parent. See https://www.yogalayout.dev/docs/styling/align-items-self for more information.
Links a DynamicValue object ot the alpha value for this Component
Sets the alpha (opacity) of this component.
Defined as the ratio between the width and the height of a node. See https://www.yogalayout.dev/docs/styling/aspect-ratio for more information
Set the background of this component. The background drawable can implement for more efficient diffing while when drawables are remounted or updated.
Links a DynamicValue object to the background color value for this Component
Links a DynamicValue object to the background drawable for this Component
Ports setClipChildren into components world. However, there is no guarantee that child of this component would be translated into direct view child in the resulting view hierarchy.
If true, component applies all of its children's drawable states (focused, pressed, etc.) to itself.
If true, component duplicates its drawable state (focused, pressed, etc.) from the direct parent.
Sets flexGrow, flexShrink, and flexBasis at the same time.
The FlexBasis property is an axis-independent way of providing the default size of an item on the main axis. Setting the FlexBasis of a child is similar to setting the Width of that child if its parent is a container with FlexDirection = row or setting the Height of a child if its parent is a container with FlexDirection = column. The FlexBasis of an item is the default size of that item, the size of the item before any FlexGrow and FlexShrink calculations are performed. See https://www.yogalayout.dev/docs/styling/flex-basis-grow-shrink for more information.
If the sum of childrens' main axis dimensions is less than the minimum size, how much should this component grow? This value represents the "flex grow factor" and determines how much this component should grow along the main axis in relation to any other flexible children. See https://www.yogalayout.dev/docs/styling/flex-basis-grow-shrink for more information.
The FlexShrink property describes how to shrink children along the main axis in the case that the total size of the children overflow the size of the container on the main axis. See https://www.yogalayout.dev/docs/styling/flex-basis-grow-shrink for more information.
Set the foreground of this component. The foreground drawable must extend for more efficient diffing while when drawables are remounted or updated. If the drawable does not extend ComparableDrawable then create a new class which extends ComparableDrawable and implement the isEquivalentTo.
The Gap property is set on containers and spaces children evenly by a given length along a given axis
Sets the height of the Component to be a percentage of its parent's height. Note that if the parent has unspecified height (e.g. it is a RecyclerView), then setting this will have no effect.
Specifies the height of the element's content area. See https://www.yogalayout.dev/docs/styling/width-height for more information
The JustifyContent property describes how to align children within the main axis of a container. For example, you can use this property to center a child horizontally within a container with FlexDirection = Row or vertically within one with FlexDirection = Column. See https://www.yogalayout.dev/docs/styling/justify-content for more information.
Set a key on the component that is local to its parent.
Backwards compatibility for a Kotlin Component to accept a Style and apply it to a Java Spec Component. Using this builder method is the equivalent of setting all common props the Style defines.
The RTL/LTR direction of components and text. Determines whether START and END will resolve to the left or right side, among other things. INHERIT indicates this setting will be inherited from this component's parent.
Effects the spacing around the outside of a node. A node with margin will offset itself from the bounds of its parent but also offset the location of any siblings. See https://www.yogalayout.dev/docs/styling/margin-padding-border for more information
This property has higher priority than all other properties and will always be respected. See https://www.yogalayout.dev/docs/styling/min-max-width-height for more information
Affects the size of the node it is applied to. Padding will not add to the total size of an element if it has an explicit size set. See https://www.yogalayout.dev/docs/styling/margin-padding-border for more information
When used in combination with positionType of ABSOLUTE, allows the component to specify how it should be positioned within its parent. See https://www.yogalayout.dev/docs/styling/position for more information.
Controls how this component will be positioned within its parent. See https://www.yogalayout.dev/docs/styling/position for more details.
Set this to true if you want the container to be laid out in reverse.
Links a DynamicValue object to the rotation value for this Component
Sets the degree that this component is rotated around the pivot point. Increasing the value results in clockwise rotation. By default, the pivot point is centered on the component.
Links a DynamicValue object to the rotationX value for this Component
Sets the degree that this component is rotated around the horizontal axis through the pivot point.
Links a DynamicValue object to the rotationY value for this Component
Sets the degree that this component is rotated around the vertical axis through the pivot point.
Sets the scale (scaleX and scaleY) on this component. This is mostly relevant for animations and being able to animate size changes. Otherwise for non-animation usecases, you should use the standard layout properties to control the size of your component.
Links a DynamicValue object to the scaleX value for this Component
Links a DynamicValue object to the scaleY value for this Component
Links a DynamicValue object to the elevation value for this Component
Ports setStateListAnimator into components world. However, since the aforementioned view's method is available only on API 21 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being wrapped into a view
Ports setStateListAnimator into components world. However, since the aforementioned view's method is available only on API 21 and above, calling this method on lower APIs will have no effect. On the legit versions, on the other hand, calling this method will lead to the component being wrapped into a view
Links a DynamicValue object to the translationX value for this Component
Links a DynamicValue object to the translationY value for this Component
Links a DynamicValue object to the translationZ value for this Component
When set to true, overrides the default behaviour of baseline calculation and uses height of component as baseline. By default the baseline of a component is the baseline of first child of component (If the component does not have any child then baseline is height of the component)
Sets the width of the Component to be a percentage of its parent's width. Note that if the parent has unspecified width (e.g. it is an HScroll), then setting this will have no effect.
Specifies the width of the element's content area. See https://www.yogalayout.dev/docs/styling/width-height for more information
The FlexWrap property is set on containers and controls what happens when children overflow the size of the container along the main axis. If a container specifies WRAP then its children will wrap to the next line instead of overflowing.