kotose-form-core/io.github.robinpcrd.kotose.form.dsl

Package-level declarations

Types

annotation class FieldDslMarker

class FormBuilder

annotation class FormDslMarker

open class GroupBuilder

annotation class GroupDslMarker

interface IGroupBuilder

MultipleSelectionGroupBuilder

class MultipleSelectionGroupBuilder<ValueType> : SelectableGroupBuilder<ValueType>

SelectableGroupBuilder

abstract class SelectableGroupBuilder<ValueType> : GroupBuilder

SelectionGroupDslMarker

annotation class SelectionGroupDslMarker

SingleSelectionGroupBuilder

class SingleSelectionGroupBuilder<ValueType> : SelectableGroupBuilder<ValueType>

Functions

fun GroupBuilder.actionField(tag: String? = null, title: StrRes, init: ActionField.() -> Unit = {}, onClick: () -> Unit): ActionField

The trailing lambda is the click handler; configure the field through init.

fun GroupBuilder.dateTimePicker(tag: String? = null, placeholder: StrRes? = null, showPicker: () -> Unit? = null, formatter: (LocalDateTime) -> String = ::defaultDateTimeFormatter, iosPickerMode: IosDatePickerMode = IosDatePickerMode.Compact, init: DateTimeField.() -> Unit = {}): DateTimeField

displayParagraph

fun GroupBuilder.displayParagraph(tag: String? = null, lines: List<StrRes> = emptyList(), init: DisplayParagraphField.() -> Unit = {}): DisplayParagraphField

fun GroupBuilder.displayText(tag: String? = null, text: StrRes? = null, isTitle: Boolean = false, init: DisplayTextField.() -> Unit = {}): DisplayTextField

fun form(init: FormBuilder.() -> Unit): Form

fun FormBuilder.group(init: GroupBuilder.() -> Unit): Group

localDatePicker

fun GroupBuilder.localDatePicker(tag: String? = null, placeholder: StrRes? = null, formatter: (LocalDate) -> String = ::defaultLocalDateFormatter, showPicker: () -> Unit? = null, iosPickerMode: IosDatePickerMode = IosDatePickerMode.Compact, init: LocalDateField.() -> Unit = {}): LocalDateField

multipleSelectionGroup

fun <FieldType> FormBuilder.multipleSelectionGroup(init: MultipleSelectionGroupBuilder<FieldType>.() -> Unit): SelectionGroup.Multiple<FieldType>

secureTextField

fun GroupBuilder.secureTextField(tag: String? = null, label: StrRes? = null, placeholder: StrRes? = label, init: SecureTextField.() -> Unit = {}): SecureTextField

selectionOption

fun <ValueType> SelectableGroupBuilder<ValueType>.selectionOption(tag: String? = null, selectableValue: ValueType, labelForValue: StrRes? = null, init: SelectionOptionField<ValueType>.() -> Unit = {}): SelectionOptionField<ValueType>

singleChoiceField

fun <T> GroupBuilder.singleChoiceField(tag: String? = null, possibleValues: List<DropdownOption<T>>, placeholder: StrRes? = null, isClearable: Boolean = false, presentation: SelectionPresentation = SelectionPresentation.Menu, iosPresentation: SelectionPresentation? = null, init: SingleChoiceField<T>.() -> Unit = {}): SingleChoiceField<T>

singleSelectionGroup

fun <FieldType> FormBuilder.singleSelectionGroup(init: SingleSelectionGroupBuilder<FieldType>.() -> Unit): SelectionGroup.Single<FieldType>

fun GroupBuilder.textField(tag: String? = null, label: StrRes? = null, placeholder: StrRes? = label, lineLimits: TextLineLimits = TextLineLimits.SingleLine, init: TextField.() -> Unit = {}): TextField

fun GroupBuilder.toggleField(tag: String? = null, label: StrRes, init: ToggleField.() -> Unit = {}): ToggleField