spark/com.adevinta.spark.components.surface

Package-level declarations

Types

Link copied to clipboard
@Stable
fun interface ElevationOverlay

An ElevationOverlay is an overlay applied to the background color of Surface components, used to emphasize elevation in dark theme, where shadows are not as visible. An ElevationOverlay does not replace the shadows drawn by a Surface, but is used as an additional representation of elevation.

Properties

Link copied to clipboard
val LocalElevationOverlay: ProvidableCompositionLocal<ElevationOverlay?>

CompositionLocal containing the ElevationOverlay used by Surface components. Provide null to turn off ElevationOverlays for the children within this CompositionLocal..

Functions

Link copied to clipboard
@Composable
fun Surface(modifier: Modifier = Modifier, shape: Shape = SparkTheme.shapes.none, color: Color = SparkTheme.colors.surface, contentColor: Color = contentColorFor(color), elevation: Dp = 0.dp, border: BorderStroke? = null, content: @Composable () -> Unit)
@Composable
fun Surface(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = SparkTheme.shapes.none, color: Color = SparkTheme.colors.surface, contentColor: Color = contentColorFor(color), elevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource? = null, content: @Composable () -> Unit)
@Composable
fun Surface(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = SparkTheme.shapes.none, color: Color = SparkTheme.colors.surface, contentColor: Color = contentColorFor(color), elevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource? = null, content: @Composable () -> Unit)
@Composable
fun Surface(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = SparkTheme.shapes.none, color: Color = SparkTheme.colors.surface, contentColor: Color = contentColorFor(color), elevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource? = null, content: @Composable () -> Unit)

Material surface is the central metaphor in material design. Each surface exists at a given elevation, which influences how that piece of surface visually relates to other surfaces and how that surface is modified by tonal variance.