Background, border, clip · Shapes
The same shape clips the background and draws the border.
Open the live, interactive demo →
Change its controls, read the remote document it produces and the diff after every change.
What it is
Fills an element with colour or an image, gives it an outline, and rounds or reshapes its corners.
Good for
- Cards and chips
- Circular avatars
- Pill-shaped buttons
Code
The story's source with androidx.compose.remote imports. CI compiles every snippet on this site against AndroidX.
import androidx.compose.remote.creation.compose.layout.RemoteAlignment
import androidx.compose.remote.creation.compose.layout.RemoteBox
import androidx.compose.remote.creation.compose.layout.RemoteComposable
import androidx.compose.remote.creation.compose.layout.RemoteText
import androidx.compose.remote.creation.compose.modifier.RemoteModifier
import androidx.compose.remote.creation.compose.modifier.background
import androidx.compose.remote.creation.compose.modifier.border
import androidx.compose.remote.creation.compose.modifier.clip
import androidx.compose.remote.creation.compose.modifier.size
import androidx.compose.remote.creation.compose.shapes.RemoteShape
import androidx.compose.remote.creation.compose.state.rc
import androidx.compose.remote.creation.compose.state.rdp
import androidx.compose.remote.creation.compose.state.rs
import androidx.compose.runtime.Composable
import androidx.compose.ui.graphics.Color
@Composable
@RemoteComposable
fun BackgroundBorderClip(shape: RemoteShape, borderWidth: Int, borderColor: Color, fill: Color) {
RemoteBox(
RemoteModifier.size(180.rdp, 120.rdp)
.border(borderWidth.rdp, borderColor.rc, shape)
.clip(shape)
.background(fill.rc),
contentAlignment = RemoteAlignment.Center,
) {
RemoteText("clip + border".rs)
}
}
API
creation.compose.modifier.background
RemoteModifier background(RemoteModifier, RemotePainter painter)
RemoteModifier background(RemoteModifier, RemoteColor color)creation.compose.modifier.border
RemoteModifier border(RemoteModifier, RemoteDp width, RemoteColor color, optional RemoteShape shape)creation.compose.modifier.clip
RemoteModifier clip(RemoteModifier, optional RemoteShape shape)creation.compose.shapes.RemoteRoundedCornerShape
class RemoteRoundedCornerShape extends RemoteCornerBasedShape
RemoteRoundedCornerShape(RemoteCornerSize topStart, RemoteCornerSize topEnd, RemoteCornerSize bottomEnd, RemoteCornerSize bottomStart)
RemoteCornerBasedShape copy(optional RemoteCornerSize topStart, optional RemoteCornerSize topEnd, optional RemoteCornerSize bottomEnd, optional RemoteCornerSize bottomStart)
RemoteOutline createOutline(RemoteFloat topStart, RemoteFloat topEnd, RemoteFloat bottomEnd, RemoteFloat bottomStart, optional RemoteSize? size, optional RemoteOffset offset)
RemoteRoundedCornerShape RemoteRoundedCornerShape(RemoteCornerSize corner)
RemoteRoundedCornerShape RemoteRoundedCornerShape(RemoteDp size)
RemoteRoundedCornerShape RemoteRoundedCornerShape(optional RemoteDp topStart, optional RemoteDp topEnd, optional RemoteDp bottomEnd, optional RemoteDp bottomStart)
RemoteRoundedCornerShape RemoteRoundedCornerShape(RemoteFloat size)
RemoteRoundedCornerShape RemoteRoundedCornerShape(optional RemoteFloat topStart, optional RemoteFloat topEnd, optional RemoteFloat bottomEnd, optional RemoteFloat bottomStart)
RemoteRoundedCornerShape RemoteRoundedCornerShape(int percent)
RemoteRoundedCornerShape RemoteRoundedCornerShape(optional int topStartPercent, optional int topEndPercent, optional int bottomEndPercent, optional int bottomStartPercent)creation.compose.shapes.RemoteCornerSize
interface RemoteCornerSize
RemoteFloat toPx(RemoteSize shapeSize, RemoteDensity density)
RemoteCornerSize RemoteCornerSize(RemoteDp size)
RemoteCornerSize RemoteCornerSize(RemoteFloat size)
RemoteCornerSize RemoteCornerSize(int percent)creation.compose.painter.painterRemoteColor
RemotePainter painterRemoteColor(RemoteColor color)