tooling-compose/dev.datlag.tooling.compose

Package-level declarations

Properties

TargetDefault

actual val Dispatchers.TargetDefault: CoroutineDispatcher

expect val Dispatchers.TargetDefault: CoroutineDispatcher

The default dispatcher on the current platform.

actual val Dispatchers.TargetDefault: CoroutineDispatcher

TargetIO

actual val Dispatchers.TargetIO: CoroutineDispatcher

expect val Dispatchers.TargetIO: CoroutineDispatcher

The IO dispatcher on the current platform.

actual val Dispatchers.TargetIO: CoroutineDispatcher

TargetMain

actual val Dispatchers.TargetMain: MainCoroutineDispatcher

expect val Dispatchers.TargetMain: MainCoroutineDispatcher

The main dispatcher on the current platform.

actual val Dispatchers.TargetMain: MainCoroutineDispatcher

Functions

BottomCornerShape

fun BottomCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves bottom start and bottom end corner unchanged, and applies a specified Dp on other corners.

BottomEndCornerShape

fun BottomEndCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves bottom end corner unchanged, and applies a specified Dp on other corners.

BottomStartCornerShape

fun BottomStartCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves bottom start corner unchanged, and applies a specified Dp on other corners.

defaultDispatcher

fun defaultDispatcher(): CoroutineDispatcher

Handy equivalent of Dispatchers.TargetDefault.

EndCornerShape

fun EndCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top end and bottom end corner unchanged, and applies a specified Dp on other corners.

focusScale

@Composable

fun Modifier.focusScale(scale: Float = 1.1f, hoverable: Boolean = true, focusable: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }): Modifier

Extension function for a Modifier to scale a Composable (up) on focus.

getResourcesAsInputStream

fun Tooling.getResourcesAsInputStream(clazz: KClass<*>, location: String): InputStream?

Load something from resources easily.

ifFalse

inline fun Modifier.ifFalse(predicate: Boolean, builder: Modifier.() -> Modifier): Modifier

Extension function to apply changes to a Modifier if a predicate is not matched.

ifTrue

inline fun Modifier.ifTrue(predicate: Boolean, builder: Modifier.() -> Modifier): Modifier

Extension function to apply changes to a Modifier if a predicate is matched.

ioDispatcher

fun ioDispatcher(): CoroutineDispatcher

Handy equivalent of Dispatchers.TargetIO.

isFocused

@Composable

fun Modifier.isFocused(hoverable: Boolean = true, focusable: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, builder: Modifier.() -> Modifier): Modifier

Extension function to apply changes to a Modifier if the Composable is focused.

launchDefault

fun CoroutineScope.launchDefault(block: suspend CoroutineScope.() -> Unit): Job

Handy equivalent of CoroutineScope.launch to launch directly with the defaultDispatcher.

launchIO

fun CoroutineScope.launchIO(block: suspend CoroutineScope.() -> Unit): Job

Handy equivalent of CoroutineScope.launch to launch directly with the ioDispatcher.

launchMain

fun CoroutineScope.launchMain(block: suspend CoroutineScope.() -> Unit): Job

Handy equivalent of CoroutineScope.launch to launch directly with the mainDispatcher.

loadAppIcon

fun Tooling.loadAppIcon(window: ComposeWindow, vararg assets: Image?)

Easy method to load images as app icon on a ComposeWindow.

mainDispatcher

fun mainDispatcher(): MainCoroutineDispatcher

Handy equivalent of Dispatchers.TargetMain.

MiddleCornerShape

fun MiddleCornerShape(baseShape: CornerBasedShape = CircleShape, cornerSize: Dp = 2.dp): CornerBasedShape

Shape which applies a specified Dp on all corners. Useful as middle part for StartCornerShape and EndCornerShape for example.

onClick

actual fun Modifier.onClick(enabled: Boolean, onDoubleClick: () -> Unit?, onLongClick: () -> Unit?, onClick: () -> Unit): Modifier

expect fun Modifier.onClick(enabled: Boolean = true, onDoubleClick: () -> Unit? = null, onLongClick: () -> Unit? = null, onClick: () -> Unit): Modifier

An easy extendable Modifier.onClick method.

actual fun Modifier.onClick(enabled: Boolean, onDoubleClick: () -> Unit?, onLongClick: () -> Unit?, onClick: () -> Unit): Modifier

onFocusChanged

@Composable

fun Modifier.onFocusChanged(hoverable: Boolean = true, focusable: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, onChanged: (Boolean) -> Unit): Modifier

Extension function to get notified if the Composable is focused.

openInBrowser

fun String.openInBrowser(context: Context)

Open a given String in browser.

scaleClick

fun Modifier.scaleClick(minScale: Float = 0.9f): Modifier

Extension function for a Modifier to scale a Composable (down) on click.

StartCornerShape

fun StartCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top start and bottom start corner unchanged, and applies a specified Dp on other corners.

toLegacyColors

fun ColorScheme.toLegacyColors(useDark: Boolean): Colors

Get Material3 ColorScheme as Material Colors. Useful to commonize theming with old and new Composables.

toLegacyShapes

fun Shapes.toLegacyShapes(): Shapes

Get Material3 androidx.compose.material3.Shapes as Material Shapes. Useful to commonize theming with old and new Composables.

toLegacyTypography

@Composable

fun FontFamily.toLegacyTypography(): Typography

Get Material Typography with default sizes.

TopCornerShape

fun TopCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top start and top end corner unchanged, and applies a specified Dp on other corners.

TopEndBottomStartCornerShape

fun TopEndBottomStartCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top end and bottom start corner unchanged, and applies a specified Dp on other corners.

TopEndCornerShape

fun TopEndCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top end corner unchanged, and applies a specified Dp on other corners.

TopStartBottomEndCornerShape

fun TopStartBottomEndCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top start and bottom end corner unchanged, and applies a specified Dp on other corners.

TopStartCornerShape

fun TopStartCornerShape(baseShape: CornerBasedShape = CircleShape, otherCorner: Dp = 2.dp): CornerBasedShape

Shape which leaves top start corner unchanged, and applies a specified Dp on other corners.

toTypography

@Composable

fun FontFamily.toTypography(): Typography

Get Material3 androidx.compose.material3.Typography with default sizes.

translateClick

fun Modifier.translateClick(maxTranslation: Float = 10.0f): Modifier

Extension function for a Modifier to translate a Composable vertically on click.

withDefaultContext

suspend fun <T> withDefaultContext(block: suspend CoroutineScope.() -> T): T

Handy equivalent of withContext to switch directly with the defaultDispatcher.

withIOContext

suspend fun <T> withIOContext(block: suspend CoroutineScope.() -> T): T

Handy equivalent of withContext to switch directly with the ioDispatcher.

withMainContext

suspend fun <T> withMainContext(block: suspend CoroutineScope.() -> T): T

Handy equivalent of withContext to switch directly with the mainDispatcher.