Stylish UI/com.segnities007.stylishui.foundation

Package-level declarations

Types

data class AnimatedVisibilityState(val visible: Boolean, val alpha: Float)

Holds the animated visibility state for a component, including the current visibility boolean and an animated alpha value.

ConnectedCorners

@Immutable

data class ConnectedCorners(val topStart: Boolean = false, val topEnd: Boolean = false, val bottomStart: Boolean = false, val bottomEnd: Boolean = false)

Describes which corners of a Connected UI item are outer corners (large radius) versus inner/joined corners (small radius).

ConnectedEdges

@Immutable

data class ConnectedEdges(val top: Boolean, val end: Boolean, val bottom: Boolean, val start: Boolean)

Describes which edges of a Connected UI item should have an outline border drawn.

StylishAccessibilityTags

object StylishAccessibilityTags

Stable identifier namespace used by Stylish UI's component roots.

StylishInteractionPolicy

@Immutable

data class StylishInteractionPolicy(val minimumTarget: Dp = DefaultStylishDimensions.iconButtonMinSize, val focusRingWidth: Dp = DefaultStylishDimensions.focusRingWidth, val pressedScale: Float = DefaultStylishAnimationTokens.pressedScale, val stateLayerEnabled: Boolean = true, val focusRingEnabled: Boolean = true, val pressScaleEnabled: Boolean = true)

The cross-component interaction contract used by Stylish UI.

StylishWindowBreakpoints

@Immutable

data class StylishWindowBreakpoints(val compactWidthMax: Dp = 600.dp, val mediumWidthMax: Dp = 840.dp, val compactHeightMax: Dp = 480.dp, val mediumHeightMax: Dp = 900.dp)

Customizable width and height boundaries for applications with unusual layouts.

StylishWindowHeightSizeClass

enum StylishWindowHeightSizeClass : Enum<StylishWindowHeightSizeClass>

Height buckets used when vertical space changes the layout strategy.

StylishWindowSizeClass

@Immutable

data class StylishWindowSizeClass(val widthSizeClass: StylishWindowWidthSizeClass, val heightSizeClass: StylishWindowHeightSizeClass)

Platform-independent window classification derived from available content space.

StylishWindowWidthSizeClass

enum StylishWindowWidthSizeClass : Enum<StylishWindowWidthSizeClass>

Width buckets shared by phone, tablet, desktop, and web layouts.

VisibilityState

@Immutable

sealed class VisibilityState

Describes the visibility behavior of a UI element that can be shown or hidden based on scroll position or other conditions.

Properties

DefaultStylishInteractionPolicy

val DefaultStylishInteractionPolicy: StylishInteractionPolicy

The default interaction contract for all Stylish components.

LocalStylishReducedMotion

val LocalStylishReducedMotion: ProvidableCompositionLocal<Boolean>

Composition local that forces the reduced-motion mode for isStylishReducedMotionEnabled, regardless of the platform setting.

Functions

calculateStylishWindowSizeClass

fun calculateStylishWindowSizeClass(width: Dp, height: Dp): StylishWindowSizeClass

Classifies the available size using the Material adaptive breakpoints.

fun calculateStylishWindowSizeClass(width: Dp, height: Dp, breakpoints: StylishWindowBreakpoints): StylishWindowSizeClass

Classifies a window using caller-provided breakpoints.

connectedColumnCorners

fun connectedColumnCorners(index: Int, size: Int): ConnectedCorners

Computes the outer corners for the item at index in a vertical (column) Connected UI list.

connectedColumnEdges

fun connectedColumnEdges(index: Int, size: Int): ConnectedEdges

Returns the outline edges for the item at index in a vertical (column) Connected UI list.

connectedGridCorners

fun connectedGridCorners(index: Int, size: Int, columns: Int): ConnectedCorners

Computes the outer corners for the item at index in a grid-based Connected UI layout.

connectedGridEdges

fun connectedGridEdges(index: Int, size: Int, columns: Int): ConnectedEdges

Returns the outline edges for the item at index in a grid-based Connected UI layout.

connectedGridItemShape

fun connectedGridItemShape(index: Int, totalItems: Int, columns: Int, outerCornerRadius: Dp = DefaultStylishDimensions.connectedCornerRadius, joinedCornerRadius: Dp = DefaultStylishDimensions.joinedCornerRadius): Shape

Builds a position-aware RoundedCornerShape for the item at index in a grid-based Connected UI layout.

connectedOutline

@Composable

fun Modifier.connectedOutline(edges: ConnectedEdges, corners: ConnectedCorners, cornerRadius: Dp = StylishTheme.dimensions.connectedCornerRadius): Modifier

Draws a hairline outline around a Connected UI item, respecting its edges and corners.

connectedRowCorners

fun connectedRowCorners(index: Int, size: Int): ConnectedCorners

Computes the outer corners for the item at index in a horizontal (row) Connected UI list.

connectedRowEdges

fun connectedRowEdges(index: Int, size: Int): ConnectedEdges

