A CornerBasedShape that draws a rectangle with smoothly rounded corners. The smoothing is controlled by the smoothing parameter, which affects how the corners transition from straight edges to curves, often referred to as "squircles".

WindowSize

data class WindowSize(val width: Int, val height: Int)

Window size data class.

Properties

DefaultSmoothing

const val DefaultSmoothing: Float = 0.6f

Default smoothing value for SmoothRoundedCornerShape. A value of 0.6 is often used to achieve a "squircle" or "superellipse" like appearance.

LocalOverScrollState

val LocalOverScrollState: ProvidableCompositionLocal<OverScrollState>

LocalOverScrollState is used to provide the OverScrollState instance to the composition.

Functions

BackHandler

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

@Composable

expect fun BackHandler(enabled: Boolean, onBack: () -> Unit)

Handles the back event.

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

@Composable

actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)

getCornerRadiusBottom

@Composable

fun getCornerRadiusBottom(): Int

getRoundedCorner

@Composable

actual fun getRoundedCorner(): Dp

@Composable

expect fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

@Composable

actual fun getRoundedCorner(): Dp

@Composable

actual fun getRoundedCorner(): Dp

@Composable

actual fun getRoundedCorner(): Dp

@Composable

actual fun getRoundedCorner(): Dp

@Composable

actual fun getRoundedCorner(): Dp

getWindowSize

@Composable

actual fun getWindowSize(): WindowSize

@Composable

expect fun getWindowSize(): WindowSize

Returns the current window size.

@Composable

actual fun getWindowSize(): WindowSize

@Composable

actual fun getWindowSize(): WindowSize

@Composable

actual fun getWindowSize(): WindowSize

@Composable

actual fun getWindowSize(): WindowSize

@Composable

actual fun getWindowSize(): WindowSize

overScrollHorizontal

@Stable

fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> Float? = null, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

overScrollOutOfBound

@Stable

fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> Float?, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

OverScroll effect for scrollable Composable.

overScrollVertical

@Stable

fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> Float? = null, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

parabolaScrollEasing

@Stable

fun parabolaScrollEasing(currentOffset: Float, newOffset: Float, p: Float = 50.0f, density: Float): Float

A parabolic rolling easing curve.

platform

actual fun platform(): Platform

expect fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

pressSink

fun Modifier.pressSink(interactionSource: MutableInteractionSource, sinkAmount: Float = SinkAmount, dampingRatio: Float = DampingRatio, stiffness: Float = Stiffness): Modifier

Applies a "sink" visual feedback when the component is pressed, by scaling the component down smoothly using animation.

pressTilt

fun Modifier.pressTilt(interactionSource: MutableInteractionSource, tiltAmount: Float = TiltAmount, dampingRatio: Float = DampingRatio, stiffness: Float = Stiffness): Modifier

Applies a "tilt" effect based on the position where the user pressed the component. The tilt direction is determined by touch offset, giving the effect that one corner "sinks" while the other "static".

scrollEndHaptic

fun Modifier.scrollEndHaptic(hapticFeedbackType: HapticFeedbackType = HapticFeedbackType.TextHandleMove): Modifier

Applies a haptic feedback effect when a scrollable container is flung to its boundaries.

SmoothRoundedCornerShape

fun SmoothRoundedCornerShape(corner: Dp, smoothing: Float = DefaultSmoothing): SmoothRoundedCornerShape

Creates a SmoothRoundedCornerShape with all corners having the same size and smoothing.

smoothRoundedRectangle

fun Path.Companion.smoothRoundedRectangle(smoothing: Float, size: Size, topLeft: Float, topRight: Float, bottomLeft: Float, bottomRight: Float): Path

Creates a Path for a rectangle with smoothly rounded corners.

toComposePath

fun RoundedPolygon.toComposePath(path: Path = Path()): Path

Converts a RoundedPolygon from the AndroidX graphics shapes library to a Jetpack Compose Path.