Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard

Interfaces for positioning a menu within a window. This is the same purpose as the interface PopupPositionProvider, except Vertical and Horizontal separate out the positioning logic for each direction individually.

Link copied to clipboard
data class PreviewLabButtonColors(val containerColor: Color, val contentColor: Color, val borderColor: Color? = null, val disabledContainerColor: Color, val disabledContentColor: Color, val disabledBorderColor: Color? = null)
Link copied to clipboard
Link copied to clipboard
data class PreviewLabButtonStyle(val colors: PreviewLabButtonColors, val shape: Shape, val elevation: ButtonElevation? = null, val contentPadding: PaddingValues)
Link copied to clipboard
data class PreviewLabCheckboxColors(val checkedCheckmarkColor: Color, val uncheckedCheckmarkColor: Color, val checkedBoxColor: Color, val uncheckedBoxColor: Color, val disabledCheckedBoxColor: Color, val disabledUncheckedBoxColor: Color, val disabledIndeterminateBoxColor: Color, val checkedBorderColor: Color, val uncheckedBorderColor: Color, val disabledBorderColor: Color, val disabledUncheckedBorderColor: Color, val disabledIndeterminateBorderColor: Color)
Link copied to clipboard
Link copied to clipboard
data class PreviewLabChipColors(val containerColor: Color, val contentColor: Color, val outlineColor: Color? = null, val selectedContainerColor: Color, val selectedOutlineColor: Color? = null, val selectedContentColor: Color, val disabledContainerColor: Color, val disabledContentColor: Color, val disabledOutlineColor: Color? = null)
Link copied to clipboard
Link copied to clipboard
data class PreviewLabChipStyle(val colors: PreviewLabChipColors, val shape: Shape, val elevation: ButtonElevation? = null, val contentPadding: PaddingValues)
Link copied to clipboard
Link copied to clipboard

Transformer for converting between Dp values and their string representation.

Link copied to clipboard

Transformer for converting between Float values and their string representation.

