Crate leptos_dom

source ·
Expand description

The DOM implementation for leptos.

Re-exports

pub extern crate tracing;
pub use js_sys;
pub use wasm_bindgen;
pub use web_sys;
pub use html::*;

Modules

ev
Collection of typed events.

Macros

debug_warn
Uses println!()-style formatting to log warnings to the console (in the browser) or via eprintln!() (if not in the browser), but only if it’s a debug build.
error
Uses println!()-style formatting to log errors to the console (in the browser) or via eprintln!() (if not in the browser).
log
Uses println!()-style formatting to log something to the console (in the browser) or via println!() (if not in the browser).
warn
Uses println!()-style formatting to log warnings to the console (in the browser) or via eprintln!() (if not in the browser).

Structs

Component
A user-defined leptos component.
ComponentRepr
Custom leptos component.
DynChild
Represents any View that can change over time.
DynChildRepr
The internal representation of the DynChild core-component.
Each
A component for efficiently rendering an iterable.
EachRepr
The internal representation of the Each core-component.
Element
HTML element.
Errors
A struct to hold all the possible errors that could be provided by child Views
Fragment
Represents a group of views.
HydrationCtx
Control and utility methods for hydration.
HydrationKey
A stable identifer within the server-rendering or hydration process.
IntervalHandle
Handle that is generated by set_interval and can be used to clear the interval.
NodeRef
Contains a shared reference to a DOM node creating while using the view macro to create your UI.
Text
HTML text
Transparent
Wrapper for arbitrary data that can be passed through the view.
Unit
The unit () leptos counterpart.
UnitRepr
The internal representation of the Unit core-component.

Enums

Attribute
Represents the different possible values an attribute node could have.
Class
Represents the different possible values a single class on an element could have, allowing you to do fine-grained updates to single items in Element.classList.
CoreComponent
The core foundational leptos components.
Property
Represents the different possible values an element property could have, allowing you to do fine-grained updates to single fields.
View
A leptos view which can be mounted to the DOM.

Traits

IntoAttribute
Converts some type into an Attribute.
IntoClass
Converts some type into a Class.
IntoFragment
Trait for converting any iterable into a Fragment.
IntoProperty
Converts some type into a Property.
IntoView
Converts the value into a View.

Functions

console_debug_warn
Log an error to the console (in the browser) or via println!() (if not in the browser), but only in a debug build.
console_error
Log an error to the console (in the browser) or via println!() (if not in the browser).
console_log
Log a string to the console (in the browser) or via println!() (if not in the browser).
console_warn
Log a warning to the console (in the browser) or via println!() (if not in the browser).
document
Returns the Document.
event_target
Helper function to extract Event.target from any event.
event_target_checked
Helper function to extract event.target.checked from an event.
event_target_value
Helper function to extract event.target.value from an event.
get_property
Gets the value of a property set on a DOM element.
is_browser
Returns true if running on the browser (CSR).
is_dev
Returns true if debug_assertions are enabled.
is_release
Returns true if debug_assertions are disabled.
is_server
Returns true if running on the server (SSR).
location
Returns the current window.location.
location_hash
Current window.location.hash without the beginning #.
location_pathname
Current window.location.pathname.
mount_to
Runs the provided closure and mounts the result to the provided element.
mount_to_body
Runs the provided closure and mounts the result to eht <body>.
render_to_stream
Renders a function to a stream of HTML strings.
render_to_stream_with_prefix
Renders a function to a stream of HTML strings. After the view runs, the prefix will run with the same scope. This can be used to generate additional HTML that has access to the same Scope.
render_to_stream_with_prefix_undisposed
Renders a function to a stream of HTML strings and returns the Scope and RuntimeId that were created, so they can be disposed when appropriate. After the view runs, the prefix will run with the same scope. This can be used to generate additional HTML that has access to the same Scope.
render_to_stream_with_prefix_undisposed_with_context
Renders a function to a stream of HTML strings and returns the Scope and RuntimeId that were created, so they can be disposed when appropriate. After the view runs, the prefix will run with the same scope. This can be used to generate additional HTML that has access to the same Scope.
render_to_string
Renders the given function to a static HTML string.
request_animation_frame
Runs the given function between the next repaint using Window.requestAnimationFrame.
request_idle_callback
Queues the given function during an idle period
using Window.requestIdleCallback.
set_interval
Repeatedly calls the given function, with a delay of the given duration between calls. See setInterval().
set_property
Sets a property on a DOM element.
set_timeout
Executes the given function after the given duration of time has passed. setTimeout().
window
Returns the Window.
window_event_listener
Adds an event listener to the Window.