Module sauron::prelude

source ·
Expand description

prelude

Modules

  • dom
    This module provides functionalities for manipulating the actual Document Object Model in the browser
  • html
    Provides functions and macros to build html elements
  • js_sys
    Bindings to JavaScript’s standard, built-in objects, including their methods and properties.
  • mt_dom
    mt-dom is a generic virtual dom implementation which doesn’t specify the types of the data that is being processed. It’s up to the library user to specify those types
  • prelude
    prelude
  • serde_wasm_bindgen
    This is a native integration of Serde with wasm-bindgen. It allows to convert Rust data types into native JavaScript types and vice versa.
  • svg
    Provides functions and macros to build svg elements
  • vdom
    vdom stands for virtual-dom. This module contains types that are derived from mt-dom where we assign concrete types into the generics.
  • wasm_bindgen
    Runtime support for the wasm-bindgen tool
  • wasm_bindgen_futures
    Converting between JavaScript Promises to Rust Futures.
  • web_sys
    Raw API bindings for Web APIs

Macros

  • declare_attributes
    declare a function with the name corresponds to attribute name for easy usage in html elements Example:
  • jss
    build a css string
  • jss_with_media
    build css string that has media selector or any other conditional group
  • key
    creates a key attribute using a formatter
  • style
    build a style attribute
  • text
    creates a text node using a formatter

Structs

  • AnimationEvent
    The AnimationEvent class.
  • AnimationFrameHandle
    request animation frame handle
  • Callback
    A generic wrapper for a closure in rust where we can transform and pass around.
  • Closure
    A handle to both a closure in Rust as well as JS closure which will invoke the Rust closure.
  • Cmd
    Cmd 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. Cmd 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.
  • 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.
  • FocusEvent
    The FocusEvent class.
  • HashChangeEvent
    The HashChangeEvent class.
  • InputEvent
    TODO: expand this much farther by getting the InputEvent data, data_transfer, event_type, is_composing events. a custom InputEvent to contain the input string value
  • JsError
    Convenience type for use on exported fn() -> Result<T, JsError> functions, where you wish to throw a JavaScript Error object.
  • JsValue
    Representation of an object owned by JS.
  • 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
  • Selection
    The Selection class.
  • Task
    Task is used to do asynchronous operations
  • TimeoutCallbackHandle
    handle for request_idle_callback calls
  • TouchEvent
    The TouchEvent class.
  • TransitionEvent
    The TransitionEvent class.
  • TreePath
    Describe the path traversal of a Node starting from the root node
  • WebComponentWrapper
    A self contain web component This is needed to move some of the code from the #custom_element macro This is also necessary, since #[wasm_bindgen] macro can not process impl types which uses generics, we use generics here to simplify the code and do the type checks for us, rather than in the code derived from the #[web_component] macro

Enums

Constants

  • HTML_ATTRS
    These are most commonly used html attributes such as class, id, etc
  • HTML_EVENTS
    html events
  • HTML_TAGS
    These are the comonly used html tags such as div, input, buttons,.. etc
  • SVG_ATTRS
    These are most commonly used svg attributes
  • SVG_ATTRS_SPECIAL
    These are svg attributes with names that are non proper rust identifier therefore they are handled differently. ie: (color-profile, accent-height, etc)
  • SVG_ATTRS_XLINK
    Svg attributes with xlink namespace
  • SVG_TAGS
    These are the commonly used svg tags such as rect, circle, path, arc, ..etc.
  • SVG_TAGS_SPECIAL
    These are svg tags which the tags are non proper rust identifier, so they are handled differently

Traits

  • Application
    An Application is the root component of your program. Everything that happens in your application is done here.
  • AttributeMapMsg
    Add mapping function for Attribute
  • Component
    A component has a view and can update itself.
  • Container
    A Container have children that is set from the parent component
  • ElementMapMsg
    Add mapping function for Element
  • JsCast
    A trait for checked and unchecked casting between JS types.
  • NodeMapMsg
    Add mapping function for Node, Element, Attribute,
  • NodeTrait
    additional traits for mt_dom::Node
  • Render
    render node, elements to a writable buffer
  • UnwrapThrowExt
    An extension trait for Option<T> and Result<T, E> for unwrapping the T value, or throwing a JS error if it is not available.
  • WebComponent
    a trait for implementing WebComponent in the DOM with custom tag

Functions

Type Aliases

  • Attribute
    Attribute type used in sauron where the type of the Attribute name is &’static str
  • 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

Attribute Macros