Link copied to clipboard
data class PreviewLabIconButtonColors(val containerColor: Color, val contentColor: Color, val borderColor: Color? = null, val disabledContainerColor: Color, val disabledContentColor: Color, val disabledBorderColor: Color? = null)
Link copied to clipboard
data class PreviewLabIconButtonStyle(val colors: PreviewLabIconButtonColors, val shape: Shape, val elevation: ButtonElevation? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Transformer for converting between nullable Dp values and their string representation. Empty strings are converted to null values.

Link copied to clipboard

Transformer for converting between nullable Float values and their string representation. Empty strings are converted to null values.

Link copied to clipboard
data class PreviewLabRadioButtonColors(val selectedColor: Color, val unselectedColor: Color, val disabledSelectedColor: Color, val disabledUnselectedColor: Color)
Link copied to clipboard
class PreviewLabSwitchColors(checkedThumbColor: Color, checkedTrackColor: Color, checkedBorderColor: Color, checkedIconColor: Color, uncheckedThumbColor: Color, uncheckedTrackColor: Color, uncheckedBorderColor: Color, uncheckedIconColor: Color, disabledCheckedThumbColor: Color, disabledCheckedTrackColor: Color, disabledCheckedBorderColor: Color, disabledCheckedIconColor: Color, disabledUncheckedThumbColor: Color, disabledUncheckedTrackColor: Color, disabledUncheckedBorderColor: Color, disabledUncheckedIconColor: Color)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed interface PreviewLabTooltipScope
Link copied to clipboard

Scope class providing context for TransformableTextField slot content.

Link copied to clipboard

Interface for transforming values to and from string representation.

Functions

Link copied to clipboard

Binds a MutableState to a typed value using a transformer for bidirectional conversion.

Link copied to clipboard
fun PreviewLabButton(modifier: Modifier = Modifier, text: String? = null, isEnabled: Boolean = true, isSelected: Boolean = false, isLoading: Boolean = false, variant: PreviewLabButtonVariant = PreviewLabButtonVariant.Primary, shape: Shape? = null, onClick: () -> Unit = {}, contentPadding: PaddingValues = PreviewLabButtonDefaults.contentPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit? = null)
Link copied to clipboard
fun PreviewLabCheckbox(modifier: Modifier = Modifier, checked: Boolean, onCheckedChange: (Boolean) -> Unit? = null, enabled: Boolean = true, colors: PreviewLabCheckboxColors = PreviewLabCheckboxDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
Link copied to clipboard
fun PreviewLabChip(modifier: Modifier = Modifier, enabled: Boolean = true, selected: Boolean = false, onClick: () -> Unit = {}, contentPadding: PaddingValues = PreviewLabChipDefaults.contentPadding, shape: Shape = ChipRectShape, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabChipComponent(modifier: Modifier, enabled: Boolean = true, selected: Boolean = false, style: PreviewLabChipStyle, onClick: () -> Unit, contentPadding: PaddingValues = PreviewLabChipDefaults.contentPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabDefaultChipComponent(modifier: Modifier = Modifier, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
fun ColumnScope.PreviewLabDivider(modifier: Modifier = Modifier, thickness: Dp = PreviewLabDividerDefaults.Thickness, color: Color = PreviewLabDividerDefaults.color)
fun RowScope.PreviewLabDivider(modifier: Modifier = Modifier, thickness: Dp = PreviewLabDividerDefaults.Thickness, color: Color = PreviewLabDividerDefaults.color)
Link copied to clipboard
fun PreviewLabElevatedChip(modifier: Modifier = Modifier, enabled: Boolean = true, selected: Boolean = false, onClick: () -> Unit = {}, contentPadding: PaddingValues = PreviewLabChipDefaults.contentPadding, shape: Shape = ChipRectShape, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabHorizontalDivider(modifier: Modifier = Modifier, thickness: Dp = PreviewLabDividerDefaults.Thickness, color: Color = PreviewLabDividerDefaults.color)
Link copied to clipboard
fun PreviewLabIcon(bitmap: ImageBitmap, modifier: Modifier = Modifier, contentDescription: String? = null, tint: Color = LocalContentColor.current)
fun PreviewLabIcon(painter: Painter, modifier: Modifier = Modifier, contentDescription: String? = null, tint: Color = LocalContentColor.current)
fun PreviewLabIcon(imageVector: ImageVector, modifier: Modifier = Modifier, contentDescription: String? = null, tint: Color = LocalContentColor.current)
Link copied to clipboard
fun PreviewLabIconButton(painter: Painter, contentDescription: String? = null, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, variant: PreviewLabIconButtonVariant = PreviewLabIconButtonVariant.Ghost, tint: Color? = null)
fun PreviewLabIconButton(imageVector: ImageVector, contentDescription: String? = null, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, variant: PreviewLabIconButtonVariant = PreviewLabIconButtonVariant.Ghost, tint: Color? = null)
fun PreviewLabIconButton(modifier: Modifier = Modifier, enabled: Boolean = true, loading: Boolean = false, variant: PreviewLabIconButtonVariant = PreviewLabIconButtonVariant.Primary, shape: Shape = PreviewLabIconButtonDefaults.ButtonSquareShape, onClick: () -> Unit = {}, contentPadding: PaddingValues = PreviewLabIconButtonDefaults.ButtonPadding, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabIconButtonContent(painter: Painter, contentDescription: String? = null, onClick: () -> Unit, modifier: Modifier = Modifier, variant: PreviewLabIconButtonVariant = PreviewLabIconButtonVariant.Ghost, tint: Color? = null, enabled: Boolean = true)
Link copied to clipboard
fun PreviewLabListHeader(title: String, actions: @Composable () -> Unit, modifier: Modifier = Modifier)
Link copied to clipboard
fun PreviewLabListItem(isSelected: Boolean, onSelect: () -> Unit? = null, modifier: Modifier = Modifier, isEnabled: Boolean = true, content: @Composable () -> Unit)

Common list item with custom content

fun PreviewLabListItem(title: String, isSelected: Boolean, onSelect: () -> Unit? = null, isEnabled: Boolean = true, modifier: Modifier = Modifier)

Common list item with title display

fun PreviewLabListItem(title: String, isSelected: Boolean, onSelect: () -> Unit? = null, modifier: Modifier = Modifier, isEnabled: Boolean = true, leadingContent: @Composable () -> Unit? = null)

Common list item with title and optional leading content

Link copied to clipboard
fun PreviewLabMenu(expanded: Boolean, onDismissRequest: () -> Unit, content: @Composable PreviewLabMenuScope.() -> Unit)
Link copied to clipboard
fun PreviewLabModal(isVisible: Boolean, onDismissRequest: () -> Unit, contentPadding: PaddingValues = PaddingValues(12.dp), contentAlignment: Alignment = Alignment.Center, content: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabOutlinedChip(modifier: Modifier = Modifier, enabled: Boolean = true, selected: Boolean = false, onClick: () -> Unit = {}, contentPadding: PaddingValues = PreviewLabChipDefaults.contentPadding, shape: Shape = ChipRectShape, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, label: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabRadioButton(modifier: Modifier = Modifier, selected: Boolean, onClick: () -> Unit? = null, enabled: Boolean = true, colors: PreviewLabRadioButtonColors = PreviewLabRadioButtonDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit? = null)
Link copied to clipboard
fun PreviewLabSelectableText(text: AnnotatedString, modifier: Modifier = Modifier, color: Color = LocalContentColor.current, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign = TextAlign.Start, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, inlineContent: Map<String, InlineTextContent> = mapOf(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)
Link copied to clipboard
fun <V> PreviewLabSelectButton(value: V, choices: List<V>, onSelect: (V) -> Unit, title: (V) -> String, modifier: Modifier = Modifier, itemDetail: (V) -> String? = { null })
fun <V> PreviewLabSelectButton(choices: List<V>, currentIndex: Int, onSelect: (Int) -> Unit, title: (V) -> String, modifier: Modifier = Modifier, itemDetail: (V) -> String? = { null })
Link copied to clipboard
fun PreviewLabSurface(modifier: Modifier = Modifier, shape: Shape = RectangleShape, color: Color = PreviewLabTheme.colors.surface, contentColor: Color = contentColorFor(color), shadowElevation: Dp = 0.dp, border: BorderStroke? = null, content: @Composable () -> Unit)
fun PreviewLabSurface(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = PreviewLabTheme.colors.background, contentColor: Color = contentColorFor(color), shadowElevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)
fun PreviewLabSurface(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = PreviewLabTheme.colors.background, contentColor: Color = contentColorFor(color), shadowElevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)
fun PreviewLabSurface(checked: Boolean, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = RectangleShape, color: Color = PreviewLabTheme.colors.background, contentColor: Color = contentColorFor(color), shadowElevation: Dp = 0.dp, border: BorderStroke? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabSwitch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, thumbContent: @Composable () -> Unit? = null, enabled: Boolean = true, colors: PreviewLabSwitchColors = PreviewLabSwitchDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
Link copied to clipboard
fun PreviewLabTab(selected: Boolean, onClick: () -> Unit, text: @Composable () -> Unit)
Link copied to clipboard
fun <T> PreviewLabTabPager(tabs: List<T>, title: (T) -> String, pagerState: PagerState, modifier: Modifier = Modifier, content: @Composable (tab: T) -> Unit)
Link copied to clipboard
fun PreviewLabTabRow(modifier: Modifier = Modifier, content: @Composable () -> Unit)
Link copied to clipboard
fun PreviewLabText(text: String, modifier: Modifier = Modifier, color: Color = LocalContentColor.current, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign = TextAlign.Start, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)
fun PreviewLabText(text: AnnotatedString, modifier: Modifier = Modifier, color: Color = LocalContentColor.current, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign = TextAlign.Start, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, minLines: Int = 1, inlineContent: Map<String, InlineTextContent> = mapOf(), onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)
Link copied to clipboard
fun PreviewLabTooltipBox(modifier: Modifier = Modifier, positionProvider: PopupPositionProvider = rememberPreviewLabTooltipPositionProvider(), tooltip: @Composable PreviewLabTooltipScope.() -> Unit, state: PreviewLabTooltipState = rememberPreviewLabTooltipState(), focusable: Boolean = true, enableUserInput: Boolean = true, content: @Composable () -> Unit)
fun PreviewLabTooltipBox(tooltip: String, modifier: Modifier = Modifier, positionProvider: PopupPositionProvider = rememberPreviewLabTooltipPositionProvider(), state: PreviewLabTooltipState = rememberPreviewLabTooltipState(), focusable: Boolean = true, enableUserInput: Boolean = true, content: @Composable () -> Unit)
Link copied to clipboard
fun <Value> PreviewLabTransformableOutlinedTextField(value: Value, onValueChange: (Value) -> Unit, transformer: PreviewLabTransformer<Value>, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, textStyle: TextStyle = PreviewLabTheme.typography.input, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, singleLine: Boolean = false, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, visualTransformation: VisualTransformation = VisualTransformation.None, onTextLayout: PreviewLabTransformableTextFieldSlotScope.(TextLayoutResult) -> Unit = {}, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, placeholder: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, prefix: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, suffix: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, label: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, leadingIcon: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, trailingIcon: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, supportingText: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, isError: Boolean? = null, shape: Shape = PreviewLabTextFieldDefaults.Shape, colors: PreviewLabTextFieldColors = PreviewLabTextFieldDefaults.colors(), cursorBrush: Brush = SolidColor(colors.cursorColor(isError == true).value))
Link copied to clipboard
fun <Value> PreviewLabTransformableTextField(value: Value, onValueChange: (Value) -> Unit, transformer: PreviewLabTransformer<Value>, modifier: Modifier = Modifier, enabled: Boolean = true, readOnly: Boolean = false, textStyle: TextStyle = PreviewLabTheme.typography.input, keyboardOptions: KeyboardOptions = KeyboardOptions.Default, keyboardActions: KeyboardActions = KeyboardActions.Default, singleLine: Boolean = false, maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, minLines: Int = 1, visualTransformation: VisualTransformation = VisualTransformation.None, onTextLayout: PreviewLabTransformableTextFieldSlotScope.(TextLayoutResult) -> Unit = {}, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, placeholder: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, prefix: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, suffix: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, label: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, leadingIcon: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, trailingIcon: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, supportingText: @Composable PreviewLabTransformableTextFieldSlotScope.() -> Unit? = null, isError: Boolean? = null, shape: Shape = PreviewLabTextFieldDefaults.Shape, colors: PreviewLabTextFieldColors = PreviewLabTextFieldDefaults.colors(), cursorBrush: Brush = SolidColor(colors.cursorColor(isError == true).value))
Link copied to clipboard
fun PreviewLabTriStateCheckbox(state: ToggleableState, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, colors: PreviewLabCheckboxColors = PreviewLabCheckboxDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
Link copied to clipboard
fun PreviewLabVerticalDivider(modifier: Modifier = Modifier, thickness: Dp = PreviewLabDividerDefaults.Thickness, color: Color = PreviewLabDividerDefaults.color)
fun rememberPreviewLabTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp = PreviewLabTooltipDefaults.SpacingBetweenTooltipAndAnchor): PopupPositionProvider
Link copied to clipboard
fun rememberPreviewLabTooltipState(initialIsVisible: Boolean = false, isPersistent: Boolean = false, mutatorMutex: MutatorMutex = BasicTooltipDefaults.GlobalMutatorMutex): PreviewLabTooltipState
Link copied to clipboard
fun PreviewLabTooltipScope.Tooltip(modifier: Modifier = Modifier, caretSize: DpSize = PreviewLabTooltipDefaults.CaretSize, maxWidth: Dp = PreviewLabTooltipDefaults.MaxWidth, shape: Shape = PreviewLabTooltipDefaults.Shape, containerColor: Color = PreviewLabTheme.colors.surface, shadowElevation: Dp = PreviewLabTooltipDefaults.ShadowElevation, content: @Composable () -> Unit)