Box.kt
/*
* Copyright 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.glance.layout
import androidx.annotation.RestrictTo
import androidx.compose.runtime.Composable
import androidx.glance.EmittableWithChildren
import androidx.glance.GlanceModifier
import androidx.glance.GlanceNode
import androidx.glance.unit.Dimension
/** @suppress */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class EmittableBox : EmittableWithChildren() {
override var modifier: GlanceModifier = GlanceModifier
public var contentAlignment: Alignment = Alignment.TopStart
override fun toString(): String {
return "EmittableBox(modifier=$modifier, contentAlignment=$contentAlignment)"
}
}
/**
* A layout composable with [content].
*
* By default, the [Box] will size itself to fit the content, unless a [Dimension] constraint has
* been provided. When the children are smaller than the [Box], they will be placed within the box
* subject to the [contentAlignment]. When the [content] has more than one layout child, all of
* the children will be stacked on top of each other in the composition order.
*
* @param modifier The modifier to be applied to the layout.
* @param contentAlignment The alignment of children within the [Box].
* @param content The content inside the [Box].
*/
@Composable
public fun Box(
modifier: GlanceModifier = GlanceModifier,
contentAlignment: Alignment = Alignment.TopStart,
content: @Composable () -> Unit
) {
GlanceNode(
factory = ::EmittableBox,
update = {
this.set(modifier) { this.modifier = it }
this.set(contentAlignment) { this.contentAlignment = it }
},
content = content
)
}