kotose-form/io.github.robinpcrd.kotose.form.compose

Package-level declarations

Types

ColorSchemeKeyTokens

enum ColorSchemeKeyTokens : Enum<ColorSchemeKeyTokens>

ComposeField

interface ComposeField

Optional Compose view owned by a styled or custom field.

FieldColors

@Immutable

class FieldColors

FieldColorsToken

object FieldColorsToken

FieldDefaults

object FieldDefaults

KotoseFormStyle

@Immutable

data class KotoseFormStyle(val accent: Color, val text: Color, val placeholder: Color, val inputBackground: Color, val inputBorder: Color, val focusedBorder: Color, val disabledText: Color, val disabledBackground: Color, val error: Color, val warning: Color, val paragraphBackground: Color, val cornerRadius: Dp, val borderWidth: Dp, val inputTextStyle: TextStyle, val messageTextStyle: TextStyle, val titleTextStyle: TextStyle, val showsMessageIcons: Boolean, val showsKeyboardBar: Boolean = true)

Visual tokens for the Compose renderer, named like the SwiftUI KotoseFormStyle so one brand maps to both renderers. Kotlin owns every semantic (enabled, error, warning, focus, labels); the style only decides how the renderer draws them. Defaults come from MaterialTheme, so a form inside the app's theme already follows it; use KotoseFormTheme to override tokens.

Paddings

@Immutable

data class Paddings(val defaultPadding: Dp = 16.dp, val tinyPadding: Dp = 4.dp, val smallPadding: Dp = 8.dp, val largePadding: Dp = 24.dp)

Properties

val amber300: Color

val amber600: Color

val amber700: Color

val LocalForm: ProvidableCompositionLocal<Form>

LocalKotosePaddings

val LocalKotosePaddings: ProvidableCompositionLocal<Paddings>

orange100

val orange100: Color

orange200

val orange200: Color

orange300

val orange300: Color

Functions

animateBorderStrokeAsState

@Composable

fun animateBorderStrokeAsState(enabled: Boolean, isError: Boolean, interactionSource: InteractionSource, colors: FieldColors, focusedBorderThickness: Dp = FocusedBorderThickness, unfocusedBorderThickness: Dp = UnfocusedBorderThickness): State<BorderStroke>

autofill

fun Modifier.~~autofill~~(autofillTypes: List<AutofillType>, onFill: (String) -> Unit): Modifier

clearFocusOnKeyboardDismiss

actual fun Modifier.clearFocusOnKeyboardDismiss(): Modifier

expect fun Modifier.clearFocusOnKeyboardDismiss(): Modifier

actual fun Modifier.clearFocusOnKeyboardDismiss(): Modifier

clearFormFocusOnKeyboardDismiss

fun Modifier.~~clearFormFocusOnKeyboardDismiss~~(): Modifier

DefaultFieldView

@Composable

fun DefaultFieldView(field: Field<*>)

fieldPadding

fun Modifier.fieldPadding(): Modifier

fun Modifier.~~fieldPadding~~(isError: Boolean = false): Modifier

FormScreen

@Composable

fun FormScreen(modifier: Modifier = Modifier, lazyListState: LazyListState = rememberLazyListState(), contentPadding: PaddingValues = PaddingValues(0.dp), reverseLayout: Boolean = false, verticalArrangement: Arrangement.Vertical = if (!reverseLayout) Arrangement.Top else Arrangement.Bottom, horizontalAlignment: Alignment.Horizontal = Alignment.Start, hideKeyboardOnDrag: Boolean = true, onFormEvent: (SealedFormEvents) -> Unit? = null, form: Form = LocalForm.current, fieldView: @Composable (field: Field<*>) -> Unit = { field -> DefaultFieldView(field) })

fromToken

fun ColorScheme.fromToken(value: ColorSchemeKeyTokens): Color

harmonizedWarning

@Composable

actual fun harmonizedWarning(isDarkTheme: Boolean): Color

@Composable

expect fun harmonizedWarning(isDarkTheme: Boolean = isSystemInDarkTheme()): Color

@Composable

actual fun harmonizedWarning(isDarkTheme: Boolean): Color

kotoseFormStyle

@Composable

fun kotoseFormStyle(): KotoseFormStyle

The style in effect: the override from KotoseFormTheme, or the current Material look.

KotoseFormTheme

@Composable

fun KotoseFormTheme(style: KotoseFormStyle, content: @Composable () -> Unit)

Applies style to every form renderer below it.

LabelCheckBox

@Composable

fun LabelCheckBox(selected: Boolean, onClick: () -> Unit, label: String, modifier: Modifier = Modifier, colors: FieldColors = FieldDefaults.fieldColors(), textStyle: TextStyle = LocalTextStyle.current, enabled: Boolean = true, subtitle: String? = null)

LabelRadioButton

@Composable

fun LabelRadioButton(selected: Boolean, onClick: () -> Unit, label: String, modifier: Modifier = Modifier, colors: FieldColors = FieldDefaults.fieldColors(), textStyle: TextStyle = LocalTextStyle.current, enabled: Boolean = true, subtitle: String? = null)

phoneNumberOutputTransformation

fun phoneNumberOutputTransformation(country: Country): OutputTransformation

Formats the national number as it is typed; without a PhoneNumberBackend it shows the digits.

toColor

@Composable

@ReadOnlyComposable

fun ColorSchemeKeyTokens.toColor(): Color