iw-support-ui-forms
API
Generated with
iw-support-ui-forms/works.iterative.ui/works.iterative.ui.model.forms

works.iterative.ui.model.forms

package works.iterative.ui.model.forms

Members list

Type members

Classlikes

sealed trait AbsolutePath extends IdPath

Attributes

Supertypes
trait IdPath
class Object
trait Matchable
class Any
Known subtypes
class FullPath
object Root
trait FormState

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait IdPath

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AbsolutePath
class FullPath
object Root
trait RelativePath
object Empty
class RelPath
Show all
object IdPath

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
IdPath.type
sealed trait RelativePath extends IdPath

Attributes

Supertypes
trait IdPath
class Object
trait Matchable
class Any
Known subtypes
object Empty
class RelPath
final case class UIBlock(id: UIFormId, messageKey: UIMessageKey) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIButton(id: UIFormId, name: UIFieldName, intent: UIButtonIntent, messageKey: UIMessageKey, decorations: List[UIFieldDecoration]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum UIButtonIntent

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIChoiceField(id: UIFormId, fieldName: UIFieldName, rawValue: Option[String], values: List[UIChoiceOption], decorations: List[UIFieldDecoration]) extends UIField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait UIField
class Object
trait Matchable
class Any
Show all
final case class UIChoiceOption(id: UIFormId, value: String, messageKey: UIMessageKey)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait UIField

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class UIFileField
class UITextField
enum UIFieldDecoration

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIFileField(id: UIFormId, fieldName: UIFieldName, fileList: Option[List[UIFile]], multiple: Boolean, decorations: List[UIFieldDecoration]) extends UIField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait UIField
class Object
trait Matchable
class Any
Show all
final case class UIFlexRow(children: Seq[UIFormElement]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIForm(id: UIFormId, messageKey: UIMessageKey, children: Seq[UIFormElement], data: FormState, context: Option[Map[String, String]], errors: List[UserMessage] = ...)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait UIFormElement

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class UIBlock
class UIButton
class UIFlexRow
class UIGrid
Show all
final case class UIFormSection(id: UIFormId, level: Int, messageKey: UIMessageKey, children: Seq[UIFormElement], decorations: List[UIFieldDecoration], repeatIndex: Option[Int]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIGrid(children: Seq[Seq[UIGridCell]]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIGridCell(size: Int, children: Seq[UIFormElement])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIHiddenField(id: UIFormId, fieldName: UIFieldName, value: Option[String]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UILabeledField(id: UIFormId, messageKey: UIMessageKey, field: UIField, decorations: List[UIFieldDecoration]) extends UIFormElement

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIRepeatedGroup(id: UIFormId, fieldName: UIFieldName, templates: List[String], optional: Boolean, rows: Seq[UIRepeatedRow], decorations: List[UIFieldDecoration]) extends UIFormElement

A repeated group with its row boundaries intact: fieldName is the hidden field the item list round-trips through, templates are the item types that can be added, and optional says whether the group may be empty — enough for any interpreter to derive add/remove affordances.

A repeated group with its row boundaries intact: fieldName is the hidden field the item list round-trips through, templates are the item types that can be added, and optional says whether the group may be empty — enough for any interpreter to derive add/remove affordances.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UIRepeatedRow(item: String, itemType: String, index: Int, children: Seq[UIFormElement])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class UITextField(id: UIFormId, fieldName: UIFieldName, fieldType: UIFieldType, rawValue: Option[String], decorations: List[UIFieldDecoration]) extends UIField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait UIField
class Object
trait Matchable
class Any
Show all

Types

type UIButtonIcon = String
type UIFieldName = String
type UIFieldType = String
type UIFile = String | FileRef
type UIFormId = IdPath
type UIMessageKey = MessageId
Generated with