Form.Field

Field type and helper functions

Field

type Field

= StringField_ StringField

| MultiStringField_ MultiStringField

| BoolField_ BoolField

| NumericField_ NumericField

type StringField

= SimpleField SimpleFieldProperties

| DateField DateFieldProperties

| SelectField (SelectFieldProperties {})

| SearchableSelectField SearchableSelectFieldProperties

| HttpSelectField HttpSelectFieldProperties

| RadioField RadioFieldProperties

type MultiStringField

= MultiSelectField (MultiSelectFieldProperties {})

| SearchableMultiSelectField SearchableMultiSelectFieldProperties

| MultiHttpSelectField MultiHttpSelectFieldProperties

| TagField (TagFieldProperties {})

type BoolField

= CheckboxField CheckboxFieldProperties

| RadioBoolField RadioBoolFieldProperties

| RadioEnumField RadioEnumFieldProperties

type NumericField

= AgeField AgeFieldProperties

text :

StringFieldProperties

{ regexValidation : List RegexValidation }

-> Field

email :

StringFieldProperties

{ forbiddenDomains : List ForbiddenDomain }

-> Field

dateOfBirth : StringFieldProperties {} -> Field

datePast : StringFieldProperties {} -> Field

dateFuture : StringFieldProperties {} -> Field

phone :

StringFieldProperties

{ regexValidation : List RegexValidation }

-> Field

url :

StringFieldProperties

{ regexValidation : List RegexValidation }

-> Field

textarea :

StringFieldProperties

{ regexValidation : List RegexValidation }

-> Field

checkbox : BoolFieldProperties {} -> Field

radioBool : RadioBoolFieldProperties -> Field

radioEnum : RadioEnumFieldProperties -> Field

select : SelectFieldProperties {} -> Field

searchableSelect : SearchableSelectFieldProperties -> Field

httpSelect : HttpSelectFieldProperties -> Field

multiSelect : MultiSelectFieldProperties {} -> Field

searchableMultiSelect : SearchableMultiSelectFieldProperties -> Field

multiHttpSelect : MultiHttpSelectFieldProperties -> Field

radio : RadioFieldProperties -> Field

age : AgeFieldProperties -> Field

tag : TagFieldProperties {} -> Field

Properties

type alias AgeFieldProperties =

FieldProperties { value : Maybe Int }

type alias CommonFieldProperties =

FieldProperties {}

type alias DateFieldProperties =

StringFieldProperties

{ tipe : DateFieldType

, parsedDate : Maybe Posix

}

type alias SimpleFieldProperties =

StringFieldProperties

{ tipe : SimpleFieldType

, regexValidation : List RegexValidation

}

type alias SelectFieldProperties a =

StringFieldProperties

{ a

| default : Maybe String

, options : List Option

, placeholder : String

, hasSelectablePlaceholder : Bool

}

type alias SearchableSelectFieldProperties =

SelectFieldProperties

{ showDropdown : Bool

, searchInput : String

}

type alias HttpSelectFieldProperties =

StringFieldProperties

{ url : String

, default : Maybe String

, options : RemoteData (Error String) (List Option)

, placeholder : String

, hasSelectablePlaceholder : Bool

}

type alias MultiSelectFieldProperties a =

MultiStringFieldProperties

{ a

| placeholder : String

, showDropdown : Bool

, options : List Option

}

type alias SearchableMultiSelectFieldProperties =

MultiSelectFieldProperties

{ searchableOptions : List Option

, searchInput : String

}

type alias MultiHttpSelectFieldProperties =

MultiStringFieldProperties

{ placeholder : String

, showDropdown : Bool

, url : String

, options : RemoteData (Error String) (List Option)

}

type alias RadioFieldProperties =

StringFieldProperties

{ default : Maybe String

, options : List Option

, direction : Direction

}

type alias BoolFieldProperties a =

FieldProperties { a | value : Bool }

type alias CheckboxFieldProperties =

BoolFieldProperties { tipe : CheckboxFieldType }

type alias RadioBoolFieldProperties =

FieldProperties { value : Maybe Bool }

type alias RadioEnumFieldProperties =

FieldProperties

{ value : Maybe Value

, default : Maybe Value

, options : List Value

}

type alias StringFieldProperties a =

FieldProperties { a | value : String }

type alias TagFieldProperties a =

MultiStringFieldProperties

{ a | inputBar : String, placeholder : Maybe String }

Getters

getBoolProperties : Field -> Maybe Bool

getEnabledBy : Field -> Maybe String

getUnhiddenBy : Field -> Maybe String

getLabel : Field -> String

getNumericValue : Field -> Maybe Int

getOrder : Field -> Int

getProperties : Field -> CommonFieldProperties

getStringType : StringField -> StringFieldType

getStringValue : Field -> Maybe String

getStringValue_ : StringField -> String

getParsedDateValue_ : StringField -> Maybe Posix

getMultiStringValue_ : MultiStringField -> Set String

getType : Field -> FieldType

getUrl : Field -> Maybe String

getWidth : Field -> Width

Setters

resetValueToDefault : Field -> Field

setRequired : IsRequired -> Field -> Field

updateBoolValue : Bool -> Field -> Field

updateCheckboxValue_ : Bool -> BoolField -> BoolField

updateNumericValue : String -> Field -> Field

updateNumericValue_ : Maybe Int -> NumericField -> NumericField

updateRadioBoolValue : Maybe Bool -> Field -> Field

updateRadioBoolValue_ : Maybe Bool -> BoolField -> BoolField

updateRadioEnumValue : Maybe Value -> Field -> Field

updateRadioEnumValue_ : Maybe Value -> BoolField -> BoolField

updateRemoteOptions : RemoteData (Error String) (List Option) -> Field -> Field

updateStringValue : String -> Field -> Field

updateParsedDateValue : Posix -> StringField -> StringField

updateStringDisabled : Bool -> Field -> Field

updateStringHidden : Bool -> Field -> Field

updateMultiStringOption : Option -> Bool -> Field -> Field

updateStringValue_ : String -> StringField -> StringField

updateStringDisabled_ : Bool -> StringField -> StringField

updateStringHidden_ : Bool -> StringField -> StringField

updateMultiStringValue_ : Set String -> MultiStringField -> MultiStringField

updateShowDropdown : Bool -> Field -> Field

maybeUpdateStringValue : Maybe String -> Field -> Field

Keep existing field if the value is Nothing

updateSearchableSelectInput : String -> Field -> Field

updateTagsInputBarValue : String -> Field -> Field

updateTagsValue : Bool -> String -> Field -> Field

updateTagsValue_ : Bool -> String -> MultiStringField -> MultiStringField

Predicates

isCheckbox : Field -> Bool

isColumn : Field -> Bool

isNumericField : Field -> Bool

isRequired : Field -> IsRequired

Encode

encode : Field -> Value

Metadata

metadataKey : String -> Maybe String

canceraiddev/elm-form-builder/15.0.0

Form.Field

Field

Properties

Getters

Setters

Predicates

Encode

Metadata

Modules