Crate webui

source · [−]

Expand description

Web UI

webui is a website framework for building webassembly SPA websites quickly and easily. Development is just getting started, so we do not recommend using at this point for anything more than experimenting.

Re-exports

pub use crate::data_types::app_config::AppConfig;

pub use crate::data_types::direction::Direction;

pub use crate::data_types::drawer_toggle_info::DrawerToggleInfo;

pub use crate::data_types::roles;

pub use yew;

pub use yew_agent;

pub use crate::agents::app_state_agent::*;

pub use crate::data_types::nav_route::*;

pub use crate::macros::titles::*;

pub use crate::macros::*;

Modules

Agents for sending and receiving messages between components.

Components used for managing and rendering html output

Data Types

The main html module which defines components, listeners, and class helpers.

Javascript interop and related macros

Generalized macros

Macros

Macro for quickly logging data to the browser’s console.log

Macro for expanding string arguments into paragraphs

Macro for expanding string arguments into a title

title_background

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

title_secondary

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Macro for expanding string arguments into a title

Structs

Link to agent’s scope for creating callbacks.

The AnimationEvent class.

AppDrawerButton

Button that is used to trigger opening one of the four app drawers.

AppDrawerOptions

AppDrawerOptionsBuilder

An instance of an application.

A set of classes.

The Component’s context. This contains component’s Scope and and props and is passed to every lifecycle method.

ContextProvider

The context provider component.

A newtype around a bridge to indicate that it is distinct from a normal bridge

The DragEvent class.

The ErrorEvent class.

The Event class.

The FocusEvent class.

FunctionComponent

Wrapper that allows a struct implementing FunctionProvider to be consumed as a component.

Id of responses handler.

The HookUpdater provides a convenient interface for hooking into the lifecycle of the underlying Yew Component that backs the function component.

The InputEvent class.

Create an instance in the current thread.

The KeyboardEvent class.

The MouseEvent class.

Navigation link component

Wrapped Node reference for later use in Component lifecycle methods.

The PointerEvent class.

Create a new instance for every bridge.

The ProgressEvent class.

Create a single instance in a tab.

The TouchEvent class.

TransitionEvent

The TransitionEvent class.

The UiEvent class.

UseBridgeHandle

State handle for use_bridge hook

UseReducerDispatcher

Dispatcher handle for use_reducer and use_reducer_eq hook

UseReducerHandle

State handle for use_reducer and use_reducer_eq hook

State handle for the use_state hook.

Setter handle for use_state and use_state_eq hook

The WheelEvent class.

Enums

AppDrawerReceiverMessage

AppDrawerRequest

Universal callback wrapper.

Traits

Declares the behavior of the agent.

Bridge to a specific kind of worker.

This trait allows registering or getting the address of a worker.

Components are the basic building blocks of the UI in a Yew app. Each Component chooses how to display itself using received props and self-managed state. Components can be dynamic and interactive by declaring messages that are triggered and handled asynchronously. This async update mechanism is inspired by Elm and the actor model used in the Actix framework.

This trait allows the creation of a dispatcher to an existing agent that will not send replies when messages are sent.

FunctionProvider

Trait that allows a struct to act as Function Component.

Trait for building properties for a component

A trait that implements a reducer function of a type.

A trait to obtain a generic event target.

Implements rules to register a worker in a separate thread.

Functions

Render children into a DOM node that exists outside the hierarchy of the parent component.

set_event_bubbling

Set, if events should bubble up the DOM tree, calling any matching callbacks.

Initializer to run in app main() to start website

A hook to bridge to an Agent.

Hook for consuming context values in function components. The context of the type passed as T is returned. If there is no such context in scope, None is returned. A component which calls use_context will re-render when the data of the context changes.

This hook is used for hooking into the component’s lifecycle.

use_effect_with_deps

This hook is similar to use_effect but it accepts dependencies.

Low level building block of creating hooks.

This hook is used for obtaining a mutable reference to a stateful value. Its state persists across renders.

This hook is used for obtaining a NodeRef. It persists across renders.

This hook is an alternative to use_state. It is used to handle component’s state and is used when complex actions needs to be performed on said state.

use_reducer but only re-renders when prev_state != next_state.

This hook is used for obtaining a immutable reference to a stateful value. Its state persists across renders.

This hook is used to manage state in a function component.

use_state but only re-renders when prev_state != next_state.

Type Definitions

Display button

A type used for accepting children elements in Component::Properties.

ChildrenWithProps

A type used for accepting children elements in Component::Properties and accessing their props.

A type which expected as a result of view function implementation.

Component for display a navigation tree

Common container component

Attribute Macros

function_component

Derive Macros