Module sauron::prelude::dom

This module provides functionalities for manipulating the actual Document Object Model in the browser

Modules

• dispatch
  provides functionalities for commands to be executed by the system, such as when the application starts or after the application updates.
• skip_diff
• util
  utility functions

Structs

• AnimationFrameHandle
  request animation frame handle
• Cmd
  Cmd is a way to tell the Runtime that something needs to be executed
• Dispatch
  Dispatch is a command to be executed by the system. This is returned at the init function of a component and is executed right after instantiation of that component. Dispatch required a DSP object which is the Program as an argument The emit function is called with the program argument. The callback is supplied with the program an is then executed/emitted.
• Document
  Provides function for document related functions
• DomAttr
  a dom version of the Attribute, thereby removing the MSG generic
• DomNode
  A counter part of the vdom Node This is needed, so that we can
• DomPatch
  a Patch where the virtual nodes are all created in the document. This is necessary since the created Node doesn’t contain references as opposed to Patch which contains reference to the vdom, which makes it hard to be included in a struct
• Effects
  Effects is a convenient way to group Msg for component to execute subsequent updates based on certain conditions. This can be used for doing animation and incremental changes to the view to provide an effect of transition or animation.
• GroupedDomAttrValues
  a struct where the listeners, plain values, styles and function call values are grouped separately
• Http
  Provides functions for doing http network request
• Measurements
  Contains the time it took for the last app update call for the component TODO: Maybe rename to Diagnostics
• MountProcedure
  specify how the root node will be mounted to the mount node
• Program
  Program handle the lifecycle of the APP
• SkipDiff
  if the expression evaluates to true, diffing at this node will be skipped entirely
• SkipPath
  combination of TreePath and SkipDiff
• StatefulModel
  Wrapper for stateful component
• StatelessModel
  Contains necessary information for creating template of the Component of this type_id
• Time
  Provides function related to Time
• TimeoutCallbackHandle
  handle for request_idle_callback calls
• Window
  Provides function for window related functions

Enums

• DomAttrValue
  a dom version of the Attribute value, thereby removing the MSG generic
• Event
  Map the Event to DomEvent, which are browser events
• IdleCallbackHandle
• IdleDeadline
  Idle deadline interface which could be the real idle deadline if supported, otherwise the polyfill
• MountAction
  specify how the App is mounted to the DOM
• MountTarget
  specify whether to attach the Node in shadow_root
• PatchVariant
  patch variant

Traits

• Application
  An Application is the root component of your program. Everything that happens in your application is done here.
• Component
  A component has a view and can update itself.
• StatefulComponent
  A component that can be used directly in the view without mapping

Functions

• component
  create a stateless component node
• delay
  wrapper of async delay but return no result, assume success
• document
  provides access to the document element
• history
  utility function which returns the history api of the browser
• inject_style
  inject style to document head
• now
  return the instantaneous time
• performance
  provides access to the window Performance api
• request_animation_frame
  utility function which a closure in request animation frame
• request_idle_callback
  request idle callback
• request_timeout_callback
  request and idle callback
• skip_if
  skip diffing the node is the val is true
• spawn_local
  Runs a Rust Future on the current thread.
• stateful_component
  create a stateful component node
• window
  utility function which returns the Window element