composeextensions/sco.carlukesoftware.composeextensions

Package-level declarations

Types

AccessibilityPreviews

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION])

@Preview(name = "Font Scale 100%", group = "Accessibility", fontScale = 1.0, showBackground = true)

@Preview(name = "Font Scale 150%", group = "Accessibility", fontScale = 1.5, showBackground = true)

@Preview(name = "Font Scale 200%", group = "Accessibility", fontScale = 2.0, showBackground = true)

annotation class AccessibilityPreviews

AllPreviews

annotation class AllPreviews

Composite MultiPreview combining device form factors, themes, and accessibility options.

DevicePreviews

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION])

@Preview(name = "Phone - Small", group = "Devices", device = "id:Nexus 5", showBackground = true)

@Preview(name = "Phone - Standard", group = "Devices", device = "id:pixel_7", showBackground = true)

@Preview(name = "Tablet - Portrait", group = "Devices", device = "spec:width=1280dp,height=800dp,dpi=240", showBackground = true)

@Preview(name = "Tablet - Landscape", group = "Devices", device = "spec:width=1280dp,height=800dp,orientation=landscape", showBackground = true)

annotation class DevicePreviews

MultiPreviews

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION])

@Preview(name = "Small Phone", group = "Devices", device = "id:Nexus 5", showBackground = true)

@Preview(name = "Standard Phone", group = "Devices", device = "id:pixel_7", showBackground = true)

@Preview(name = "Tablet Portrait", group = "Devices", device = "spec:width=1280dp,height=800dp,dpi=240", showBackground = true)

@Preview(name = "Tablet Landscape", group = "Devices", device = "spec:width=1280dp,height=800dp,orientation=landscape", showBackground = true)

@Preview(name = "Dark Mode", group = "Themes", device = "id:pixel_7", uiMode = 32, showBackground = true)

@Preview(name = "Large Font (150%)", group = "Accessibility", device = "id:pixel_7", fontScale = 1.5, showBackground = true)

@Preview(name = "RTL Layout", group = "Locales", device = "id:pixel_7", locale = "ar", showBackground = true)

annotation class MultiPreviews

MultiPreview annotation representing common device sizes, orientations, and configurations.

ThemePreviews

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION])

@Preview(name = "Light Mode", group = "Themes", uiMode = 16, showBackground = true)

@Preview(name = "Dark Mode", group = "Themes", uiMode = 32, showBackground = true)

annotation class ThemePreviews

UiState

@Immutable

sealed interface UiState<out T>

A generic sealed interface representing the different states of an asynchronous operation or data loading process. Annotated with @Immutable for Jetpack Compose stability and optimal recomposition behavior.

Properties

creationExtras

val Application.creationExtras: CreationExtras

Provides a CreationExtras instance with the Application instance.

val Context.creationExtras: CreationExtras

Provides CreationExtras from a Context.

Functions

detectTapWithOrigin

fun Modifier.detectTapWithOrigin(onTap: (TransformOrigin) -> Unit): Modifier

Detects tap gestures and passes the click origin relative to the element's width and height.

exceptionOrNull

fun <T> UiState<T>.exceptionOrNull(): Throwable?

Returns the encapsulated throwable if this state is UiState.Failure, or null otherwise.

fadeOut

fun Modifier.fadeOut(initialColor: Color = Color.Transparent, fadeToColor: Color = Color.White, verticalFade: Boolean = true): Modifier

Applies a linear gradient fade overlay across the content.

findActivity

fun Context.findActivity(): Activity?

Traverses the ContextWrapper chain to find the underlying Activity.

findActivityOf

inline fun <T : Activity> Context.findActivityOf(): T?

Traverses the ContextWrapper chain to find a specific subtype of Activity.

findApplication

fun Context.findApplication(): Application?

Attempts to find the Application instance associated with this Context.

flatMap

inline fun <T, R> UiState<T>.flatMap(transform: (T) -> UiState<R>): UiState<R>

Transforms the UiState.Success data using the given transform function that returns a new UiState.

fold

inline fun <T, R> UiState<T>.fold(onSuccess: (data: T) -> R, onFailure: (throwable: Throwable) -> R, onLoading: () -> R, onIdle: () -> R): R

