ui/edu.stanford.spezi.ui

Package-level declarations

Types

AsyncButtonTestIdentifier

enum AsyncButtonTestIdentifier : Enum<AsyncButtonTestIdentifier>

AsyncTextButton

data class AsyncTextButton(val title: String, val enabled: Boolean = true, shape: ComposeValue<Shape> = { ButtonDefaults.shape }, containerColor: ComposeValue<Color> = { ButtonDefaults.buttonColors().containerColor }, textColor: ComposeValue<Color> = { ButtonDefaults.buttonColors().contentColor }, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, coroutineScope: ComposeValue<CoroutineScope> = { rememberCoroutineScope() }, val action: suspend () -> Unit = {}) : ComposableContent

BottomSheetComposableContent

interface BottomSheetComposableContent : ComposableContent

CenteredBoxContentTestIdentifier

enum CenteredBoxContentTestIdentifier : Enum<CenteredBoxContentTestIdentifier>

ComposableBlock

typealias ComposableBlock = @Composable () -> Unit

A type alias for a composable lambda function with no parameters and no return value.

ComposableContent

interface ComposableContent

An interface for types with the capability to render themselves in compose

typealias ComposeValue<T> = @Composable () -> T

A type alias for a composable lambda function with no parameters and a return value of type T. Useful for types of properties of a ComposableContent where a compose scope is needed

DialogComposableContent

interface DialogComposableContent : ComposableContent

A ComposableContent with additional capability to render itself in as a model dialog

sealed interface ImageResource : ComposableContent

A sealed class to represent an image resource. It can be either a vector image or a drawable. This is useful to abstract the image resource type and use it in a composable function. The identifier can be used for tests.

interface OperationState

data class PendingActions<T : Any>(actions: List<T> = emptyList())

An immutable action holder data class to be used in UiStates and to be consumed in Compose to indicate pending loading async states.

object SemanticKeys

ShimmerEffectDefaults

data object ShimmerEffectDefaults

sealed interface StringResource

typealias TestIdentifier = Enum<*>

A type alias on any enum type. Useful to set test tag on composable of a Screen to ensure uniqueness of the tags

sealed interface ViewState

Properties

LocalDefaultErrorMessage

val LocalDefaultErrorMessage: ProvidableCompositionLocal<StringResource>

LocalDefaultErrorTitle

val LocalDefaultErrorTitle: ProvidableCompositionLocal<StringResource>

Functions

fun AppTopAppBar(modifier: Modifier = Modifier, title: @Composable () -> Unit, navigationIcon: @Composable () -> Unit = {}, actions: @Composable RowScope.() -> Unit = {})

fun AsyncButton(modifier: Modifier = Modifier, isLoading: Boolean = false, enabled: Boolean = isLoading.not(), shape: Shape = ButtonDefaults.shape, containerColor: Color = ButtonDefaults.buttonColors().containerColor, contentColor: Color = ButtonDefaults.buttonColors().contentColor, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, onClick: () -> Unit = {}, content: @Composable RowScope.() -> Unit)

A button that renders a circular progress CircularProgressIndicator in case of loading or content otherwise

AsyncButtonPreviews

fun AsyncButtonPreviews()

AsyncImageResource

fun AsyncImageResource(url: String?, modifier: Modifier = Modifier, contentDescription: String = "", contentScale: ContentScale = ContentScale.Fit, loading: @Composable BoxScope.() -> Unit = { }, error: @Composable BoxScope.() -> Unit = { })

Composable function to display an image from a remote url

fun AsyncSwitch(modifier: Modifier = Modifier, isLoading: Boolean = false, checked: Boolean, onCheckedChange: (Boolean) -> Unit, enabled: Boolean = isLoading.not())

AsyncTextButton

fun AsyncTextButton(text: String, modifier: Modifier = Modifier, isLoading: Boolean = false, enabled: Boolean = isLoading.not(), shape: Shape = ButtonDefaults.shape, containerColor: Color = ButtonDefaults.buttonColors().containerColor, textColor: Color = ButtonDefaults.buttonColors().contentColor, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, onClick: () -> Unit = {})

A button that renders a circular progress CircularProgressIndicator in case of loading or text otherwise

CenteredBoxContent

fun CenteredBoxContent(content: @Composable BoxScope.() -> Unit)

CircleShimmerEffect

fun CircleShimmerEffect(modifier: Modifier, duration: Int = ShimmerEffectDefaults.durationMillis, color: Color = ShimmerEffectDefaults.color)

Renders a circle Compose Box with a shimmer loading effect

fun CommonScaffold(title: String, modifier: Modifier = Modifier, navigationIcon: @Composable () -> Unit = {}, actions: @Composable RowScope.() -> Unit = {}, content: @Composable ColumnScope.() -> Unit)

