Expand description
About Leptos
Leptos is a full-stack framework for building web applications in Rust. You can use it to build
- single-page apps (SPAs) rendered entirely in the browser, using client-side routing and loading or mutating data via async requests to the server
- multi-page apps (MPAs) rendered on the server, managing navigation, data, and mutations via
web-standard
<a>
and<form>
tags - progressively-enhanced single-page apps that are rendered on the server and then hydrated on the client,
enhancing your
<a>
and<form>
navigations and mutations seamlessly when WASM is available.
And you can do all three of these using the same Leptos code.
nightly
Note
Most of the examples assume you’re using nightly
Rust. If you’re on stable, note the following:
- You need to enable the
"stable"
flag inCargo.toml
:leptos = { version = "0.0", features = ["stable"] }
nightly
enables the function call syntax for accessing and setting signals. If you’re usingstable
, you’ll just call.get()
,.set()
, or.update()
manually. Check out thecounters_stable
example for examples of the correct API.
Learning by Example
If you want to see what Leptos is capable of, check out the examples:
counter
is the classic counter example, showing the basics of client-side rendering and reactive DOM updatescounter_without_macros
adapts the counter example to use the builder pattern for the UI and avoids other macros, instead showing the code that Leptos generates.counters
introduces parent-child communication via contexts, and the<For/>
component for efficient keyed list updates.counters_stable
adapts thecounters
example to show how to use Leptos withstable
Rust.parent_child
shows four different ways a parent component can communicate with a child, including passing a closure, context, and moretodomvc
implements the classic to-do app in Leptos. This is a good example of a complete, simple app. In particular, you might want to see how we use create_effect to serialize JSON tolocalStorage
and reactively call DOM methods on references to elements.fetch
introduces Resources, which allow you to integrate arbitraryasync
code like an HTTP request within your reactive code.router
shows how to use Leptos’s nested router to enable client-side navigation and route-specific, reactive data loading.counter_isomorphic
shows different methods of interaction with a stateful server, including server functions, server actions, forms, and server-sent events (SSE).todomvc
shows the basics of building an isomorphic web app. Both the server and the client import the same app code from thetodomvc
example. The server renders the app directly to an HTML string, and the client hydrates that HTML to make it interactive.hackernews
andhackernews_axum
integrate calls to a real external REST API, routing, server-side rendering and hydration to create a fully-functional that works as intended even before WASM has loaded and begun to run.todo_app_sqlite
andtodo_app_sqlite_axum
show how to build a full-stack app using server functions and database connections.tailwind
shows how to integrate TailwindCSS withcargo-leptos
.
Details on how to run each example can be found in its README.
Quick Links
Here are links to the most important sections of the docs:
- Reactivity: the leptos_reactive overview, and more details in
- signals: create_signal, ReadSignal, and WriteSignal (and create_rw_signal and RwSignal)
- computations: create_memo and Memo
async
interop: create_resource and Resource for loading data usingasync
functions, and create_action and Action to mutate data or imperatively callasync
functions.- reactions: create_effect
- Templating/Views: the view macro
- Routing: the leptos_router crate
- Server Functions: the server macro, create_action, and create_server_action
Feature Flags
csr
(Default) Client-side rendering: Generate DOM nodes in the browserssr
Server-side rendering: Generate an HTML string (typically on the server)hydrate
Hydration: use this to add interactivity to an SSRed Leptos appstable
By default, Leptos requiresnightly
Rust, which is what allows the ergonomics of calling signals as functions. If you need to usestable
, you will need to call.get()
and.set()
manually.serde
(Default) In SSR/hydrate mode, uses serde to serialize resources and send them from the server to the client.serde-lite
In SSR/hydrate mode, uses serde-lite to serialize resources and send them from the server to the client.miniserde
In SSR/hydrate mode, uses miniserde to serialize resources and send them from the server to the client.
Important Note: You must enable one of csr
, hydrate
, or ssr
to tell Leptos
which mode your app is operating in.
A Simple Counter
use leptos::*;
#[component]
pub fn SimpleCounter(cx: Scope, initial_value: i32) -> impl IntoView {
// create a reactive signal with the initial value
let (value, set_value) = create_signal(cx, initial_value);
// create event handlers for our buttons
// note that `value` and `set_value` are `Copy`, so it's super easy to move them into closures
let clear = move |_| set_value.set(0);
let decrement = move |_| set_value.update(|value| *value -= 1);
let increment = move |_| set_value.update(|value| *value += 1);
// this JSX is compiled to an HTML template string for performance
view! {
cx,
<div>
<button on:click=clear>"Clear"</button>
<button on:click=decrement>"-1"</button>
<span>"Value: " {move || value().to_string()} "!"</span>
<button on:click=increment>"+1"</button>
</div>
}
}
Leptos is easy to use with Trunk (or with a simple wasm-bindgen setup):
#[component]
fn SimpleCounter(cx: Scope, initial_value: i32) -> impl IntoView {
todo!()
}
pub fn main() {
mount_to_body(|cx| view! { cx, <SimpleCounter initial_value=3 /> })
}
Re-exports
Modules
Collection of typed events.
Parser and serializer for the
application/x-www-form-urlencoded
syntax,
as used by HTML forms.Bindings to JavaScript’s standard, built-in objects, including their methods
and properties.
A scoped, structured logging and diagnostics system.
Runtime support for the
wasm-bindgen
toolRaw API bindings for Web APIs
Macros
Uses
println!()
-style formatting to log errors to the console (in the browser)
or via eprintln!()
(if not in the browser).Uses
println!()
-style formatting to log something to the console (in the browser)
or via println!()
(if not in the browser).The
view
macro uses RSX (like JSX, but Rust!) It follows most of the
same rules as HTML, with the following differences:Uses
println!()
-style formatting to log warnings to the console (in the browser)
or via eprintln!()
(if not in the browser).Structs
The
<a>
HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.The
<abbr>
HTML element represents an abbreviation or acronym; the optional title attribute can provide an expansion or description for the abbreviation. If present, title must contain this full description and nothing else.An action synchronizes an imperative
async
call to the synchronous reactive system.The
<address>
HTML element indicates that the enclosed HTML provides contact information for a person or people, or for an organization.Represents potentially any element.
The
<area>
HTML element defines an area inside an image map that has predefined clickable areas. An image map allows geometric areas on an image to be associated with Hyperlink.The
<article>
HTML element represents a self-contained composition in a document, page, application, or site, which is intended to be independently distributable or reusable (e.g., in syndication). Examples include: a forum post, a magazine or newspaper article, or a blog entry, a product card, a user-submitted comment, an interactive widget or gadget, or any other independent item of content.The
<aside>
HTML element represents a portion of a document whose content is only indirectly related to the document’s main content. Asides are frequently presented as sidebars or call-out boxes.The
<audio>
HTML element is used to embed sound content in documents. It may contain one or more audio sources, represented using the src attribute or the source element: the browser will choose the most suitable one. It can also be the destination for streamed media, using a MediaStream.The
<b>
HTML element is used to draw the reader’s attention to the element’s contents, which are not otherwise granted special importance. This was formerly known as the Boldface element, and most browsers still draw the text in boldface. However, you should not use <b>
for styling text; instead, you should use the CSS font-weight property to create boldface text, or the strong element to indicate that text is of special importance.The
<base>
HTML element specifies the base URL to use for all relative URLs in a document. There can be only one <base>
element in a document.The
<bdi>
HTML element tells the browser’s bidirectional algorithm to treat the text it contains in isolation from its surrounding text. It’s particularly useful when a website dynamically inserts some text and doesn’t know the directionality of the text being inserted.The
<bdo>
HTML element overrides the current directionality of text, so that the text within is rendered in a different direction.The
<blockquote>
HTML element indicates that the enclosed text is an extended quotation. Usually, this is rendered visually by indentation (see Notes for how to change it). A URL for the source of the quotation may be given using the cite attribute, while a text representation of the source can be given using the cite element.The
<body>
HTML element represents the content of an HTML document. There can be only one <body>
element in a document.The
<br>
HTML element produces a line break in text (carriage-return). It is useful for writing a poem or an address, where the division of lines is significant.The
<button>
HTML element represents a clickable button, used to submit forms or anywhere in a document for accessible, standard button functionality.Use the HTML
<canvas>
element with either the canvas scripting API or the WebGL API to draw graphics and animations.The
<caption>
HTML element specifies the caption (or title) of a table.The
<cite>
HTML element is used to describe a reference to a cited creative work, and must include the title of that work. The reference may be in an abbreviated form according to context-appropriate conventions related to citation metadata.The
<code>
HTML element displays its contents styled in a fashion intended to indicate that the text is a short fragment of computer code. By default, the content text is displayed using the user agent default monospace font.The
<col>
HTML element defines a column within a table and is used for defining common semantics on all common cells. It is generally found within a colgroup element.The
<colgroup>
HTML element defines a group of columns within a table.A user-defined
leptos
component.Custom leptos component.
A Struct to allow us to parse LeptosOptions from the file. Not really needed, most interactions should
occur with LeptosOptions
Represents a custom HTML element, such as
<my-element>
.The
<data>
HTML element links a given piece of content with a machine-readable translation. If the content is time- or date-related, the time element must be used.The
<datalist>
HTML element contains a set of option elements that represent the permissible or recommended options available to choose from within other controls.The
<dd>
HTML element provides the description, definition, or value for the preceding term (dt) in a description list (dl).The
<del>
HTML element represents a range of text that has been deleted from a document. This can be used when rendering “track changes” or source code diff information, for example. The ins element can be used for the opposite purpose: to indicate text that has been added to the document.The
<details>
HTML element creates a disclosure widget in which information is visible only when the widget is toggled into an “open” state. A summary or label must be provided using the summary element.The
<dfn>
HTML element is used to indicate the term being defined within the context of a definition phrase or sentence. The p element, the dt/dd pairing, or the section element which is the nearest ancestor of the <dfn>
is considered to be the definition of the term.The
<dialog>
HTML element represents a dialog box or other interactive component, such as a dismissible alert, inspector, or subwindow.The
<div>
HTML element is the generic container for flow content. It has no effect on the content or layout until styled in some way using CSS (e.g. styling is directly applied to it, or some kind of layout model like Flexbox is applied to its parent element).The
<dl>
HTML element represents a description list. The element encloses a list of groups of terms (specified using the dt element) and descriptions (provided by dd elements). Common uses for this element are to implement a glossary or to display metadata (a list of key-value pairs).The
<dt>
HTML element specifies a term in a description or definition list, and as such must be used inside a dl element. It is usually followed by a dd element; however, multiple <dt>
elements in a row indicate several terms that are all defined by the immediate next dd element.The internal representation of the
DynChild
core-component.A component for efficiently rendering an iterable.
HTML element.
The
<em>
HTML element marks text that has stress emphasis. The <em>
element can be nested, with each level of nesting indicating a greater degree of emphasis.The
<embed>
HTML element embeds external content at the specified point in the document. This content is provided by an external application or other source of interactive content such as a browser plug-in.Props for the
ErrorBoundary
component.Builder for
ErrorBoundaryProps
instances.A struct to hold all the possible errors that could be provided by child Views
The
<fieldset>
HTML element is used to group several controls as well as labels (label) within a web form.The
<figcaption>
HTML element represents a caption or legend describing the rest of the contents of its parent figure element.The
<figure>
HTML element represents self-contained content, potentially with an optional caption, which is specified using the figcaption element. The figure, its caption, and its contents are referenced as a single unit.The
<footer>
HTML element represents a footer for its nearest sectioning content or sectioning root element. A <footer>
typically contains information about the author of the section, copyright data or links to related documents.Builder for
ForProps
instances.The
<form>
HTML element represents a document section containing interactive controls for submitting information.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<head>
HTML element contains machine-readable information (metadata) about the document, like its title, scripts, and style sheets.The
<header>
HTML element represents introductory content, typically a group of introductory or navigational aids. It may contain some heading elements but also a logo, a search form, an author name, and other elements.The
<hgroup>
HTML element represents a heading and related content. It groups a single <h1>–<h6>
element with one or more <p>
.The
<hr>
HTML element represents a thematic break between paragraph-level elements: for example, a change of scene in a story, or a shift of topic within a section.The
<html>
HTML element represents the root (top-level element) of an HTML document, so it is also referred to as the root element. All other elements must be descendants of this element.Represents an HTML element.
Control and utility methods for hydration.
A stable identifer within the server-rendering or hydration process.
The
<i>
HTML element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others. Historically, these have been presented using italicized type, which is the original source of the <i>
naming of this element.The
<iframe>
HTML element represents a nested browsing context, embedding another HTML page into the current one.The
<img>
HTML element embeds an image into the document.The
<input>
HTML element is used to create interactive controls for web-based forms in order to accept data from the user; a wide variety of types of input data and control widgets are available, depending on the device and user agent. The <input>
element is one of the most powerful and complex in all of HTML due to the sheer number of combinations of input types and attributes.The
<ins>
HTML element represents a range of text that has been added to a document. You can use the del element to similarly represent a range of text that has been deleted from the document.Handle that is generated by set_interval and can be used to clear the interval.
The
<kbd>
HTML element represents a span of inline text denoting textual user input from a keyboard, voice input, or any other text entry device. By convention, the user agent defaults to rendering the contents of a <kbd>
element using its default monospace font, although this is not mandated by the HTML standard.The
<label>
HTML element represents a caption for an item in a user interface.The
<legend>
HTML element represents a caption for the content of its parent fieldset.This struct serves as a convenient place to store details used for configuring Leptos.
It’s used in our actix and axum integrations to generate the
correct path for WASM, JS, and Websockets, as well as other configuration tasks.
It shares keys with cargo-leptos, to allow for easy interoperability
The
<li>
HTML element is used to represent an item in a list. It must be contained in a parent element: an ordered list (ol), an unordered list (ul), or a menu (menu). In menus and unordered lists, list items are usually displayed using bullet points. In ordered lists, they are usually displayed with an ascending counter on the left, such as a number or letter.The
<link>
HTML element specifies relationships between the current document and an external resource. This element is most commonly used to link to CSS, but is also used to establish site icons (both “favicon” style icons and icons for the home screen and apps on mobile devices) among other things.The
<main>
HTML element represents the dominant content of the body of a document. The main content area consists of content that is directly related to or expands upon the central topic of a document, or the central functionality of an application.The
<map>
HTML element is used with area elements to define an image map (a clickable link area).The
<mark>
HTML element represents text which is marked or highlighted for reference or notation purposes, due to the marked passage’s relevance or importance in the enclosing context.The top-level element in MathML is
<math>.
Every valid MathML instance must be wrapped in <math>
tags. In addition you must not nest a second <math>
element in another, but you can have an arbitrary number of other child elements in it.An efficient derived reactive value based on other reactive values.
The
<menu>
HTML element is a semantic alternative to ul. It represents an unordered list of items (represented by li elements), each of these represent a link or other command that the user can activate.The
<meta>
HTML element represents Metadata that cannot be represented by other HTML meta-related elements, like base, link, script, style or title.The
<meter>
HTML element represents either a scalar value within a known range or a fractional value.An action that synchronizes multiple imperative
async
calls to the reactive system,
tracking the progress of each one.The
<nav>
HTML element represents a section of a page whose purpose is to provide navigation links, either within the current document or to other documents. Common examples of navigation sections are menus, tables of contents, and indexes.Contains a shared reference to a DOM node creating while using the
view
macro to create your UI.The
<noscript>
HTML element defines a section of HTML to be inserted if a script type on the page is unsupported or if scripting is currently turned off in the browser.The
<object>
HTML element represents an external resource, which can be treated as an image, a nested browsing context, or a resource to be handled by a plugin.The
<ol>
HTML element represents an ordered list of items — typically rendered as a numbered list.The
<optgroup>
HTML element creates a grouping of options within a select element.The
<option>
HTML element is used to define an item contained in a select, an optgroup, or a datalist element. As such, <option>
can represent menu items in popups and other lists of items in an HTML document.The
<output>
HTML element is a container element into which a site or app can inject the results of a calculation or the outcome of a user action.The
<p>
HTML element represents a paragraph. Paragraphs are usually represented in visual media as blocks of text separated from adjacent blocks by blank lines and/or first-line indentation, but HTML paragraphs can be any structural grouping of related content, such as images or form fields.The
<param>
HTML element defines parameters for an object element.The
<picture>
HTML element contains zero or more source elements and one img element to offer alternative versions of an image for different display/device scenarios.The
<portal>
HTML element enables the embedding of another HTML page into the current one for the purposes of allowing smoother navigation into new pages.The
<pre>
HTML element represents preformatted text which is to be presented exactly as written in the HTML file. The text is typically rendered using a non-proportional, or “monospaced, font. Whitespace inside this element is displayed as written.The
<progress>
HTML element displays an indicator showing the completion progress of a task, typically displayed as a progress bar.The
<q>
HTML element indicates that the enclosed text is a short inline quotation. Most modern browsers implement this by surrounding the text in quotation marks. This element is intended for short quotations that don’t require paragraph breaks; for long quotations use the blockquote element.The getter for a reactive signal.
A signal that reflects the
current state of an asynchronous task, allowing you to integrate
async
Futures into the synchronous reactive system.Unique ID assigned to a Resource.
The
<rp>
HTML element is used to provide fall-back parentheses for browsers that do not support display of ruby annotations using the ruby element. One <rp>
element should enclose each of the opening and closing parentheses that wrap the rt element that contains the annotation’s text.The
<rt>
HTML element specifies the ruby text component of a ruby annotation, which is used to provide pronunciation, translation, or transliteration information for East Asian typography. The <rt>
element must always be contained within a ruby element.The
<ruby>
HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters. It can also be used for annotating other kinds of text, but this usage is less common.A signal that combines the getter and setter into one value, rather than
separating them into a ReadSignal and a WriteSignal. You may prefer this
its style, or it may be easier to pass around in a context or as a function argument.
The
<s>
HTML element renders text with a strikethrough, or a line through it. Use the <s>
element to represent things that are no longer relevant or no longer accurate. However, <s>
is not appropriate when indicating document edits; for that, use the del and ins elements, as appropriate.The
<samp>
HTML element is used to enclose inline text which represents sample (or quoted) output from a computer program. Its contents are typically rendered using the browser’s default monospaced font (such as Courier or Lucida Console).A Each scope can have
child scopes, and may in turn have a parent.
Creating a Scope gives you a disposer, which can be called
to dispose of that reactive scope.
The
<script>
HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code. The <script>
element can also be used with other languages, such as WebGL’s GLSL shader programming language and JSON.The
<section>
HTML element represents a generic standalone section of a document, which doesn’t have a more specific semantic element to represent it. Sections should always have a heading, with very few exceptions.The
<select>
HTML element represents a control that provides a menu of options:Builder for
ShowProps
instances.A wrapper for any kind of readable reactive signal: a ReadSignal,
Memo, RwSignal, or derived signal closure.
Unique ID assigned to a signal.
A wrapper for any kind of settable reactive signal: a WriteSignal,
RwSignal, or closure that receives a value and sets a signal depending
on it.
The
<slot>
HTML element—part of the Web Components technology suite—is a placeholder inside a web component that you can fill with your own markup, which lets you create separate DOM trees and present them together.The
<small>
HTML element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. By default, it renders text within it one font-size smaller, such as from small to x-small.The
<source>
HTML element specifies multiple media resources for the picture, the audio element, or the video element. It is an empty element, meaning that it has no content and does not have a closing tag. It is commonly used to offer the same media content in multiple file formats in order to provide compatibility with a broad range of browsers given their differing support for image file formats and media file formats.The
<span>
HTML element is a generic inline container for phrasing content, which does not inherently represent anything. It can be used to group elements for styling purposes (using the class or id attributes), or because they share attribute values, such as lang. It should be used only when no other semantic element is appropriate. <span>
is very much like a div element, but div is a block-level element whereas a <span>
is an inline element.A non-reactive wrapper for any value, which can be created with store_value.
The
<strong>
HTML element indicates that its contents have strong importance, seriousness, or urgency. Browsers typically render the contents in bold type.The
<style>
HTML element contains style information for a document, or part of a document. It contains CSS, which is applied to the contents of the document containing the <style>
element.The
<sub>
HTML element specifies inline text which should be displayed as subscript for solely typographical reasons. Subscripts are typically rendered with a lowered baseline using smaller text.An action that has been submitted by dispatching it to a MultiAction.
The
<summary>
HTML element specifies a summary, caption, or legend for a details element’s disclosure box. Clicking the <summary>
element toggles the state of the parent <details>
element open and closed.The
<sup>
HTML element specifies inline text which is to be displayed as superscript for solely typographical reasons. Superscripts are usually rendered with a raised baseline using smaller text.Props for the
Suspense
component.Builder for
SuspenseProps
instances.The svg element is a container that defines a new coordinate system and viewport. It is used as the outermost element of SVG documents, but it can also be used to embed an SVG fragment inside an SVG or HTML document.
The
<table>
HTML element represents tabular data — that is, information presented in a two-dimensional table comprised of rows and columns of cells containing data.The
<tbody>
HTML element encapsulates a set of table rows (tr elements), indicating that they comprise the body of the table (table).The
<td>
HTML element defines a cell of a table that contains data. It participates in the table model.The
<template>
HTML element is a mechanism for holding HTML that is not to be rendered immediately when a page is loaded but may be instantiated subsequently during runtime using JavaScript.HTML text
The
<textarea>
HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.The
<tfoot>
HTML element defines a set of rows summarizing the columns of the table.The
<th>
HTML element defines a cell as header of a group of table cells. The exact nature of this group is defined by the scope and headers attributes.The
<thead>
HTML element defines a set of rows defining the head of the columns of the table.The
<time>
HTML element represents a specific period in time. It may include the datetime attribute to translate dates into machine-readable format, allowing for better search engine results or custom features such as reminders.The
<title>
HTML element defines the document’s title that is shown in a Browser’s title bar or a page’s tab. It only contains text; tags within the element are ignored.The
<tr>
HTML element defines a row of cells in a table. The row’s cells can then be established using a mix of td (data cell) and th (header cell) elements.The
<track>
HTML element is used as a child of the media elements, audio and video. It lets you specify timed text tracks (or time-based data), for example to automatically handle subtitles. The tracks are formatted in WebVTT format (.vtt files) — Web Video Text Tracks.Props for the
Transition
component.Builder for
TransitionProps
instances.Wrapper for arbitrary data that can be passed through the view.
The
<u>
HTML element represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. This is rendered by default as a simple solid underline, but may be altered using CSS.The
<ul>
HTML element represents an unordered list of items, typically rendered as a bulleted list.The unit
()
leptos counterpart.The
<var>
HTML element represents the name of a variable in a mathematical expression or a programming context. It’s typically presented using an italicized version of the current typeface, although that behavior is browser-dependent.The
<video>
HTML element embeds a media player which supports video playback into the document. You can use <video>
for audio content as well, but the audio element may provide a more appropriate user experience.The
<wbr>
HTML element represents a word break opportunity—a position within text where the browser may optionally break a line, though its line-breaking rules would not otherwise create a break at that location.The setter for a reactive signal.
Enums
Represents the different possible values an attribute node could have.
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
.The core foundational leptos components.
Holds the current options for encoding types.
More could be added, but they need to be serde
An enum that can be used to define the environment Leptos is running in.
Setting this to the
PROD
variant will not include the WebSocket code for cargo-leptos
watch mode.
Defaults to DEV
.A wrapper for a value that is either
T
or Signal<T>
.A dual type to hold the possible Response datatypes
Represents the different possible values an element property could have,
allowing you to do fine-grained updates to single fields.
Describes errors that can occur while serializing and deserializing data,
typically during the process of streaming Resources from
the server to the client.
Type for errors that can occur when using server functions.
A leptos view which can be mounted to the DOM.
Traits
Trait which allows creating an element tag.
Trait alias for the trait bounts on
ElementDescriptor
.Converts some type into an Attribute.
Trait for converting any iterable into a
Fragment
.Converts some type into a Property.
Helper trait for converting
Fn() -> T
closures into
Signal<T>
.Helper trait for converting
Fn(T)
into SignalSetter<T>
.A trait for checked and unchecked casting between JS types.
Describes an object that can be serialized to or from a supported format
Currently those are JSON and Cbor
Defines a “server function.” A server function can be called from the server or the client,
but the body of its code will only be run on the server, i.e., if a crate feature
ssr
is enabled.Trait for converting any type which impl
AsRef<web_sys::Element>
to HtmlElement
.Trait implemented for all signal types which you can
get
a value
from, such as ReadSignal
,
Memo
, etc., which allows getting the inner value without
subscribing to the current scope.Trait implemented for all signal types which you can
set
the inner
value, such as WriteSignal
and RwSignal
, which allows setting
the inner value without causing effects which depend on the signal
from being run.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.Functions
When you render a
Result<_, _>
in your view, in the Err
case it will
render nothing, and search up through the view tree for an <ErrorBoundary/>
.
This component lets you define a fallback that should be rendered in that
error case, allowing you to handle errors within a section of the interface.Iterates over children and displays them, keyed by the
key
function given.A component that will show its children when the
when
condition is true
,
and show the fallback when it is false
, without rerendering every time
the condition changes.If any Resources are read in the
children
of this
component, it will show the fallback
while they are loading. Once all are resolved,
it will render the children
.The
<a>
HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.The
<abbr>
HTML element represents an abbreviation or acronym; the optional title attribute can provide an expansion or description for the abbreviation. If present, title must contain this full description and nothing else.The
<address>
HTML element indicates that the enclosed HTML provides contact information for a person or people, or for an organization.The
<area>
HTML element defines an area inside an image map that has predefined clickable areas. An image map allows geometric areas on an image to be associated with Hyperlink.The
<article>
HTML element represents a self-contained composition in a document, page, application, or site, which is intended to be independently distributable or reusable (e.g., in syndication). Examples include: a forum post, a magazine or newspaper article, or a blog entry, a product card, a user-submitted comment, an interactive widget or gadget, or any other independent item of content.The
<aside>
HTML element represents a portion of a document whose content is only indirectly related to the document’s main content. Asides are frequently presented as sidebars or call-out boxes.The
<audio>
HTML element is used to embed sound content in documents. It may contain one or more audio sources, represented using the src attribute or the source element: the browser will choose the most suitable one. It can also be the destination for streamed media, using a MediaStream.The
<b>
HTML element is used to draw the reader’s attention to the element’s contents, which are not otherwise granted special importance. This was formerly known as the Boldface element, and most browsers still draw the text in boldface. However, you should not use <b>
for styling text; instead, you should use the CSS font-weight property to create boldface text, or the strong element to indicate that text is of special importance.The
<base>
HTML element specifies the base URL to use for all relative URLs in a document. There can be only one <base>
element in a document.The
<bdi>
HTML element tells the browser’s bidirectional algorithm to treat the text it contains in isolation from its surrounding text. It’s particularly useful when a website dynamically inserts some text and doesn’t know the directionality of the text being inserted.The
<bdo>
HTML element overrides the current directionality of text, so that the text within is rendered in a different direction.The
<blockquote>
HTML element indicates that the enclosed text is an extended quotation. Usually, this is rendered visually by indentation (see Notes for how to change it). A URL for the source of the quotation may be given using the cite attribute, while a text representation of the source can be given using the cite element.The
<body>
HTML element represents the content of an HTML document. There can be only one <body>
element in a document.The
<br>
HTML element produces a line break in text (carriage-return). It is useful for writing a poem or an address, where the division of lines is significant.The
<button>
HTML element represents a clickable button, used to submit forms or anywhere in a document for accessible, standard button functionality.Executes the HTTP call to call a server function from the client, given its URL and argument type.
Use the HTML
<canvas>
element with either the canvas scripting API or the WebGL API to draw graphics and animations.The
<caption>
HTML element specifies the caption (or title) of a table.The
<cite>
HTML element is used to describe a reference to a cited creative work, and must include the title of that work. The reference may be in an abbreviated form according to context-appropriate conventions related to citation metadata.The
<code>
HTML element displays its contents styled in a fashion intended to indicate that the text is a short fragment of computer code. By default, the content text is displayed using the user agent default monospace font.The
<col>
HTML element defines a column within a table and is used for defining common semantics on all common cells. It is generally found within a colgroup element.The
<colgroup>
HTML element defines a group of columns within a table.Log an error to the console (in the browser)
or via
println!()
(if not in the browser), but only in a debug build.Log an error to the console (in the browser)
or via
println!()
(if not in the browser).Log a string to the console (in the browser)
or via
println!()
(if not in the browser).Log a warning to the console (in the browser)
or via
println!()
(if not in the browser).Creates an Action to synchronize an imperative
async
call to the synchronous reactive system.Effects run a certain chunk of code whenever the signals they depend on change.
create_effect
immediately runs the given function once, tracks its dependence
on any signal values read within it, and reruns the function whenever the value
of a dependency changes.Creates an effect; unlike effects created by create_effect, isomorphic effects will run on
the server as well as the client.
Creates an efficient derived reactive value based on other reactive values.
Creates an MultiAction to synchronize an imperative
async
call to the synchronous reactive system.Creates a reactive signal with the getter and setter unified in one value.
You may prefer this style, or it may be easier to pass around in a context
or as a function argument.
Creates a conditional signal that only notifies subscribers when a change
in the source signal’s value changes whether it is equal to the key value
(as determined by PartialEq.)
Creates a conditional signal that only notifies subscribers when a change
in the source signal’s value changes whether the given function is true.
Creates an Action that can be used to call a server function.
Creates an MultiAction that can be used to call a server function.
Creates a signal, the basic reactive primitive.
Creates a signal that always contains the most recent value emitted by a
Stream.
If the stream has not yet emitted a value since the signal was created, the signal’s
value will be
None
.Derives a reactive slice of an RwSignal.
Creates any custom element, such as
<my-element>
.The
<data>
HTML element links a given piece of content with a machine-readable translation. If the content is time- or date-related, the time element must be used.The
<datalist>
HTML element contains a set of option elements that represent the permissible or recommended options available to choose from within other controls.The
<dd>
HTML element provides the description, definition, or value for the preceding term (dt) in a description list (dl).The
<del>
HTML element represents a range of text that has been deleted from a document. This can be used when rendering “track changes” or source code diff information, for example. The ins element can be used for the opposite purpose: to indicate text that has been added to the document.The
<details>
HTML element creates a disclosure widget in which information is visible only when the widget is toggled into an “open” state. A summary or label must be provided using the summary element.The
<dfn>
HTML element is used to indicate the term being defined within the context of a definition phrase or sentence. The p element, the dt/dd pairing, or the section element which is the nearest ancestor of the <dfn>
is considered to be the definition of the term.The
<dialog>
HTML element represents a dialog box or other interactive component, such as a dismissible alert, inspector, or subwindow.The
<div>
HTML element is the generic container for flow content. It has no effect on the content or layout until styled in some way using CSS (e.g. styling is directly applied to it, or some kind of layout model like Flexbox is applied to its parent element).The
<dl>
HTML element represents a description list. The element encloses a list of groups of terms (specified using the dt element) and descriptions (provided by dd elements). Common uses for this element are to implement a glossary or to display metadata (a list of key-value pairs).The
<dt>
HTML element specifies a term in a description or definition list, and as such must be used inside a dl element. It is usually followed by a dd element; however, multiple <dt>
elements in a row indicate several terms that are all defined by the immediate next dd element.The
<em>
HTML element marks text that has stress emphasis. The <em>
element can be nested, with each level of nesting indicating a greater degree of emphasis.The
<embed>
HTML element embeds external content at the specified point in the document. This content is provided by an external application or other source of interactive content such as a browser plug-in.Helper function to extract
Event.target
from any event.Helper function to extract
event.target.checked
from an event.Helper function to extract
event.target.value
from an event.The
<fieldset>
HTML element is used to group several controls as well as labels (label) within a web form.The
<figcaption>
HTML element represents a caption or legend describing the rest of the contents of its parent figure element.The
<figure>
HTML element represents self-contained content, potentially with an optional caption, which is specified using the figcaption element. The figure, its caption, and its contents are referenced as a single unit.The
<footer>
HTML element represents a footer for its nearest sectioning content or sectioning root element. A <footer>
typically contains information about the author of the section, copyright data or links to related documents.The
<form>
HTML element represents a document section containing interactive controls for submitting information.Loads LeptosOptions from a Cargo.toml with layered overrides. If an env var is specified, like
LEPTOS_ENV
,
it will override a setting in the file. It takes in an optional path to a Cargo.toml file. If None is provided,
you’ll need to set the options as environment variables or rely on the defaults. This is the preferred
approach for cargo-leptos. If Some(“./Cargo.toml”) is provided, Leptos will read in the settings itself. This
option currently does not allow dashes in file or foldernames, as all dashes become underscoresGets the value of a property set on a DOM element.
The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<h1>
to <h6>
HTML elements represent six levels of section headings. <h1>
is the highest section level and <h6>
is the lowest.The
<head>
HTML element contains machine-readable information (metadata) about the document, like its title, scripts, and style sheets.The
<header>
HTML element represents introductory content, typically a group of introductory or navigational aids. It may contain some heading elements but also a logo, a search form, an author name, and other elements.The
<hgroup>
HTML element represents a heading and related content. It groups a single <h1>–<h6>
element with one or more <p>
.The
<hr>
HTML element represents a thematic break between paragraph-level elements: for example, a change of scene in a story, or a shift of topic within a section.The
<html>
HTML element represents the root (top-level element) of an HTML document, so it is also referred to as the root element. All other elements must be descendants of this element.The
<i>
HTML element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others. Historically, these have been presented using italicized type, which is the original source of the <i>
naming of this element.The
<iframe>
HTML element represents a nested browsing context, embedding another HTML page into the current one.The
<img>
HTML element embeds an image into the document.The
<input>
HTML element is used to create interactive controls for web-based forms in order to accept data from the user; a wide variety of types of input data and control widgets are available, depending on the device and user agent. The <input>
element is one of the most powerful and complex in all of HTML due to the sheer number of combinations of input types and attributes.The
<ins>
HTML element represents a range of text that has been added to a document. You can use the del element to similarly represent a range of text that has been deleted from the document.Returns true if running on the browser (CSR).
Returns true if
debug_assertions
are enabled.Returns true if
debug_assertions
are disabled.Returns true if running on the server (SSR).
The
<kbd>
HTML element represents a span of inline text denoting textual user input from a keyboard, voice input, or any other text entry device. By convention, the user agent defaults to rendering the contents of a <kbd>
element using its default monospace font, although this is not mandated by the HTML standard.The
<label>
HTML element represents a caption for an item in a user interface.The
<legend>
HTML element represents a caption for the content of its parent fieldset.The
<li>
HTML element is used to represent an item in a list. It must be contained in a parent element: an ordered list (ol), an unordered list (ul), or a menu (menu). In menus and unordered lists, list items are usually displayed using bullet points. In ordered lists, they are usually displayed with an ascending counter on the left, such as a number or letter.The
<link>
HTML element specifies relationships between the current document and an external resource. This element is most commonly used to link to CSS, but is also used to establish site icons (both “favicon” style icons and icons for the home screen and apps on mobile devices) among other things.Returns the current
window.location
.Current
window.location.hash
without the beginning #.The
<main>
HTML element represents the dominant content of the body of a document. The main content area consists of content that is directly related to or expands upon the central topic of a document, or the central functionality of an application.The
<map>
HTML element is used with area elements to define an image map (a clickable link area).The
<mark>
HTML element represents text which is marked or highlighted for reference or notation purposes, due to the marked passage’s relevance or importance in the enclosing context.The top-level element in MathML is
<math>.
Every valid MathML instance must be wrapped in <math>
tags. In addition you must not nest a second <math>
element in another, but you can have an arbitrary number of other child elements in it.The
<menu>
HTML element is a semantic alternative to ul. It represents an unordered list of items (represented by li elements), each of these represent a link or other command that the user can activate.The
<meta>
HTML element represents Metadata that cannot be represented by other HTML meta-related elements, like base, link, script, style or title.The
<meter>
HTML element represents either a scalar value within a known range or a fractional value.Runs the provided closure and mounts the result to the provided element.
Runs the provided closure and mounts the result to eht
<body>
.The
<nav>
HTML element represents a section of a page whose purpose is to provide navigation links, either within the current document or to other documents. Common examples of navigation sections are menus, tables of contents, and indexes.The
<noscript>
HTML element defines a section of HTML to be inserted if a script type on the page is unsupported or if scripting is currently turned off in the browser.The
<object>
HTML element represents an external resource, which can be treated as an image, a nested browsing context, or a resource to be handled by a plugin.The
<ol>
HTML element represents an ordered list of items — typically rendered as a numbered list.Creates a cleanup function, which will be run when a Scope is disposed.
The
<optgroup>
HTML element creates a grouping of options within a select element.The
<option>
HTML element is used to define an item contained in a select, an optgroup, or a datalist element. As such, <option>
can represent menu items in popups and other lists of items in an HTML document.The
<output>
HTML element is a container element into which a site or app can inject the results of a calculation or the outcome of a user action.The
<p>
HTML element represents a paragraph. Paragraphs are usually represented in visual media as blocks of text separated from adjacent blocks by blank lines and/or first-line indentation, but HTML paragraphs can be any structural grouping of related content, such as images or form fields.The
<param>
HTML element defines parameters for an object element.The
<picture>
HTML element contains zero or more source elements and one img element to offer alternative versions of an image for different display/device scenarios.The
<portal>
HTML element enables the embedding of another HTML page into the current one for the purposes of allowing smoother navigation into new pages.The
<pre>
HTML element represents preformatted text which is to be presented exactly as written in the HTML file. The text is typically rendered using a non-proportional, or “monospaced, font. Whitespace inside this element is displayed as written.The
<progress>
HTML element displays an indicator showing the completion progress of a task, typically displayed as a progress bar.Provides a context value of type
T
to the current reactive Scope
and all of its descendants. This can be consumed using use_context.The
<q>
HTML element indicates that the enclosed text is a short inline quotation. Most modern browsers implement this by surrounding the text in quotation marks. This element is intended for short quotations that don’t require paragraph breaks; for long quotations use the blockquote element.Exposes the queueMicrotask method
in the browser, and simply runs the given function when on the server.
Renders a function to a stream of HTML strings.
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
.Renders the given function to a static HTML string.
Runs the given function between the next repaint
using
Window.requestAnimationFrame
.Queues the given function during an idle period
using
using
Window.requestIdleCallback
.The
<rp>
HTML element is used to provide fall-back parentheses for browsers that do not support display of ruby annotations using the ruby element. One <rp>
element should enclose each of the opening and closing parentheses that wrap the rt element that contains the annotation’s text.The
<rt>
HTML element specifies the ruby text component of a ruby annotation, which is used to provide pronunciation, translation, or transliteration information for East Asian typography. The <rt>
element must always be contained within a ruby element.The
<ruby>
HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters. It can also be used for annotating other kinds of text, but this usage is less common.The
<s>
HTML element renders text with a strikethrough, or a line through it. Use the <s>
element to represent things that are no longer relevant or no longer accurate. However, <s>
is not appropriate when indicating document edits; for that, use the del and ins elements, as appropriate.The
<samp>
HTML element is used to enclose inline text which represents sample (or quoted) output from a computer program. Its contents are typically rendered using the browser’s default monospaced font (such as Courier or Lucida Console).The
<script>
HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code. The <script>
element can also be used with other languages, such as WebGL’s GLSL shader programming language and JSON.The
<section>
HTML element represents a generic standalone section of a document, which doesn’t have a more specific semantic element to represent it. Sections should always have a heading, with very few exceptions.The
<select>
HTML element represents a control that provides a menu of options:Repeatedly calls the given function, with a delay of the given duration between calls.
See
setInterval()
.Sets a property on a DOM element.
Executes the given function after the given duration of time has passed.
setTimeout()
.The
<slot>
HTML element—part of the Web Components technology suite—is a placeholder inside a web component that you can fill with your own markup, which lets you create separate DOM trees and present them together.The
<small>
HTML element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. By default, it renders text within it one font-size smaller, such as from small to x-small.The
<source>
HTML element specifies multiple media resources for the picture, the audio element, or the video element. It is an empty element, meaning that it has no content and does not have a closing tag. It is commonly used to offer the same media content in multiple file formats in order to provide compatibility with a broad range of browsers given their differing support for image file formats and media file formats.The
<span>
HTML element is a generic inline container for phrasing content, which does not inherently represent anything. It can be used to group elements for styling purposes (using the class or id attributes), or because they share attribute values, such as lang. It should be used only when no other semantic element is appropriate. <span>
is very much like a div element, but div is a block-level element whereas a <span>
is an inline element.Spawns and runs a thread-local std::future::Future in a platform-independent way.
Creates a non-reactive wrapper for any value by storing it within
the reactive system.
The
<strong>
HTML element indicates that its contents have strong importance, seriousness, or urgency. Browsers typically render the contents in bold type.The
<style>
HTML element contains style information for a document, or part of a document. It contains CSS, which is applied to the contents of the document containing the <style>
element.The
<sub>
HTML element specifies inline text which should be displayed as subscript for solely typographical reasons. Subscripts are typically rendered with a lowered baseline using smaller text.The
<summary>
HTML element specifies a summary, caption, or legend for a details element’s disclosure box. Clicking the <summary>
element toggles the state of the parent <details>
element open and closed.The
<sup>
HTML element specifies inline text which is to be displayed as superscript for solely typographical reasons. Superscripts are usually rendered with a raised baseline using smaller text.The svg element is a container that defines a new coordinate system and viewport. It is used as the outermost element of SVG documents, but it can also be used to embed an SVG fragment inside an SVG or HTML document.
The
<table>
HTML element represents tabular data — that is, information presented in a two-dimensional table comprised of rows and columns of cells containing data.The
<tbody>
HTML element encapsulates a set of table rows (tr elements), indicating that they comprise the body of the table (table).The
<td>
HTML element defines a cell of a table that contains data. It participates in the table model.The
<template>
HTML element is a mechanism for holding HTML that is not to be rendered immediately when a page is loaded but may be instantiated subsequently during runtime using JavaScript.Creates a text node.
The
<textarea>
HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.The
<tfoot>
HTML element defines a set of rows summarizing the columns of the table.The
<th>
HTML element defines a cell as header of a group of table cells. The exact nature of this group is defined by the scope and headers attributes.The
<thead>
HTML element defines a set of rows defining the head of the columns of the table.The
<time>
HTML element represents a specific period in time. It may include the datetime attribute to translate dates into machine-readable format, allowing for better search engine results or custom features such as reminders.The
<title>
HTML element defines the document’s title that is shown in a Browser’s title bar or a page’s tab. It only contains text; tags within the element are ignored.The
<tr>
HTML element defines a row of cells in a table. The row’s cells can then be established using a mix of td (data cell) and th (header cell) elements.The
<track>
HTML element is used as a child of the media elements, audio and video. It lets you specify timed text tracks (or time-based data), for example to automatically handle subtitles. The tracks are formatted in WebVTT format (.vtt files) — Web Video Text Tracks.The
<u>
HTML element represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. This is rendered by default as a simple solid underline, but may be altered using CSS.The
<ul>
HTML element represents an unordered list of items, typically rendered as a bulleted list.Extracts a context value of type
T
from the reactive system by traversing
it upwards, beginning from the current Scope and iterating
through its parents, if any. The context value should have been provided elsewhere
using provide_context.The
<var>
HTML element represents the name of a variable in a mathematical expression or a programming context. It’s typically presented using an italicized version of the current typeface, although that behavior is browser-dependent.The
<video>
HTML element embeds a media player which supports video playback into the document. You can use <video>
for audio content as well, but the audio element may provide a more appropriate user experience.The
<wbr>
HTML element represents a word break opportunity—a position within text where the browser may optionally break a line, though its line-breaking rules would not otherwise create a break at that location.Adds an event listener to the
Window
.Attribute Macros
Annotates a function so that it can be used with your template as a Leptos
<Component/>
.Declares that a function is a server function. This means that
its body will only run on the server, i.e., when the
ssr
feature is enabled.