design/edu.stanford.spezi.core.design.component

Package-level declarations

Types

AsyncButtonTestIdentifier

enum AsyncButtonTestIdentifier : Enum<AsyncButtonTestIdentifier>

AsyncImageResource

@Immutable

sealed interface AsyncImageResource

CenteredBoxContentTestIdentifier

enum CenteredBoxContentTestIdentifier : Enum<CenteredBoxContentTestIdentifier>

ComposeContentActivity

class ComposeContentActivity : FragmentActivity

ImageResource

@Immutable

sealed interface ImageResource

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.

ShimmerEffectDefaults

data object ShimmerEffectDefaults

StringResource

interface StringResource

Functions

AppTopAppBar

@Composable

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

AsyncButton

@Composable

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

@Composable

fun AsyncButtonPreviews()

AsyncImageResourceComposable

@Composable

fun AsyncImageResourceComposable(imageResource: AsyncImageResource, modifier: Modifier = Modifier, loadingContent: @Composable BoxScope.() -> Unit = { ShimmerEffectBox(modifier = Modifier.matchParentSize()) }, errorContent: @Composable BoxScope.(Throwable) -> Unit = { Box(Modifier.matchParentSize()) { Text("Error loading image", Modifier.align(Alignment.Center)) } }, tint: Color = Colors.primary)

Composable function to display an icon using an ImageResource.

AsyncSwitch

@Composable

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

AsyncTextButton

@Composable

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

Button

@Composable

fun Button(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, content: @Composable RowScope.() -> Unit)

A button of the Spezi design system with customizable content.

CenteredBoxContent

@Composable

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

CircleShimmerEffect

@Composable

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

Renders a circle Compose Box with a shimmer loading effect

CommonScaffold

@Composable

fun CommonScaffold(title: String, modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit)

DefaultElevatedCard

@Composable

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

Default Material Design elevated card.

height

fun Modifier.height(textStyle: TextStyle): Modifier

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

ImageResourceComposable

@Composable

fun ImageResourceComposable(imageResource: ImageResource, modifier: Modifier = Modifier, tint: Color = Colors.primary)

Composable function to display an icon using an ImageResource.

LifecycleEvent

@Composable

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

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

PermissionRequester

@Composable

fun PermissionRequester(missingPermissions: List<String>?, onGranted: (String) -> Unit)

RectangleShimmerEffect

@Composable

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

Renders a rectangle Compose Box with a shimmer loading effect

RepeatingLazyColumn

@Composable

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

@Composable

fun RepeatingLazyColumnPreview()

SecondaryText

@Composable

fun SecondaryText(text: String, modifier: Modifier = Modifier)

ShimmerEffectBox

@Composable

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

@Composable

fun ShimmerEffectPreview()

SpeziButtonDarkPreview

@Preview

@Composable

fun SpeziButtonDarkPreview()

VerticalSpacer

@Composable

fun VerticalSpacer(height: Dp = Spacings.medium)