Returns the outline edges for the item at index in a horizontal (row) Connected UI list.

connectedShape

fun connectedShape(corners: ConnectedCorners, cornerRadius: Dp = DefaultStylishDimensions.connectedCornerRadius, joinedCornerRadius: Dp = DefaultStylishDimensions.joinedCornerRadius): Shape

Builds a RoundedCornerShape for a Connected UI item based on its corners configuration.

isActionable

fun isActionable(enabled: Boolean = true, hasClickAction: Boolean, hasLongClickAction: Boolean = false): Boolean

Determines whether a component should behave as an interactive (actionable) element.

isStylishReducedMotionEnabled

@Composable

fun isStylishReducedMotionEnabled(): Boolean

Returns whether the current platform requests reduced motion.

isVisible

@Composable

fun VisibilityState.isVisible(): Boolean

Returns the current visibility state as a boolean, observing any reactive sources (such as VisibilityState.ScrollAware.scrollState) as needed.

rememberNestedScrollAwareVisibilityState

@Composable

fun rememberNestedScrollAwareVisibilityState(threshold: Dp = 48.dp, initiallyVisible: Boolean = true): VisibilityState.NestedScrollAware

Creates a VisibilityState.NestedScrollAware for a nested-scrolling container.

rememberStylishFocusRequesters

@Composable

fun rememberStylishFocusRequesters(count: Int): List<FocusRequester>

Remembers one focus requester per item in a keyboard-navigable collection.

rememberStylishInteractionSource

@Composable

fun rememberStylishInteractionSource(interactionSource: MutableInteractionSource? = null): MutableInteractionSource

Hoists an interaction source without forcing every component to repeat the nullable-source boilerplate. Passing a source keeps interaction state observable by the caller and tests.

rememberVisibilityAnimation

@Composable

fun rememberVisibilityAnimation(visibilityState: VisibilityState): AnimatedVisibilityState

Computes the animated visibility state for a given VisibilityState, providing both the current visibility boolean and an animated alpha value.

StylishAdaptiveLayout

@Composable

fun StylishAdaptiveLayout(compact: @Composable (StylishWindowSizeClass) -> Unit, modifier: Modifier = Modifier, medium: @Composable (StylishWindowSizeClass) -> Unit = compact, expanded: @Composable (StylishWindowSizeClass) -> Unit = medium)

Selects content from the space actually offered by the parent, without platform APIs. The medium and expanded slots default down to the next smaller layout.

stylishContrastRatio

fun stylishContrastRatio(first: Color, second: Color): Double

Returns the WCAG 2.2 contrast ratio between two colors, from 1 to 21.

stylishFocusRing

@Composable

fun Modifier.stylishFocusRing(interactionSource: InteractionSource, shape: Shape = RectangleShape, color: Color = MaterialTheme.colorScheme.primary, width: Dp = 2.dp): Modifier

Draws a focus indicator ring around this component while the interactionSource reports a focus interaction.

stylishInteractiveElevation

@Composable

fun stylishInteractiveElevation(interactionSource: InteractionSource, actionable: Boolean): Dp

Resolves the shared elevation ladder for an actionable surface.

stylishInteractiveSurface

@Composable

fun Modifier.stylishInteractiveSurface(interactionSource: InteractionSource, shape: Shape = RectangleShape, policy: StylishInteractionPolicy = DefaultStylishInteractionPolicy): Modifier

Applies the common interaction contract to a custom surface.

stylishInteractiveTarget

fun Modifier.stylishInteractiveTarget(): Modifier

Applies the platform minimum touch target to an interactive Stylish element.

fun Modifier.stylishInteractiveTarget(minimumTarget: Dp): Modifier

Applies a caller-selected minimum target while retaining Material 3's local minimum-target semantics. The explicit size constraint makes custom components obey the same contract even when a host application changes LocalMinimumInteractiveComponentEnforcement.

stylishMeetsWcagAa

fun stylishMeetsWcagAa(first: Color, second: Color): Boolean

Whether normal text meets WCAG AA (4.5:1).

stylishPressScale

@Composable

fun Modifier.stylishPressScale(interactionSource: InteractionSource, pressedScale: Float? = null): Modifier

Adds a restrained press-scale response to an interactive surface.

stylishRovingFocus

fun Modifier.stylishRovingFocus(requester: FocusRequester, index: Int, itemCount: Int, onMove: (Int) -> Unit, onActivate: () -> Unit? = null, onEscape: () -> Unit? = null): Modifier

Adds roving focus behavior to a collection item. Arrow/Home/End keys are handled and the callback receives the target index; the caller owns the requesters so focus remains hoisted.

stylishStateLayer

@Composable

fun Modifier.stylishStateLayer(interactionSource: InteractionSource, shape: Shape = RectangleShape): Modifier

Draws the Material 3 state-layer overlay on top of this component's content.

stylishTestTag

fun Modifier.stylishTestTag(component: String): Modifier

Adds Stylish UI's stable component identifier to a root node.