Core

This library tries to address the following issues in building

Gives default styles for all elements in an interactive virtual CS experiment.
Gives readymade history support with as less code rewriting as possible using elm-community/undo-redo
Extends the functionality of undo-redo package by adding support for commands and subscriptions
A ready to use logger via ports which logs all states

Wrapper Functions

init :

(state -> loggableState)

-> (Value -> Cmd (Msg msg))

-> (flags -> ( state, Cmd msg ))

-> flags

-> ( UndoList state, Cmd (Msg msg) )

Init is a wrapper function that maps the original application's init function to new types It also logs the init action

view : (state -> Html msg) -> UndoList state -> Html (Msg msg)

View is the wrapper function that maps the original application's view function to new type. It also adds the default undo/redo/reset control buttons to the UI.

update :

(state -> loggableState)

-> (Value -> Cmd (Msg msg))

-> (msg -> state -> ( state, Cmd msg ))

-> (msg -> Bool)

-> Maybe Int

-> Maybe (UndoListCmds msg)

-> Msg msg

-> UndoList state

-> ( UndoList state, Cmd (Msg msg) )

Update is a wrapper function which adds undo,redo,reset to an updater. This function also logs the action and the newState via sharing it over the port. The function takes logger, port for analytics, original update function, freshStateSetter, undoCount, undoListCommands. The function returns a new partial function which replaces the original update in your application's main function

The details about the arguements

logger : maps the program state to a loggable output. For no mapping identity function can be used
analyticsPort : the port through which the telemetry data needs to be shared
orginal update function : Handlles the updates specific to your application
freshStateSetter : A function that sets a fresh state (see undo-redo package) if the result is true.
undoCount : Handles cases where a number of steps need to be undoed (useful when the messages are chained)
undoListCommands : Tuple of commands which will be executed when undo/redo/reset is encountered

NOTE : Last three parameters are of Maybe type so you can pass Nothing if you don't wish to use them.

subscriptions : (state -> Sub msg) -> UndoList state -> Sub (Msg msg)

Subscriptions is a wrapper function that maps the original application's subscriptions to the new types.

Example

A very basic example which should suit most basic cases

-- import the package into your app and update the main function with the following
Browser.element
{ init = Core.init identity analyticsPort init
, view = Core.view view
, update = Core.update identity analyticsPort update setFresh Nothing Nothing
, subscriptions = Core.subscriptions subscriptions
}

For using advanced features visit the Readme.md file.

Limitations

The library does not support Browser.Document and Browser.Application since it was not required in the present usecase.

algodynamics-iiith/core/1.0.0

Core

Wrapper Functions

Example

Limitations

Modules