Messenger.Component.PortableComponent

Portable components

These are components that might be provided by an elm package.

There are some limitations for portable components:

They don't have the base data
They cannot get the common data
You need to set the msg and target type for every portable component
You need to provide a codec in the layer to translate the messages and targets

type alias ConcretePortableComponent data userdata tar msg scenemsg =

{ init : PortableComponentInit userdata msg data

, update : PortableComponentUpdate data userdata tar msg scenemsg

, updaterec :

PortableComponentUpdateRec data userdata tar msg scenemsg

, view : PortableComponentView userdata data

, matcher : Matcher data tar

}

ConcretePortableComponent

Used when createing a portable component.

Use translatePortableComponent to create a ConcreteUserComponent from a ConcretePortableComponent.

Portable components still keep the scene-message type parameter, so they can pass through parent/system messages such as SOMMsgs after translation.

type alias PortableMsgCodec specificmsg generalmsg =

{ encode : generalmsg -> specificmsg

, decode : specificmsg -> generalmsg

}

Portable Component Message Codec

type alias PortableTarCodec specifictar generaltar =

{ encode : generaltar -> specifictar

, decode : specifictar -> generaltar

}

Portable Component Target Codec

You can generate a general type of component from a concrete portable component, which means you can manage this component with a list of user components.

genPortableComponent :

ConcretePortableComponent data userdata tar msg scenemsg

-> PortableTarCodec tar gtar

-> PortableMsgCodec msg gmsg

-> bdata

-> Int

-> PortableComponentStorage

cdata

userdata

gtar

gmsg

bdata

scenemsg

Generate abstract component from concrete component.

Type sugar

type alias PortableComponentInit userdata msg data =

Runtime -> Env () userdata -> msg -> data

Portable component init type sugar

type alias PortableComponentUpdate data userdata tar msg scenemsg =

Runtime

-> Env () userdata

-> UserEvent

-> data

-> ( data

, List (MMsg tar msg scenemsg userdata)

, ( Env () userdata, Bool )

)

Portable component update type sugar

type alias PortableComponentUpdateRec data userdata tar msg scenemsg =

Runtime

-> Env () userdata

-> msg

-> data

-> ( data

, List (MMsg tar msg scenemsg userdata)

, Env () userdata

)

Portable component updaterec type sugar

type alias PortableComponentView userdata data =

Runtime -> Env () userdata -> data -> Renderable

Portable component view type sugar

type alias PortableComponentStorage cdata userdata gtar gmsg bdata scenemsg =

gmsg

-> Runtime

-> Env cdata userdata

-> AbstractComponent cdata userdata gtar gmsg bdata scenemsg

Portable component storage as a specific component type sugar

linsyking/messenger-extra/7.0.0

Messenger.Component.PortableComponent

Portable components

Type sugar

Modules

Core Extension

Misc

GlobalComponents