This is the API reference documentation for the Jaspr Web Framework. It provides a comprehensive overview of the most important components and utilities available in the framework.
This is not the complete API reference. For a complete reference, please refer to the generated API Reference on pub.dev.
This documentation is split into the sections:
The Document component sets up and controls the basic document structure.
Renders raw HTML from a String.
Server-side components with an async build method.
Server-side components with an async build method.
Handles routing between different pages both server- and client-side.
Handles any kind of link.
Renders the provided StyleRules into css and wraps them with a <style> element.
Embed a flutter app in your Jaspr site.
Displays a "Built with Jaspr" badge.
Runs your Jaspr site on either the server or the client.
Type-safe Dart bindings of CSS properties.
Styling utility to write nested style rules.
Type-safe event bindings for HTML components.
Get access to the underlying DOM node of a component.
Easily transition between ui states with View Transitions.
With the @client annotation you can automatically hydrate selected components on the client.
Setup encoding and decoding for custom data types.
How to import platform-specific libraries in shared components.
Easy data synchronization with support for custom data types.
Syncing the state of a StatefulComponent from server to client.
Asynchronously preloading the state of a StatefulComponent on the server.
Access request headers and set response headers.
Access request cookies and set response cookies.
Set the response status code and body.