Crate perspective_viewer
source ·Modules§
componentscontains all YewComponenttypes, but only exports the 4 necessary for public Custom Elements. The rest are internal components of these 4.- A collection of (de-)serializable structs which capture the application state, suitable for persistence, history, etc. features.
- A catch all for project-wide macros and general-purpose functions that are not directly related to Perspective. Modules below
crate::utilsstrive to be single-responsibility, but some reference othercrate::utilsmodules when it helps reduce boiler-plate.
Macros§
- A macro for implementing the
wasm_bindgenboilerplate for types which implementserde::{Serialize, Deserialize}. - A macro which set a property called
weak_linkon the containerPropertieswhencfg(test), such that unit tests may send messages to a component. This macro needs to be called increate()on any Component which needs to receive messages in a test. - A macro which derives a
yew::Componentfor an arbitrary HTML snippet and mounts it, for testing.
Functions§
- Register Web Components with the global registry, given a Perspective module. This function shouldn’t be called directly; instead, use the
define_web_components!macro to both call this method and hook the wasm_bindgen module object. - Export all ExprTK commands, for use in generating documentation. Register this crate’s Custom Elements in the browser’s current session. This must occur before calling any public API methods on these Custom Elements from JavaScript, as the methods themselves won’t be defined yet. By default, this crate does not register
PerspectiveViewerElement(as to preserve backwards-compatible synchronous API). - Register a plugin globally.