Expand description
The main html module which defines components, listeners, and class helpers.
Structs§
- AnyScope
- Untyped scope used for accessing parent scope
- Assert
AllProps - Dummy struct targeted by assertions that all props were set
- Children
Props - A Properties type with Children being the only property.
- Children
Renderer - A type used for rendering children html.
- Classes
- A set of classes, cheap to clone.
- Context
- The
Component’s context. This contains component’sScopeand props and is passed to every lifecycle method. - NodeRef
- Wrapped Node reference for later use in Component lifecycle methods.
- Phantom
Component - A Component to represent a component that does not exist in current implementation.
- Scope
- A context which allows sending messages to a component.
Enums§
- Render
Error - Render Error.
Traits§
- AllProps
For - Trait to specify the requirement for Self to be a valid token signaling all props have been provided to the builder.
- Base
Component - The common base of both function components and struct components.
- Buildable
- Trait finishing the builder and verifying all props were set. The structure can be a bit surprising, and is related to how the proc macro reports errors
- Component
- 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.
- HasAll
Props - A marker trait to ensure that the builder has received all required props.
For each struct deriving
Properties, an impl is generated, requiringHasProp<p>for all properties marked as required as a bound on the impl. - HasProp
- A marker trait to ensure that the builder has received a specific required prop. For each required impl in a property, we generate:
- Implicit
Clone - Marker trait for cheap-to-clone types that should be allowed to be cloned implicitly.
- Into
Event Callback - A trait similar to
Into<T>which allows conversion of a value into aCallback. This is used for event listeners. - Into
Html Result - A trait to translate into a
HtmlResult. - Into
Prop Value - A trait similar to
Into<T>which allows conversion to a value of aPropertiesstruct. - Properties
- Trait for building properties for a component
- Send
AsMessage - Defines a message type that can be sent to a component. Used for the return value of closure given to Scope::batch_callback.
- Target
Cast - A trait to obtain a generic event target.
- ToHtml
- A trait implemented for types be rendered as a part of a Html.
Functions§
- create_
portal - Render children into a DOM node that exists outside the hierarchy of the parent component.
Type Aliases§
- Children
- A type used for accepting children elements in Component::Properties.
- Children
With Props - A type used for accepting children elements in Component::Properties and accessing their props.
- Html
- A type which expected as a result of
viewfunction implementation. - Html
Result - An enhanced type of
Htmlreturned in suspendible function components. - Render
Result - Render Result.