field/me.tbsten.compose.preview.lab.field/WithValueCodeField

WithValueCodeField

class WithValueCodeField<Value>(baseField: MutablePreviewLabField<Value>, valueCode: (Value) -> String) : MutablePreviewLabField<Value>

A wrapper field that customizes the valueCode output of another field.

This class delegates all functionality to the base field except for valueCode, which uses the provided lambda to generate Kotlin code strings.

In most cases, use the withValueCode extension function instead of instantiating this class directly.

Parameters

Value

The type of value this field holds

baseField

The underlying field to wrap

valueCode

A function that converts the current value to a Kotlin code string

See also

Constructors

Link copied to clipboard
constructor(baseField: MutablePreviewLabField<Value>, valueCode: (Value) -> String)

Properties

Link copied to clipboard
open override val coroutineScope: CoroutineScope
Link copied to clipboard
open override val initialValue: Value

Default value for this field.

Link copied to clipboard
open override val label: String

The label for this field. This is not used in any of the program logic, but only for display purposes, so it is best to set it in a language that is easy for your team members to read.

Link copied to clipboard
open override var value: Value

Current value of this PreviewLabField.

Link copied to clipboard
open override val valueFlow: Flow<Value>

Functions

Link copied to clipboard
open operator override fun component1(): Value
Link copied to clipboard
open operator override fun component2(): (Value) -> Unit
Link copied to clipboard
@Composable
open override fun Content()

Composable, which displays the main UI for this Field. If you want to customize the UI, you can override this method in your PreviewLabField to customize the UI.

Link copied to clipboard
@Composable
fun <Value> PreviewLabField<Value>.DefaultFieldView(modifier: Modifier = Modifier, menuItems: List<PreviewLabField.ViewMenuItem<Value>> = ViewMenuItem.defaults<Value>(this), content: @Composable () -> Unit = { Content() })

Default UI implementation of me.tbsten.compose.preview.lab.PreviewLabField.View. Display a label and draw the content below it.

Link copied to clipboard
@Composable
fun <Value> PreviewLabField<Value>.FieldLabelHeader(menuItems: List<PreviewLabField.ViewMenuItem<Value>> = ViewMenuItem.defaults<Value>(this))

Display the label of PreviewLabField.

Link copied to clipboard
fun <Value : Any> PreviewLabField<Value>.nullable(initialValue: Value? = this.initialValue): NullableField<Value>

Create a PreviewLabField that makes the receiver's PreviewLabField nullable.

Link copied to clipboard
open fun onCleared()
Link copied to clipboard
open override fun serializer(): KSerializer<Value>?

Returns a KSerializer for this field's value type, or null if serialization is not supported.

Link copied to clipboard
open override fun testValues(): List<Value>

Returns a list of representative values for this field to be used in automated testing.

Link copied to clipboard
@Composable
fun <Value> MutablePreviewLabField<Value>.TextFieldContent(toString: (Value) -> String, toValue: (String) -> Result<Value>, modifier: Modifier = Modifier, prefix: @Composable () -> Unit? = null, suffix: @Composable () -> Unit? = null, placeholder: @Composable () -> Unit? = null)

Helper for UI of Fields that can be input with TextField.

Link copied to clipboard
fun <BaseValue, TransformedValue> MutablePreviewLabField<BaseValue>.transform(transform: (BaseValue) -> TransformedValue, reverse: (TransformedValue) -> BaseValue, label: String = this.label, initialValue: TransformedValue = transform(this.value)): TransformField<BaseValue, TransformedValue>

Transforms a MutablePreviewLabField to work with a different value type.

Link copied to clipboard
open override fun valueCode(): String

Returns a Kotlin code string representing the current value of this field.

Link copied to clipboard
@Composable
open override fun View(menuItems: List<PreviewLabField.ViewMenuItem<Value>>)

Composable, which displays the entire UI for this Field. If you want to customize the UI, you can override this method in your PreviewLabField to customize the UI. However, in many cases where the UI is customized, overriding the content method is more appropriate.

Link copied to clipboard
fun <Value> MutablePreviewLabField<Value>.withHint(vararg choices: Pair<String, Value>): MutablePreviewLabField<Value>

Adds hint choices to a MutablePreviewLabField, allowing users to quickly select from predefined values.

Link copied to clipboard
fun MutablePreviewLabField<String>.withImageUrlHint(includeDummyImages: Boolean = true, includeInvalidImages: Boolean = true): MutablePreviewLabField<String>
Link copied to clipboard
fun MutablePreviewLabField<Color>.withPredefinedColorHint(): MutablePreviewLabField<Color>

Adds predefined color hints to a Color field for quick selection.

Link copied to clipboard
fun <Value> MutablePreviewLabField<Value>.withSerializer(serializer: KSerializer<Value>): MutablePreviewLabField<Value>

Wraps this field with a custom me.tbsten.compose.preview.lab.PreviewLabField.serializer implementation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <Value> MutablePreviewLabField<Value>.wrap(wrapRange: WrapRange = WrapRange.OnlyContent, content: @Composable (@Composable () -> Unit) -> Unit): WrapField<Value>

Wraps this field with additional composable content.

Generated by Dokka
© 2026 Copyright