Applies onSuccess if state is UiState.Success, onFailure if UiState.Failure, onLoading if UiState.Loading, or onIdle if UiState.Idle.

getOrDefault

fun <T> UiState<T>.getOrDefault(default: T): T

Returns the encapsulated data if this state is UiState.Success, or default otherwise.

getOrElse

inline fun <T> UiState<T>.getOrElse(onFailure: (throwable: Throwable?) -> T): T

Returns the encapsulated data if this state is UiState.Success, or the result of onFailure function for non-success states.

getOrNull

fun <T> UiState<T>.getOrNull(): T?

Returns the encapsulated data if this state is UiState.Success, or null otherwise.

getOrThrow

fun <T> UiState<T>.getOrThrow(): T

Returns the encapsulated data if this state is UiState.Success, or throws the encapsulated Throwable if this state is UiState.Failure, or an IllegalStateException if UiState.Idle or UiState.Loading.

glow

fun Modifier.glow(glowingColor: Color, containerColor: Color = Color.White, cornerRadius: Dp = 0.dp, glowingRadius: Dp = 20.dp, glowAlpha: Float = 0.8f, offsetX: Dp = 0.dp, offsetY: Dp = 0.dp): Modifier

Applies a glowing shadow effect around the composable surface.

iif

inline fun Modifier.iif(condition: Boolean, then: Modifier.() -> Modifier): Modifier

Alias for thenIf. Applies the given then modifier builder if condition is true.

ImeScrollBox

@Composable

fun ImeScrollBox(modifier: Modifier = Modifier, scrollState: ScrollState = rememberScrollState(), verticalArrangement: Arrangement.Vertical = Arrangement.Bottom, horizontalAlignment: Alignment.Horizontal = Alignment.CenterHorizontally, enabled: Boolean = true, content: @Composable ColumnScope.() -> Unit)

A container that automatically adjusts its padding to accommodate the software keyboard (IME) and enables vertical scrolling.

innerShadow

fun Modifier.~~innerShadow~~(shape: Shape, color: Color = Color.Black, blur: Dp = 4.dp, offsetY: Dp = 2.dp, offsetX: Dp = 2.dp, spread: Dp = 0.dp): Modifier

Adds an inner shadow effect inside the content outline.

map

inline fun <T, R> UiState<T>.map(transform: (T) -> R): UiState<R>

Transforms the UiState.Success data using the given transform function. Non-success states (UiState.Idle, UiState.Loading, UiState.Failure) are passed through unchanged.

parallaxLayout

fun Modifier.parallaxLayout(scrollState: ScrollState, rate: Float = 2.0f): Modifier

Creates a parallax scrolling translation effect without re-measuring layout during scroll.

rememberImeState

@Composable

fun rememberImeState(): State<Boolean>

Creates and remembers a state that tracks whether the software keyboard (IME) is currently visible.

requireActivity

fun Context.requireActivity(): Activity

Traverses the ContextWrapper chain to find the underlying Activity.

requireApplication

fun Context.requireApplication(): Application

Gets the Application instance associated with this Context.

shadow

fun Modifier.~~shadow~~(color: Color = Color.Black, offsetX: Dp = 0.dp, offsetY: Dp = 0.dp, blurRadius: Dp = 0.dp): Modifier

Draws a custom drop shadow behind the content using hardware-accelerated/canvas blur.

shimmerEffect

fun Modifier.shimmerEffect(baseColor: Color = Color(0xFFB8B5B5), highlightColor: Color = Color(0xFFE0E0E0), durationMillis: Int = 1000): Modifier

Applies an animated shimmer loading effect across the composable.

showToast

fun Context.showToast(@StringRes msgRes: Int, duration: Int = Toast.LENGTH_SHORT)

Displays a toast message using a string resource ID.

fun Context.showToast(msg: String, duration: Int = Toast.LENGTH_SHORT)

Displays a toast message.

spreadShadow

fun Modifier.spreadShadow(spread: Dp = 8.dp, @FloatRange(from = 0.0, to = 1.0) alpha: Float = 0.25f, color: Color = Color.Gray, radius: Dp = 8.dp): Modifier

Creates a layered spread shadow effect around the composable using repeated border steps.

thenIf

inline fun Modifier.thenIf(condition: Boolean, block: Modifier.() -> Modifier): Modifier

Applies a Modifier if the given condition is true.