Crate sauron

Sauron is an web framework for creating fast and interactive client side web application, as well as server-side rendering for back-end web applications.

Re-exports

• pub use sauron_core::web_sys;
• pub use sauron_core::wasm_bindgen;
• pub use sauron_core::wasm_bindgen_futures;
• pub use sauron_core::js_sys;
• pub use sauron_core::mt_dom;

Modules

• cmd
  provides functionalities for commands to be executed by the system, such as when the application starts or after the application updates.
• dom
  This module provides functionalities for manipulating the actual Document Object Model in the browser
• events
  Create events Object
• html
  Provides functions and macros to build html elements
• prelude
  reexport prelude from sauron core
• svg
  Provides functions and macros to build svg elements
• units
  provides function and macro for html units such as px, %, em, etc.

Macros

• jss
  Creates css using json notation
• jss_ns
  Create a css string using json notation and use namespace on the class selectors
• jss_ns_pretty
  create css using jss with namespace macro with correct indentions
• jss_pretty
  Create css using jss macro with nice indentions
• node
  Quasi-quoting macro for building sauron Nodes.

Structs

• AnimationEvent
  The AnimationEvent class.
• Callback
  A generic wrapper for a closure in rust where we can transform and pass around.
• CreatedNode
  A node along with all of the closures that were created for that node’s events and all of it’s child node’s events.
• DomPatch
  a Patch where the virtual nodes are all created in the document. This is necessary since the CreatedNode 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.
• HashChangeEvent
  The HashChangeEvent class.
• Http
  Provides functions for doing http network request
• InputEvent
  a custom InputEvent to contain the input string value
• KeyboardEvent
  The KeyboardEvent class.
• Measurements
  Contains the time it took for the last app update call for the component TODO: Maybe rename to Diagnostics
• MountEvent
  an event when a virtual Node is mounted the field node is the actual dom node where the virtual Node is created in the actual dom
• MouseEvent
  The MouseEvent class.
• Program
  Program handle the lifecycle of the APP
• TouchEvent
  The TouchEvent class.
• TransitionEvent
  The TransitionEvent class.
• Window
  Provides access to the Browser window

Enums

• Event
  Map the Event to DomEvent, which are browser events
• MountAction
  specify how the App is mounted to the DOM
• MountTarget
  specify whether to attach the Node in shadow_root
• PatchVariant
  patch variant

Constants

• HTML_EVENTS
  html events

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.
• Container
  A Container have children that is set from the parent component
• CustomElement
  a trait for implementing CustomElement in the DOM with custom tag
• Dispatch
  This trait is used in the DomUpdater to call the dispatch method when an event occured
• Render
  render node, elements to a writable buffer

Functions

• async_delay
  simulate a delay using promise in js
• body
  provides access to the document body
• clear_timeout_with_handle
  cancel the execution of a delayed closure
• delay_exec
  execute with a timeout delay
• diff
  This is a sauron html specific functionality diff 2 nodes with attribute using &'static str instead of generic ATT
• document
  provides access to the document element
• history
  utility function which returns the history api of the browser
• now
  return the instantaneous time
• on
  an event builder
• on_animationend
  attach an on_animationend event to the html element
• on_auxclick
  attach an on_auxclick event to the html element
• on_blur
  attach an on_blur event to the html element
• on_broadcast
  attach an on_broadcast event to the html element
• on_change
  attach an on_change event to the html element
• on_checked
  attach an on_checked event to the html element
• on_click
  on click event
• on_contextmenu
  attach an on_contextmenu event to the html element
• on_dblclick
  attach an on_dblclick event to the html element
• on_doubleclick
  attach an on_doubleclick event to the html element
• on_enter
  custom on_enter event, which is triggered from key_press when the Enter key is pressed
• on_focus
  attach an on_focus event to the html element
• on_hashchange
  attach an on_hashchange event to the html element
• on_input
  attach an on_input event to the html element
• on_keydown
  attach an on_keydown event to the html element
• on_keypress
  attach an on_keypress event to the html element
• on_keyup
  attach an on_keyup event to the html element
• on_mount
  custom mount event
• on_mousedown
  attach an on_mousedown event to the html element
• on_mouseenter
  attach an on_mouseenter event to the html element
• on_mouseleave
  attach an on_mouseleave event to the html element
• on_mousemove
  attach an on_mousemove event to the html element
• on_mouseout
  attach an on_mouseout event to the html element
• on_mouseover
  attach an on_mouseover event to the html element
• on_mouseup
  attach an on_mouseup event to the html element
• on_pointerlockchange
  attach an on_pointerlockchange event to the html element
• on_pointerlockerror
  attach an on_pointerlockerror event to the html element
• on_popstate
  attach an on_popstate event to the html element
• on_readystatechange
  attach an on_readystatechange event to the html element
• on_reset
  attach an on_reset event to the html element
• on_scroll
  attach callback to the scroll event
• on_select
  attach an on_select event to the html element
• on_submit
  attach an on_submit event to the html element
• on_toggle
  attach an on_toggle event to the html element
• on_touchend
  attach an on_touchend event to the html element
• on_touchmove
  attach an on_touchmove event to the html element
• on_touchstart
  attach an on_touchstart event to the html element
• on_transitionend
  attach an on_transitionend event to the html element
• on_wheel
  attach an on_wheel event to the html element
• performance
  provides access to the window Performance api
• register_custom_element
• request_animation_frame
  utility function which a closure in request animation frame
• spawn_local
  Runs a Rust Future on the current thread.
• window
  utility function which returns the Window element

Type Definitions

• Attribute
  Attribute type used in sauron where the type of the Attribute name is &’static str
• Cmd
  alias Cmd to use Program as the APP
• Element
  Element type with tag and attribute name type set to &’static str
• Listener
  Callback where Event type is supplied for Components
• Node
  A simplified version of saurdon_vdom node, where we supplied the type for the tag which is a &’static str. The missing type is now only MSG which will be supplied by the users App code.
• Patch
  Patch as result of diffing the current_vdom and the new vdom. The tag and attribute name types is set to &’static str