litho-core/com.facebook.litho/FlexboxContainerScope

FlexboxContainerScope

class FlexboxContainerScope(val context: ComponentContext, children: MutableList<Component> = mutableListOf()) : ResourcesScope

The implicit receiver for the trailing lambda on ResourcesScope.Column or ResourcesScope.Row. The receiver gives the ability to add children to this container.

Constructors

constructor(context: ComponentContext, children: MutableList<Component> = mutableListOf())

Properties

androidContext

open override val androidContext: Context

context

open override val context: ComponentContext

resourceResolver

open override val resourceResolver: ResourceResolver

value

open val <T> TreeProp<T>.value: T

Functions

child

fun child(component: Component?)

Adds a Component as a child to the Row or Column being initialized.

Column

inline fun ResourcesScope.Column(alignContent: YogaAlign? = null, alignItems: YogaAlign? = null, justifyContent: YogaJustify? = null, wrap: YogaWrap? = null, isReversed: Boolean = false, style: Style? = null): Column

Constructs a new Column without any children.

Constructs a new Column. Add children by using FlexboxContainerScope.child or FlexboxContainerScope.children:

createColumn

fun ResourcesScope.createColumn(alignContent: YogaAlign? = null, alignItems: YogaAlign? = null, justifyContent: YogaJustify? = null, wrap: YogaWrap? = null, isReversed: Boolean = false, style: Style? = null, resolvedContainerScope: FlexboxContainerScope?): Column

Internal function to allow Column to be inlineable.

createRow

fun ResourcesScope.createRow(alignContent: YogaAlign? = null, alignItems: YogaAlign? = null, justifyContent: YogaJustify? = null, wrap: YogaWrap? = null, isReversed: Boolean = false, style: Style? = null, resolvedContainerScope: FlexboxContainerScope?): Row

Internal function to allow Row to be inlineable.

drawableColor

fun BaseResourcesScope.drawableColor(@ColorInt color: Int): Drawable

fun BaseResourcesScope.drawableColor(@ColorInt color: Long): Drawable

Return a android.graphics.drawable.Drawable for a ColorInt value as a Drawable instance.

getIntAttrValue

open fun getIntAttrValue(componentContext: ComponentContext, @StyleableRes id: Int, @StyleableRes attrs: IntArray, defaultValue: Int): Int

Retrieves a styled attribute value for provided {@param id}.

getTreeProp

inline fun <T : Any> ResourcesScope.getTreeProp(): T?

Returns the instance registered for the type T in this hierarchy, and null if no value was registered. Tree props are registered for a sub-hierarchy via TreePropProvider or com.facebook.litho.annotations.OnCreateTreeProp in the Spec API.

requireTreeProp

inline fun <T : Any> ResourcesScope.requireTreeProp(): T

Returns the instance registered for the type T in this hierarchy, throws if no value was registered. Tree props are registered for a sub-hierarchy via TreePropProvider or com.facebook.litho.annotations.OnCreateTreeProp in the Spec API.

Row

inline fun ResourcesScope.Row(alignContent: YogaAlign? = null, alignItems: YogaAlign? = null, justifyContent: YogaJustify? = null, wrap: YogaWrap? = null, isReversed: Boolean = false, style: Style? = null): Row

Constructs a new Column without any children.

Constructs a new Row. Add children by using FlexboxContainerScope.child or FlexboxContainerScope.children:

toPixels

open fun Dimen.toPixels(): Int

Wrapper

inline fun ResourcesScope.Wrapper(style: Style, content: ResourcesScope.() -> Component): Wrapper

Builder function for creating Wrapper components. It's useful for adding additional Style props to a given component.