Copyright	(C) 2016-2026 David M. Johnson (@dmjio)
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <code@dmj.io>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.Runtime.Internal

Description

This is an internal module not meant for consumption during application development. This is primarily meant to give user's access to the global component state for testing. Use at your own risk. You have been warned.

We currently consume this module for the miso integration testing package miso-tests.

Alterations to these global variables *will* break your application. Again, do not use these in your main application, only use with the miso testing framework to test your application.

Synopsis

components :: IORef (IntMap (ComponentState parent props model action))
componentIds :: IORef Int
rootComponentId :: ComponentId
data ComponentState parent props model action = ComponentState {
- _componentId :: ComponentId
- _componentParentId :: ComponentId
- _componentProps :: props
- _componentSubThreads :: IORef (Map MisoString ThreadId)
- _componentDOMRef :: DOMRef
- _componentVTree :: IORef VTree
- _componentSink :: action -> IO ()
- _componentModel :: model
- _componentIsDirty :: Bool
- _componentScripts :: [DOMRef]
- _componentEvents :: Events
- _componentBindings :: [Binding parent model]
- _componentMailbox :: Value -> Maybe action
- _componentDraw :: model -> IO ()
- _componentModelDirty :: model -> model -> Bool
- _componentApplyActions :: [action] -> model -> IntMap (ComponentState parent props model action) -> props -> (IntMap (ComponentState parent props model action), model, [Schedule action], ComponentIds)
- _componentTopics :: Map MisoString (Value -> IO ())
- _componentChildren :: ComponentIds
}

Documentation

components :: IORef (IntMap (ComponentState parent props model action)) Source #

componentMap

This is a global Component Map that holds the state of all currently mounted Components

componentIds :: IORef Int Source #

The global store of ComponentId, for internal-use only.

Used internally freshComponentId to allocate new ComponentId on mount.

rootComponentId :: ComponentId Source #

This is used to demarcate the ROOT of a page. This ID will *never* exist in the components map.

data ComponentState parent props model action Source #

Component state, data associated with the lifetime of a Component

Constructors

ComponentState

Fields

_componentId :: ComponentId
The ID of the current Component
_componentParentId :: ComponentId
The ID of the Component's parent
_componentProps :: props
The current props passed to this Component
_componentSubThreads :: IORef (Map MisoString ThreadId)
Mapping of all Sub in use by Component
_componentDOMRef :: DOMRef
The DOM reference the Component is mounted on
_componentVTree :: IORef VTree
A reference to the current virtual DOM (i.e. VTree)
_componentSink :: action -> IO ()
Component Sink used to enter events into the system
_componentModel :: model
Component state
_componentIsDirty :: Bool
Indicator if Component needs to be drawn
_componentScripts :: [DOMRef]
DOM references for <script> and <style> appended to <head>
_componentEvents :: Events
List of events a Component listens on
_componentBindings :: [Binding parent model]
Declarative bindings between Component model.
_componentMailbox :: Value -> Maybe action
Mailbox for asynchronous Component communication
_componentDraw :: model -> IO ()
Helper function for Component rendering
_componentModelDirty :: model -> model -> Bool
Model diffing
_componentApplyActions :: [action] -> model -> IntMap (ComponentState parent props model action) -> props -> (IntMap (ComponentState parent props model action), model, [Schedule action], ComponentIds)
Component actions application
_componentTopics :: Map MisoString (Value -> IO ())
Component topics using for Pub Sub async communication.
_componentChildren :: ComponentIds
IntSet of children ComponentId