EngageSoftware / elm-engage-common / Engage.Form.Address

Form.Address


type alias Attribute =
InternalAttribute -> InternalAttribute

The Attribute type


type Msg field

The Msg type


type State parentField

The State type


type ValidationField
    = Name
    | Address
    | Unit
    | Country
    | Region
    | ZipCode
    | City
    | AddressType
    | Phone
    | PhoneIsoCode
    | Fax
    | FaxIsoCode
    | Website
    | IsPrimaryAddress
    | IncludeInExternalDirectory
    | IncludeInInternalDirectory

The ValidationField type

addressTypes : Engage.Entity.Address.AddressTypes -> Attribute

Get the address types Attribute

completedView : { a | namespace : Engage.Namespace.Namespace, localization : Engage.Localization.Localization } -> Engage.Entity.Address.Address -> Html msg

Get the completed view

completedViewWithAdditional : { a | namespace : Engage.Namespace.Namespace, localization : Engage.Localization.Localization } -> List String -> Engage.Entity.Address.Address -> Html msg

Get the completed view with additional

countriesToItems : Engage.Entity.Address.Countries -> Dict String Engage.UI.Dropdown.Item

Convert Countries to items dropdown

form : Engage.Namespace.Namespace -> Engage.Localization.Localization -> (ValidationField -> parentField) -> String -> List Attribute -> State parentField -> Engage.Form.HideOrShow.HideOrShow -> Engage.Entity.Address.Address -> Html (Msg parentField)

Get the form view

initialState : State parentField

Get the initial State

isEmpty : Engage.Entity.Address.AddressLike a -> Basics.Bool

Check if the address is empty

isValid : State parentField -> Basics.Bool

Check if the state is valid

regionsToItems : Engage.Entity.Address.Regions -> Dict String Engage.UI.Dropdown.Item

Convert Regions to items dropdown

toAllRegions : Engage.Entity.Address.RegionsCountry -> Engage.Entity.Address.Regions

Convert RegionsCountry to Regions

update : Msg parentField -> State parentField -> Engage.Entity.Address.Address -> { state : State parentField, data : Engage.Entity.Address.Address, cmd : Platform.Cmd.Cmd (Msg parentField) }

Update the address

validateAll : (ValidationField -> parentField) -> String -> State parentField -> Engage.Entity.Address.RegionsCountry -> Engage.Entity.Address.Address -> State parentField

Validate all fields

validateAllWith : List (Validate.Validator ( parentField, Engage.Validation.ValidationStatus ) Engage.Entity.Address.Address) -> (ValidationField -> parentField) -> String -> State parentField -> Engage.Entity.Address.RegionsCountry -> Engage.Entity.Address.Address -> State parentField

Validate all fields with a function

validateFieldWith : List (Validate.Validator ( parentField, Engage.Validation.ValidationStatus ) Engage.Entity.Address.Address) -> (ValidationField -> parentField) -> String -> Engage.Entity.Address.RegionsCountry -> Engage.Entity.Address.Address -> Engage.Validation.ValidationErrors parentField

Validate a field with a function

view : { a | namespace : Engage.Namespace.Namespace, localization : Engage.Localization.Localization, countries : Engage.Entity.Address.Countries, regions : Engage.Entity.Address.RegionsCountry } -> Engage.Entity.Address.AddressLike address -> Html msg

Get the view

Attributes

countries : Engage.Entity.Address.Countries -> Attribute

Get the countries Attribute

hideFax : Attribute

Get the hide fax Attribute

hideAddressName : Attribute

Get the hide address name Attribute

hideAddressPhone : Attribute

Get the hide address phone Attribute

hidePrimaryAddressCheckbox : Attribute

Get the hide primary address checkbox Attribute

hideWebsite : Attribute

Get the hide website Attribute

regions : Engage.Entity.Address.RegionsCountry -> Attribute

Get the regions Attribute

required : Basics.Bool -> Attribute

Get the required Attribute

showIncludeInExternalDirectory : Attribute

Get the show include in external directory Attribute

showIncludeInInternalDirectory : Attribute

Get the show include in internal directory Attribute

phoneNumberRequired : Basics.Bool -> Attribute

Get the phone number required Attribute

countryModifier : { a | country : Maybe Engage.ListItem.ListItem } -> String

Get the country modifier