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

Package-level declarations

Types

class ButtonField(tag: String? = null, val title: StrRes, val appearance: @Composable () -> ButtonFieldAppearance = ButtonFieldAppearance.Default, onClick: () -> Unit) : ActionField, ComposeField

ButtonFieldAppearance

@Immutable

data class ButtonFieldAppearance(val buttonStyle: ButtonFieldAppearance.ButtonStyle = ButtonStyle.BUTTON, val buttonColors: ButtonColors? = null, val textStyle: TextStyle? = null, val padding: PaddingValues? = null, val horizontalArrangement: Arrangement.Horizontal = Arrangement.End, val verticalAlignment: Alignment.Vertical = Alignment.Top, val width: ButtonFieldAppearance.ButtonWidth = ButtonWidth.WRAP_CONTENT, val shape: Shape? = null, val icon: PainterRes? = null, val iconSize: DpSize = DpSize(width = 24.dp, height = 24.dp), val spacerWidth: Dp = 8.dp)

Button field appearance

DropDownField

class DropDownField<T>(tag: String? = null, possibleValues: List<DropdownOption<T>>, placeholder: StrRes? = null, isClearable: Boolean = false) : SingleChoiceField<T> , ComposeField

ErrorField

open class ErrorField(tag: String? = null, defaultValue: StrRes? = null, asWarning: Boolean = false) : Field<StrRes> , ComposeField

IconButtonField

class IconButtonField(tag: String? = null, val icon: PainterRes, val contentDescription: StrRes? = null, val appearance: @Composable () -> IconButtonFieldAppearance = IconButtonFieldAppearance.Default, onClick: () -> Unit) : ActionField, ComposeField

Natively the icon is not available, so the description becomes the button title.

IconButtonFieldAppearance

@Immutable

data class IconButtonFieldAppearance(val iconSize: DpSize = DpSize(width = 24.dp, height = 24.dp), val iconPadding: PaddingValues? = null, val buttonPadding: PaddingValues? = null, val horizontalArrangement: Arrangement.Horizontal = Arrangement.Start, val verticalAlignment: Alignment.Vertical = Alignment.Top, val backgroundColor: Color = Color.Unspecified, val contentColor: Color = Color.Unspecified, val shape: Shape = RectangleShape, val border: BorderStroke? = null)

InputField

class InputField(tag: String? = null, label: StrRes? = null, placeholder: StrRes? = label, lineLimits: TextLineLimits = TextLineLimits.SingleLine, val appearance: @Composable () -> InputFieldAppearance = InputFieldAppearance.Default, trailingIconSlot: @Composable () -> Unit? = null) : TextField, ComposeField

Input field which can be used to get user input.

InputFieldAppearance

@Immutable

data class InputFieldAppearance(val colors: FieldColors, val textStyle: TextStyle, val clearable: Boolean = false, val readOnly: Boolean = false, val visualTransformation: VisualTransformation = VisualTransformation.None, val keyboardOptions: KeyboardOptions = KeyboardOptions.Default, val keyboardActions: KeyboardActions = KeyboardActions.Default, val leadingIconRes: PainterRes? = null, val trailingIconRes: PainterRes? = null, val autofillType: ContentType? = null)

LabelField

class LabelField(tag: String? = null, val defaultValue: StrRes? = null, val appearance: @Composable () -> LabelFieldAppearance = LabelFieldAppearance.Default, isTitle: Boolean = false) : DisplayTextField, ComposeField

LabelFieldAppearance

@Immutable

data class LabelFieldAppearance(val colors: FieldColors, val textStyle: TextStyle)

Label field appearance

ParagraphField

class ParagraphField(tag: String? = null, val appearance: @Composable () -> ParagraphFieldAppearance = ParagraphFieldAppearance.Default) : DisplayParagraphField, ComposeField

ParagraphFieldAppearance

@Immutable

data class ParagraphFieldAppearance(val colors: FieldColors, val textStyle: TextStyle, val linePrefix: String? = null, val backgroundColor: Color? = Color.Unspecified, val borderSize: Dp = 1.dp, val borderColor: Color = Color.Unspecified, val padding: PaddingValues = PaddingValues(8.dp), val cornerShape: Shape? = null, val width: ParagraphFieldAppearance.Width = Width.WrapContent)

Paragraph field appearance

PasswordField

class PasswordField(tag: String? = null, val label: StrRes? = null, val placeholder: StrRes? = label, val appearance: @Composable () -> InputFieldAppearance = InputFieldAppearance.DefaultPassword) : SecureTextField, ComposeField

PhoneCountryPicker

sealed interface PhoneCountryPicker

PhoneCountryPickerPresenter

actual class PhoneCountryPickerPresenter

expect class PhoneCountryPickerPresenter

actual class PhoneCountryPickerPresenter

PhoneField

class PhoneField(tag: String? = null, val placeholder: StrRes? = null, val appearance: @Composable () -> InputFieldAppearance = InputFieldAppearance.DefaultPhone) : PhoneNumberField, ComposeField

SelectableField

open class SelectableField<ValueType>(tag: String? = null, selectableValue: ValueType, defaultLabelForValue: StrRes? = null) : SelectionOptionField<ValueType> , ComposeField

A field that can be selected

SelectableFieldAppearance

@Immutable

data class SelectableFieldAppearance(val textColor: Color = Color.Unspecified, val labelTextStyle: TextStyle? = null, val tonalElevation: Dp = 0.dp, val startPadding: Dp = 0.dp)

SwitchField

class SwitchField(tag: String? = null, defaultLabel: StrRes, val appearance: @Composable () -> SwitchFieldAppearance = SwitchFieldAppearance.Default) : ToggleField, ComposeField

SwitchFieldAppearance

@Immutable

data class SwitchFieldAppearance(val colors: FieldColors, val labelTextStyle: TextStyle)

Functions

toColors

@Composable

fun SelectableFieldAppearance.toColors(): FieldColors