DefaultElevatedCard

fun DefaultElevatedCard(modifier: Modifier = Modifier, shape: Shape = CardDefaults.shape, content: @Composable ColumnScope.() -> Unit)

Default Material Design elevated card.

DescriptionGridRow

fun DescriptionGridRow(description: @Composable BoxScope.() -> Unit, modifier: Modifier = Modifier, content: @Composable BoxScope.() -> Unit)

fun Modifier.disabledAlpha(): Modifier

fun Modifier.height(textStyle: TextStyle): Modifier

Applies the height of the font size, useful when declaring shimmer effects to replicate a loading text

fun LifecycleEvent(onEvent: (Lifecycle.Event) -> Unit)

A composable that notifies the lifecycle events of the current lifecycle owner

fun Color.lighten(): Color

mapOperationStateToViewState

fun <State : OperationState> mapOperationStateToViewState(state: State): MutableState<ViewState>

noRippleClickable

fun Modifier.noRippleClickable(onClick: () -> Unit): Modifier

OperationStateAlert

fun <State : OperationState> OperationStateAlert(state: State, modifier: Modifier = Modifier, onClose: () -> Unit)

fun <State : OperationState> OperationStateAlert(state: MutableState<State>, modifier: Modifier = Modifier, onClose: () -> Unit = {})

PermissionRequester

fun PermissionRequester(missingPermissions: Set<String>, onResult: (Boolean, String) -> Unit)

ProcessingOverlay

fun ProcessingOverlay(viewState: ViewState, modifier: Modifier = Modifier, processingContent: @Composable BoxScope.() -> Unit = { CircularProgressIndicator() }, content: @Composable BoxScope.() -> Unit)

fun ProcessingOverlay(isProcessing: Boolean, modifier: Modifier = Modifier, processingContent: @Composable BoxScope.() -> Unit = { CircularProgressIndicator() }, content: @Composable BoxScope.() -> Unit)

RectangleShimmerEffect

fun RectangleShimmerEffect(modifier: Modifier, duration: Int = ShimmerEffectDefaults.durationMillis, color: Color = ShimmerEffectDefaults.color)

Renders a rectangle Compose Box with a shimmer loading effect

RepeatingLazyColumn

fun RepeatingLazyColumn(modifier: Modifier = Modifier, itemCount: Int = DEFAULT_REPEATING_ITEMS_COUNT, content: @Composable LazyItemScope.() -> Unit)

Renders a lazy column with itemCount same contents. Helpful when rendering loading list items

RepeatingLazyColumnPreview

fun RepeatingLazyColumnPreview()

ShimmerEffectBox

fun ShimmerEffectBox(modifier: Modifier = Modifier, shape: Shape = ShimmerEffectDefaults.shape, duration: Int = ShimmerEffectDefaults.durationMillis, color: Color = ShimmerEffectDefaults.color)

Renders a Compose Box with a shimmer loading effect

ShimmerEffectPreview

fun ShimmerEffectPreview()

fun SuspendButton(title: String, state: MutableState<ViewState> = remember { mutableStateOf(ViewState.Idle) }, action: suspend () -> Unit)

fun SuspendButton(processingDebounceDuration: Duration = 150.milliseconds, state: MutableState<ViewState> = remember { mutableStateOf(ViewState.Idle) }, action: suspend () -> Unit, label: @Composable () -> Unit)

fun TestIdentifier.tag(suffix: String? = null): String

Constructs the test tag of an enum as EnumTypeName:EnumCaseName

testColorIdentifier

fun Modifier.testColorIdentifier(color: Color): Modifier

testContentIdentifier

fun Modifier.testContentIdentifier(content: String): Modifier

testDrawableResIdentifier

fun Modifier.testDrawableResIdentifier(@DrawableRes id: Int): Modifier

fun Modifier.testIdentifier(identifier: TestIdentifier, suffix: String? = null): Modifier

Sets the test tag of a composable to the tag of the enum case.

ValidatedOutlinedTextField

fun ValidatedOutlinedTextField(modifier: Modifier = Modifier, value: String = "", onValueChange: (String) -> Unit, labelText: String = "", errorText: String? = null, singleLine: Boolean = true, keyboardOptions: KeyboardOptions = KeyboardOptions.Default.copy(imeAction = ImeAction.Next), visualTransformation: VisualTransformation = VisualTransformation.None, readOnly: Boolean = false, trailingIcon: ComposableBlock? = null, keyboardActions: KeyboardActions = KeyboardActions.Default)

fun VerticalSpacer(height: Dp = Spacings.medium)

fun ViewStateAlert(state: MutableState<ViewState>, modifier: Modifier = Modifier)

fun ViewStateAlert(state: ViewState, modifier: Modifier = Modifier, onClose: () -> Unit)