compose/pro.respawn.kmmutils.compose

Package-level declarations

Types

FractionalOffset

typealias FractionalOffset = Offset

Offset expressed as a fraction of the size of the widget.

Properties

val Offset.inverted: Offset

Inverts the X and Y coordinates of a given offset

val Offset.invertedX: Offset

Inverts the X coordinate of a given offset

val Offset.invertedY: Offset

Inverts the Y coordinate of a given offset

var GraphicsLayerScope.scale: Float

Scale the element uniformly. Alias for GraphicsLayerScope.scaleX and GraphicsLayerScope.scaleY. Getter returns the average value of the scale

@get:ChecksSdkIntAtLeast(api = 31)

val supportsBlur: Boolean

supportsDynamicColors

@get:ChecksSdkIntAtLeast(api = 31)

val supportsDynamicColors: Boolean

supportsShaders

@get:ChecksSdkIntAtLeast(api = 33)

val supportsShaders: Boolean

VectorConverter

val TextUnit.Companion.VectorConverter: TwoWayConverter<TextUnit, AnimationVector1D>

A vector converter that converts this TextUnit value to a Float to allow you to animate it.

val Long.Companion.VectorConverter: TwoWayConverter<Long, AnimationVector1D>

A vector converter that converts this Long value to a Float to allow you to animate it.

Functions

fun String.annotate(): AnnotatedString

Produces an annotated string identical to the original string For those times when an api requires AnnotatedString but you don't want to build one

fun String.annotate(spanStyle: SpanStyle): AnnotatedString

Annotates this string with the spanStyle provided. The whole string is annotated.

inline fun String.annotate(builder: AnnotatedString.Builder.(String) -> Unit): AnnotatedString

Annotates this string using the builder provided. The string is the argument of the lambda.

fun FractionalOffset.asAbsolute(size: Size): Offset

Converts fractional offset to absolute offset

fun Offset.asFractional(size: Size): FractionalOffset

Converts absolute offset to fractional offset

fun Modifier.autofill(autofillType: AutofillType, vararg autofillTypes: AutofillType, onFill: (String) -> Unit): Modifier

Mark this element as autofillable.

fun String.background(color: Color): AnnotatedString

Sets the background color to this string

fun String.bold(): AnnotatedString

Applies FontWeight.Bold to this string

bringIntoViewOnFocus

fun Modifier.bringIntoViewOnFocus(): Modifier

Scrolls to this widget when an element is focused (i.e. user taps the input field). Use on text input fields to keep them visible while editing.

fun String.color(color: Color): AnnotatedString

Sets the foreground color of this string

fun String.decorate(vararg decorations: TextDecoration): AnnotatedString

Adds text decorations provided to this string

fun KeyboardActions.Companion.default(onProceed: KeyboardActionScope.() -> Unit? = null): KeyboardActions

DisallowOverlays

@RequiresPermission(value = "android.permission.HIDE_OVERLAY_WINDOWS")

fun DisallowOverlays()

Disables overlays over the content of current activity for as long as this composable is in the composition Works only on API 31 (S) and above, otherwise does nothing.

fun Context.findActivity(): Activity?

Traverses the context hierarchy until an activity is found, or null if not present.

fun String.font(fontFamily: FontFamily): AnnotatedString

Changes the fontFamily of this string

fun String.italic(): AnnotatedString

Applies FontStyle.Italic to this string

actual fun KeepScreenOn(enabled: Boolean)

Keeps the screen of the current activity on while this composable is in composition.

expect fun KeepScreenOn(enabled: Boolean = true)

Keeps the device screen on while the current composable is in the composition.

actual fun KeepScreenOn(enabled: Boolean)

Keeps the device screen on while the current composable is in the composition.

actual fun KeepScreenOn(enabled: Boolean)

Keeps the device screen on while the current composable is in the composition.

actual fun KeepScreenOn(enabled: Boolean)

Keeps the device screen on while the current composable is in the composition.

actual fun KeepScreenOn(enabled: Boolean)

Keeps the device screen on while the current composable is in the composition.

LockScreenOrientation

fun LockScreenOrientation(orientation: Int)

Possible values for orientation:

fun HapticFeedback.medium()

Plays a medium haptic feedback, similar to force-touch or long-tap effect.

