Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun alignSelf(alignSelf: YogaAlign): Wrapper.Builder

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.

Link copied to clipboard

Links a DynamicValue object ot the alpha value for this Component

open fun alpha(alpha: Float): Wrapper.Builder

Sets the alpha (opacity) of this component.

Link copied to clipboard
open fun aspectRatio(aspectRatio: Float): Wrapper.Builder

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

Link copied to clipboard
open fun background(@Nullable background: Drawable?): Wrapper.Builder

Set the background of this component. The background drawable can implement for more efficient diffing while when drawables are remounted or updated.

Link copied to clipboard
open fun backgroundAttr(@AttrRes resId: Int, @DrawableRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard

Links a DynamicValue object to the background color value for this Component

open fun backgroundColor(@ColorInt backgroundColor: Int): Wrapper.Builder
Link copied to clipboard

Links a DynamicValue object to the background drawable for this Component

Link copied to clipboard
Link copied to clipboard
open fun border(@Nullable border: Border?): Wrapper.Builder
Link copied to clipboard
open override fun build(): Wrapper
Link copied to clipboard
open fun clickable(isClickable: Boolean): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun clipChildren(clipChildren: Boolean): Wrapper.Builder

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.

Link copied to clipboard
open fun clipToOutline(clipToOutline: Boolean): Wrapper.Builder
Link copied to clipboard
open fun componentTag(@Nullable componentTag: Any?): Wrapper.Builder
Link copied to clipboard
open fun contentDescription(@Nullable contentDescription: CharSequence?): Wrapper.Builder
open fun contentDescription(@StringRes stringId: Int, vararg formatArgs: Any): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun duplicateChildrenStates(duplicateChildrenStates: Boolean): Wrapper.Builder

If true, component applies all of its children's drawable states (focused, pressed, etc.) to itself.

Link copied to clipboard
open fun duplicateParentState(duplicateParentState: Boolean): Wrapper.Builder

If true, component duplicates its drawable state (focused, pressed, etc.) from the direct parent.

Link copied to clipboard
open fun enabled(isEnabled: Boolean): Wrapper.Builder
Link copied to clipboard
open fun flex(flex: Float): Wrapper.Builder

Sets flexGrow, flexShrink, and flexBasis at the same time.

Link copied to clipboard
open fun flexBasisDip(@Dimension(unit = 0) flexBasis: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun flexBasisPx(@Px flexBasis: Int): Wrapper.Builder

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.

Link copied to clipboard
open fun flexGrow(flexGrow: Float): Wrapper.Builder

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.

Link copied to clipboard
open fun flexShrink(flexShrink: Float): Wrapper.Builder

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.

Link copied to clipboard
open fun focusable(isFocusable: Boolean): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun focusedHandler(@Nullable focusedHandler: EventHandler<FocusedVisibleEvent>?): Wrapper.Builder
Link copied to clipboard
open fun foreground(@Nullable foreground: Drawable?): Wrapper.Builder

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.

Link copied to clipboard
open fun foregroundAttr(@AttrRes resId: Int, @DrawableRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun fullImpressionHandler(@Nullable fullImpressionHandler: EventHandler<FullImpressionVisibleEvent>?): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open override fun getThis(): Wrapper.Builder
Link copied to clipboard
open fun handle(@Nullable handle: Handle?): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun heightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun heightDip(@Dimension(unit = 0) height: Float): Wrapper.Builder
Link copied to clipboard
open fun heightPercent(percent: Float): Wrapper.Builder

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.

Link copied to clipboard
open fun heightPx(@Px height: Int): Wrapper.Builder

Specifies the height of the element's content area. See https://www.yogalayout.dev/docs/styling/width-height for more information

Link copied to clipboard
Link copied to clipboard
open fun importantForAccessibility(importantForAccessibility: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun invisibleHandler(@Nullable invisibleHandler: EventHandler<InvisibleEvent>?): Wrapper.Builder
Link copied to clipboard
open fun isReferenceBaseline(isReferenceBaseline: Boolean): Wrapper.Builder
Link copied to clipboard
open fun key(@Nullable key: String?): Wrapper.Builder

Set a key on the component that is local to its parent.

Link copied to clipboard
open fun keyboardNavigationCluster(isKeyboardNavigationCluster: Boolean): Wrapper.Builder
Link copied to clipboard

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.

Link copied to clipboard
open fun layerType(type: Int, @Nullable paint: Paint?): Wrapper.Builder
Link copied to clipboard
open fun layoutDirection(direction: YogaDirection): Wrapper.Builder

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.

Link copied to clipboard
Link copied to clipboard
open fun marginAttr(edge: YogaEdge, @AttrRes resId: Int): Wrapper.Builder
open fun marginAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun marginAuto(edge: YogaEdge): Wrapper.Builder
Link copied to clipboard
open fun marginDip(edge: YogaEdge, @Dimension(unit = 0) margin: Float): Wrapper.Builder
Link copied to clipboard
open fun marginPercent(edge: YogaEdge, percent: Float): Wrapper.Builder
Link copied to clipboard
open fun marginPx(edge: YogaEdge, @Px margin: Int): Wrapper.Builder

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

Link copied to clipboard
open fun marginRes(edge: YogaEdge, @DimenRes resId: Int): Wrapper.Builder
Link copied to clipboard
open fun maxHeightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun maxHeightDip(@Dimension(unit = 0) maxHeight: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun maxHeightPx(@Px maxHeight: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun maxWidthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun maxWidthDip(@Dimension(unit = 0) maxWidth: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun maxWidthPx(@Px maxWidth: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun minHeightAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun minHeightDip(@Dimension(unit = 0) minHeight: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun minHeightPx(@Px minHeight: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun minWidthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun minWidthDip(@Dimension(unit = 0) minWidth: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun minWidthPx(@Px minWidth: Int): Wrapper.Builder

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun paddingAttr(edge: YogaEdge, @AttrRes resId: Int): Wrapper.Builder
open fun paddingAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun paddingDip(edge: YogaEdge, @Dimension(unit = 0) padding: Float): Wrapper.Builder
Link copied to clipboard
open fun paddingPercent(edge: YogaEdge, percent: Float): Wrapper.Builder
Link copied to clipboard
open fun paddingPx(edge: YogaEdge, @Px padding: Int): Wrapper.Builder

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

Link copied to clipboard
open fun paddingRes(edge: YogaEdge, @DimenRes resId: Int): Wrapper.Builder
Link copied to clipboard
open fun positionAttr(edge: YogaEdge, @AttrRes resId: Int): Wrapper.Builder
open fun positionAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun positionDip(edge: YogaEdge, @Dimension(unit = 0) position: Float): Wrapper.Builder
Link copied to clipboard
open fun positionPercent(edge: YogaEdge, percent: Float): Wrapper.Builder
Link copied to clipboard
open fun positionPx(edge: YogaEdge, @Px position: Int): Wrapper.Builder

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.

Link copied to clipboard
open fun positionRes(edge: YogaEdge, @DimenRes resId: Int): Wrapper.Builder
Link copied to clipboard
open fun positionType(positionType: YogaPositionType): Wrapper.Builder

Controls how this component will be positioned within its parent. See https://www.yogalayout.dev/docs/styling/position for more details.

Link copied to clipboard

Links a DynamicValue object to the rotation value for this Component

open fun rotation(rotation: Float): Wrapper.Builder

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.

Link copied to clipboard

Links a DynamicValue object to the rotationX value for this Component

open fun rotationX(rotationX: Float): Wrapper.Builder

Sets the degree that this component is rotated around the horizontal axis through the pivot point.

Link copied to clipboard

Links a DynamicValue object to the rotationY value for this Component

open fun rotationY(rotationY: Float): Wrapper.Builder

Sets the degree that this component is rotated around the vertical axis through the pivot point.

Link copied to clipboard
open fun scale(scale: Float): Wrapper.Builder

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.

Link copied to clipboard

Links a DynamicValue object to the scaleX value for this Component

Link copied to clipboard

Links a DynamicValue object to the scaleY value for this Component

Link copied to clipboard
Link copied to clipboard
open fun selected(isSelected: Boolean): Wrapper.Builder
Link copied to clipboard

Links a DynamicValue object to the elevation value for this Component

Link copied to clipboard
Link copied to clipboard
open fun shadowElevationDip(@Dimension(unit = 0) shadowElevation: Float): Wrapper.Builder
Link copied to clipboard
open fun shadowElevationPx(shadowElevation: Float): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
open fun testKey(@Nullable testKey: String?): Wrapper.Builder
Link copied to clipboard
open fun tooltipText(@Nullable tooltipText: String?): Wrapper.Builder
Link copied to clipboard
open fun touchExpansionAttr(edge: YogaEdge, @AttrRes resId: Int): Wrapper.Builder
open fun touchExpansionAttr(edge: YogaEdge, @AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun touchExpansionDip(edge: YogaEdge, @Dimension(unit = 0) touchExpansion: Float): Wrapper.Builder
Link copied to clipboard
open fun touchExpansionPx(edge: YogaEdge, @Px touchExpansion: Int): Wrapper.Builder
Link copied to clipboard
open fun touchExpansionRes(edge: YogaEdge, @DimenRes resId: Int): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun transitionKeyType(type: Transition.TransitionKeyType): Wrapper.Builder
Link copied to clipboard
open fun transitionName(@Nullable transitionName: String?): Wrapper.Builder
Link copied to clipboard

Links a DynamicValue object to the translationX value for this Component

Link copied to clipboard

Links a DynamicValue object to the translationY value for this Component

Link copied to clipboard

Links a DynamicValue object to the translationZ value for this Component

Link copied to clipboard
open fun unfocusedHandler(@Nullable unfocusedHandler: EventHandler<UnfocusedVisibleEvent>?): Wrapper.Builder
Link copied to clipboard
open fun useHeightAsBaseline(useHeightAsBaseline: Boolean): Wrapper.Builder

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)

Link copied to clipboard
open fun viewId(id: Int): Wrapper.Builder
Link copied to clipboard
open fun viewTag(@Nullable viewTag: Any?): Wrapper.Builder
Link copied to clipboard
Link copied to clipboard
open fun visibilityChangedHandler(@Nullable visibilityChangedHandler: EventHandler<VisibilityChangedEvent>?): Wrapper.Builder
Link copied to clipboard
open fun visibilityOutputTag(@Nullable visibilityOutputTag: String?): Wrapper.Builder
Link copied to clipboard
open fun visibleHandler(@Nullable visibleHandler: EventHandler<VisibleEvent>?): Wrapper.Builder
Link copied to clipboard
open fun visibleHeightRatio(visibleHeightRatio: Float): Wrapper.Builder
Link copied to clipboard
open fun visibleWidthRatio(visibleWidthRatio: Float): Wrapper.Builder
Link copied to clipboard
open fun widthAttr(@AttrRes resId: Int): Wrapper.Builder
open fun widthAttr(@AttrRes resId: Int, @DimenRes defaultResId: Int): Wrapper.Builder
Link copied to clipboard
open fun widthDip(@Dimension(unit = 0) width: Float): Wrapper.Builder
Link copied to clipboard
open fun widthPercent(percent: Float): Wrapper.Builder

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.

Link copied to clipboard
open fun widthPx(@Px width: Int): Wrapper.Builder

Specifies the width of the element's content area. See https://www.yogalayout.dev/docs/styling/width-height for more information

Link copied to clipboard
open fun widthRes(@DimenRes resId: Int): Wrapper.Builder
Link copied to clipboard