Design/net.ikea.skapa.ui.util

Package-level declarations

Shared helper functions.

Types

data class A11ySkipListing(val listTitle: String, val actionLabel: String, val nextItemFocusRequester: FocusRequester)

Used to skip listing when a list of components is too large

data class AccessibleLabel(val text: String, val contentDescription: String?)

AccessibleLabel is used to provide a text label and an optional content description for accessibility purposes. This is useful when you want to provide additional context for screen readers or other assistive technologies.

FocusBorderType

enum FocusBorderType : Enum<FocusBorderType>

Defines the border type.

Functions

accessibilityLabel

fun Modifier.accessibilityLabel(label: AccessibleLabel): Modifier

animatedRoundedBackground

fun DrawScope.animatedRoundedBackground(animatedScale: Animatable<Float, AnimationVector1D>, backgroundColor: Color, cornerRadius: Dp)

focusableWithBorder

fun Modifier.focusableWithBorder(focused: State<Boolean>, enabled: Boolean = true, cornerSize: Dp = 0.dp, borderType: FocusBorderType = FocusBorderType.Default, insideBorder: Boolean = false, doubleBorders: Boolean = true): Modifier

fun Modifier.focusableWithBorder(focused: State<Boolean>, enabled: Boolean = true, shape: CornerBasedShape, borderType: FocusBorderType = FocusBorderType.Default, insideBorder: Boolean = false, doubleBorders: Boolean = true, paddingValues: PaddingValues = PaddingValues()): Modifier

InternalSkapaApi modifier extension used to apply Skapa keyboard navigation border to focusable components

minimumTouchTargetSize

fun Modifier.minimumTouchTargetSize(width: Dp = 48.dp, height: Dp = 48.dp): Modifier

InternalSkapaApi modifier extension copied from androidx.compose.material.TouchTarget used to guarantee minimum touch target size.

mirrorHorizontally

fun Modifier.mirrorHorizontally(): Modifier

moveFocusOnTab

fun Modifier.moveFocusOnTab(focusManager: FocusManager): Modifier

Forcing keyboard navigation FocusDirection.Next and FocusDirection.Previous when using Key.Tab in eg. multiline text fields/text areas. Used same solution as Kotlin multi-platform uses as workaround. https://github.com/JetBrains/compose-multiplatform/blob/master/tutorials/Tab_Navigation/README.md#a-possible-workaround

pointerHoverHandIcon

fun Modifier.pointerHoverHandIcon(hover: Boolean, enabled: Boolean = true): Modifier

rememberSkapaButtonIndication

@Composable

fun rememberSkapaButtonIndication(resizeFactor: Float = SkapaAnimation.SizeFactors.RegularComponents, animationSpec: AnimationSpec<Float> = SkapaAnimation.PressAnimationSpec, color: Color? = null, cornersRadius: Dp = Dp.Unspecified, scale: Animatable<Float, AnimationVector1D>): Indication

skapaShadow

fun Modifier.skapaShadow(cornersRadius: Dp, color: Color = Color.Unspecified, shadowBlurRadius: Dp = 16.dp, offsetY: Dp = 4.dp, offsetX: Dp = 0.dp): Modifier

InternalSkapaApi modifier extension used to apply Skapa default shadow.

thenCheckNull

@Composable

fun <T> Modifier.thenCheckNull(nullable: T?, block: @Composable Modifier.(value: T) -> Modifier): Modifier

Applies the modifier provided if the nullable value is not null, uses Modifier.then() Example: Modifier.thenCheckNull("NotNull") { clickable(onClick = it) }

thenCheckTrue

@Composable

fun Modifier.thenCheckTrue(boolean: Boolean, block: @Composable Modifier.() -> Modifier): Modifier

Applies the modifier provided if the @param boolean value is true, uses Modifier.then() Example: Modifier.thenCheckTrue("BooleanValue") { minimumTouchTargetSize() }