ObserveLifecycle

fun ObserveLifecycle(onEvent: (event: Lifecycle.Event) -> Unit)

Registers a new lifecycle observer for the lifetime of the composition of this function, then clears it.

fun GraphicsLayerScope.offset(offset: Offset)

Applies an offset to this GraphicsLayerScope

rememberBoundLocalService

inline fun <BoundService : Service, BoundServiceBinder : Binder> rememberBoundLocalService(flags: Int = Context.BIND_AUTO_CREATE, noinline getService: @DisallowComposableCalls BoundServiceBinder.() -> BoundService): State<BoundService?>

Remembers a reference to a Service's Binder in composition. The function will bind to a service while it is in the composition and unbind when it has left the composition. The function will maintain a ServiceConnection and return a State with a nullable value of service.

rememberRetainedValue

fun <T> rememberRetainedValue(key: String? = null, viewModelStoreOwner: ViewModelStoreOwner = checkNotNull(LocalViewModelStoreOwner.current) { "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner" }, onDispose: T.() -> Unit? = null, calculation: () -> T): T

Remember the value produced by calculation. It behaves similarly to rememberSaveable, but uses ViewModel to store the value.

fun SetWindowFlags(flags: Int)

Sets flags to the parent activity, if exists, temporarily, until the composition is left. The flags are added and then removed, other flags are not changed Possible values of flags are from WindowManager.LayoutParams

fun String.shadow(color: Color, offset: Offset = Offset.Zero, blurRadius: Float = 0.0f): AnnotatedString

Adds a shadow to this string. The shadow has a color, an offset and a blurRadius

inline fun ManagedActivityResultLauncher<Intent, ActivityResult>.shareAsText(text: String, onAppNotFound: (Exception) -> Unit)

A shortcut for sending messages to any social media app installed in the user's device. This will optionally return an activity result as it's why an extension for ManagedActivityResultLauncher.

fun HapticFeedback.short()

Plays a short haptic feedback, similar to a software keyboard typing vibration.

fun String.size(size: TextUnit): AnnotatedString

Applies absolute size to the text

slideFromBottom

fun slideFromBottom(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Returns an enter transition that slides the element from the bottom fully

fun slideFromLeft(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Returns an enter transition that slides the element from the left fully

fun slideFromRight(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Returns an enter transition that slides the element from the right fully

fun slideFromTop(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Returns an enter transition that slides the element from the top fully

slideInHorizontally

fun slideInHorizontally(widthOffsetFraction: Float, spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

A positive value means sliding from right to left, whereas a negative value would slide the content from left to right.

slideInVertically

fun slideInVertically(itemHeightOffsetFraction: Float, spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Positive itemHeightOffsetFraction means the item is moving up.

slideOutHorizontally

fun slideOutHorizontally(widthOffsetFraction: Float, spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): ExitTransition

A positive value means sliding to the right, whereas a negative value would slide the content towards the left.

slideOutVertically

fun slideOutVertically(itemHeightOffsetFraction: Float, spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): ExitTransition

Positive itemHeightOffsetFraction means the item is moving down.

fun slideToBottom(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): ExitTransition

Returns an exit transition that slides the element to the bottom fully

fun slideToLeft(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): ExitTransition

Returns an exit transition that slides the element to the left fully

fun slideToRight(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): EnterTransition

Returns an exit transition that slides the element to the right fully

fun slideToTop(spec: FiniteAnimationSpec<IntOffset> = DefaultSpec): ExitTransition

Returns an exit transition that slides the element to the top fully

fun String.strike(): AnnotatedString

Strikes through this string

fun String.style(style: FontStyle): AnnotatedString

Applies a style to this string

inline fun <T : Any> TypeCrossfade(state: T, modifier: Modifier = Modifier, fill: Boolean = true, alignment: Alignment = Alignment.Center, animationSpec: FiniteAnimationSpec<Float> = tween(), crossinline content: @Composable T.() -> Unit)

TypeCrossfade is a Crossfade variation that runs a fade-through animation when the type of the state changes. It will not run the animation when the object itself changes.

fun String.underline(): AnnotatedString

Adds an underline to this string

fun String.weight(weight: FontWeight): AnnotatedString

Sets the font weight for this string