Struct PropsUpdate 

pub struct PropsUpdate { /* private fields */ }

New props for mounted islands, sent in an HX-Trigger header.

htmx sends the PROPS_EVENT event. The loader sets data-react-props on the first element that matches each selector. React renders the same root again, so the component keeps its state.

use autumn_plugin_react::PropsUpdate;
use autumn_web::prelude::*;

#[post("/cart")]
async fn add_to_cart() -> AutumnResult<(PropsUpdate, Markup)> {
    let update = PropsUpdate::new().set("#cart", &serde_json::json!({ "count": 3 }))?;
    Ok((update, html! { p { "Added." } }))
}

• htmx handles HX-Trigger before the swap. To update an island that the same response swaps in, use after_settle.
• The update merges with a trigger header that the response already has. A header that later code sets with insert replaces it. Then call apply_to last.
• Props travel in a response header. Keep them small: proxies limit header size (nginx: 4 KB to 8 KB by default).
• Build selectors from trusted values. A selector from user input can select a different island.

An empty update sends no header.

Implementations

impl PropsUpdate

pub const fn new() -> Self

Makes an empty update.

pub fn set<T: Serialize + ?Sized>( self, selector: impl Into<String>, props: &T, ) -> Result<Self, PropsError>

Adds new props for the island at the CSS selector.

Errors

The same errors as Island::props.

pub const fn after_settle(self) -> Self

Sends the update in HX-Trigger-After-Settle. htmx then sends the event after the swap, so the update can reach a new island.

pub const fn header_name(&self) -> &'static str

The header that carries the update: hx-trigger, or hx-trigger-after-settle.

pub const fn len(&self) -> usize

The number of updates.

pub const fn is_empty(&self) -> bool

true when the update has no entries.

pub fn to_header_value(&self) -> String

The header value: {"autumn:react:props":[{"target":"#cart","props":{…}}]}.

The text is visible ASCII. Other characters become \uXXXX escapes, because a header value cannot hold them.

pub fn apply_to(&self, headers: &mut HeaderMap)

Writes the update into headers. It keeps the events that the header already has: a JSON object, or a comma list of event names. It replaces a value that is neither.

Trait Implementations

impl Clone for PropsUpdate

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PropsUpdate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PropsUpdate

fn default() -> Self

Returns the “default value” for a type.

impl IntoResponseParts for PropsUpdate

type Error = !

The type returned in the event of an error.

fn into_response_parts( self, res: ResponseParts, ) -> Result<ResponseParts, Self::Error>

Set parts of the response