Struct Props

pub struct Props(/* private fields */);

A convenience builder for JS objects. Mainly used for constructing props that are not controlled by Rust.

Use Style to create style objects which also provides auto-completion.

Example

Props::new()
  .insert("id", &"app".into())
  .insert_callback("onClick", handle_click)

Implementations

impl Props

pub fn new() -> Self

Creates a new, empty object.

pub fn key(self, value: Option<impl KeyType>) -> Self

Sets the React key.

pub fn ref_container<T>(self, ref_container: &JsRefContainer<T>) -> Self

Sets the React ref to the given ref container created with the use_js_ref() hook.

pub fn ref_callback<T>(self, ref_callback: &Callback<Option<T>>) -> Self

where T: OptionFromWasmAbi + 'static,

Sets the React ref to the given ref callback.

pub fn insert(self, key: &str, value: &JsValue) -> Self

Equivalent to props[key] = value;.

pub fn insert_callback<T, U>(self, key: &str, f: &Callback<T, U>) -> Self

where T: FromWasmAbi + 'static, U: IntoWasmAbi + 'static,

Equivalent to props[key] = f;.

Trait Implementations

impl AsRef<JsValue> for Props

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Props

fn clone(&self) -> Props

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Props

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

Formats the value using the given formatter.

impl Default for Props

fn default() -> Props

Returns the “default value” for a type.

impl From<Object> for Props

fn from(value: Object) -> Self

Converts to this type from the input type.

impl From<Props> for JsValue

fn from(style: Props) -> Self

Converts to this type from the input type.

impl TryFrom<JsValue> for Props

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.