State of Compose 2023 results are in! Click here to learn more

← Back to Wear Material

Vignette

Component
in
Wear Material
. Since 1.0.0

Overview

Code Examples

Vignette is whole screen decoration used to blur the top and bottom of the edges of a wearable screen when scrolling content is displayed. The vignette is split between a top and bottom image which can be displayed independently depending on the use case.

The vignette is designed to be used as an overlay, typically in the Scaffold.

Simple example of a Vignette with a ScalingLazyColumn as the main application content where the top/bottom vignette images can be turned on/off can be found at

Overloads

Vignette

@Composable
public fun Vignette(
    vignettePosition: VignettePosition,
    modifier: Modifier = Modifier,
)

Parameters

NameDescription
vignettePositionwhether to draw top and/or bottom images for this Vignette
modifieroptional Modifier for the root of the Vignette