#generic_where {
+ wrapped: ::std::boxed::Box<#wrapped_name<#generic_idents>>,
+ _marker: ::std::marker::PhantomData,
+ }
+
+ impl #generics ::yew::html::Properties for #props_name<#generic_idents> #generic_where {
+ type Builder = #builder_name<#start_step_name, #generic_idents>;
+
+ fn builder() -> Self::Builder {
+ #builder_name {
+ wrapped: ::std::boxed::Box::new(::std::default::Default::default()),
+ _marker: ::std::marker::PhantomData,
+ }
+ }
+ }
+
+ #(#step_methods)*
+
+ impl #generics #builder_name<#build_step_name, #generic_idents> #generic_where {
+ #[doc(hidden)]
+ #vis fn build(self) -> #props_name<#generic_idents> {
+ #props_name::<#generic_idents> {
+ #(#prop_field_setters)*
+ }
+ }
+ }
+ };
+
+ TokenStream::from(expanded)
+}
+
+fn wrapped_fields<'a>(
+ prop_fields: impl Iterator- ,
+) -> impl Iterator
- {
+ prop_fields.map(|pf| {
+ let PropField { name, ty, .. } = &pf;
+ if let Some(wrapped_name) = &pf.wrapped_name {
+ quote! {
+ #wrapped_name: ::std::option::Option<#ty>,
+ }
+ } else {
+ quote! {
+ #name: #ty,
+ }
+ }
+ })
+}
+
+fn wrapped_default_setters<'a>(
+ prop_fields: impl Iterator
- ,
+) -> impl Iterator
- {
+ prop_fields.map(|pf| {
+ if let Some(wrapped_name) = &pf.wrapped_name {
+ quote! {
+ #wrapped_name: ::std::default::Default::default(),
+ }
+ } else {
+ let name = &pf.name;
+ quote! {
+ #name: ::std::default::Default::default(),
+ }
+ }
+ })
+}
+
+fn prop_field_setters<'a>(
+ prop_fields: impl Iterator
- ,
+) -> impl Iterator
- {
+ prop_fields.map(|pf| {
+ let name = &pf.name;
+ if let Some(wrapped_name) = &pf.wrapped_name {
+ quote! {
+ #name: self.wrapped.#wrapped_name.unwrap(),
+ }
+ } else {
+ quote! {
+ #name: self.wrapped.#name,
+ }
+ }
+ })
+}
+
+fn find_props_meta_list(field: &syn::Field) -> Option {
+ let meta_list = field
+ .attrs
+ .iter()
+ .find_map(|attr| match attr.parse_meta().ok()? {
+ Meta::List(meta_list) => Some(meta_list),
+ _ => None,
+ })?;
+
+ if meta_list.ident == "props" {
+ Some(meta_list)
+ } else {
+ None
+ }
+}
+
+fn required_wrapper(named_field: &syn::Field) -> Result, Error> {
+ let meta_list = if let Some(meta_list) = find_props_meta_list(named_field) {
+ meta_list
+ } else {
+ return Ok(None);
+ };
+
+ let expected_required = syn::Error::new(meta_list.span(), "expected `props(required)`");
+ let first_nested = if let Some(first_nested) = meta_list.nested.first() {
+ first_nested
+ } else {
+ return Err(expected_required);
+ };
+
+ let word_ident = match first_nested {
+ punctuated::Pair::End(NestedMeta::Meta(Meta::Word(ident))) => ident,
+ _ => return Err(expected_required),
+ };
+
+ if word_ident != "required" {
+ return Err(expected_required);
+ }
+
+ if let Some(ident) = &named_field.ident {
+ Ok(Some(Ident::new(
+ &format!("{}_wrapper", ident),
+ Span::call_site(),
+ )))
+ } else {
+ unreachable!()
+ }
+}
+
+fn step_name_impls<'a>(
+ step_trait_name: &'a Ident,
+ step_names: impl Iterator
- ,
+) -> impl Iterator
- {
+ step_names.map(move |name| {
+ let trait_name = step_trait_name;
+ quote! {
+ impl #trait_name for #name {}
+ }
+ })
+}
+
+fn step_methods<'a>(
+ vis: &'a Visibility,
+ generics: &'a Generics,
+ generic_idents: &'a proc_macro2::TokenStream,
+ generic_where: &'a Option,
+ builder_name: &'a Ident,
+ step_names: &'a [Ident],
+ prop_fields: &'a [PropField],
+) -> proc_macro2::TokenStream {
+ let mut prop_fields_index = 0;
+ let mut token_stream = proc_macro2::TokenStream::new();
+
+ for (step, step_name) in step_names.iter().enumerate() {
+ let mut optional_fields = Vec::new();
+ let mut required_field = None;
+
+ if prop_fields_index >= prop_fields.len() {
+ break;
+ }
+
+ while let Some(pf) = prop_fields.get(prop_fields_index) {
+ prop_fields_index += 1;
+ if pf.wrapped_name.is_some() {
+ required_field = Some(pf);
+ break;
+ } else {
+ optional_fields.push((&pf.name, &pf.ty));
+ }
+ }
+
+ let optional_prop_fn = optional_fields.into_iter().map(|(prop_name, prop_type)| {
+ quote! {
+ #[doc(hidden)]
+ #vis fn #prop_name(mut self, #prop_name: #prop_type) -> #builder_name<#step_name, #generic_idents> {
+ self.wrapped.#prop_name = #prop_name;
+ self
+ }
+ }
+ });
+
+ let required_prop_fn = required_field.iter().map(|p| {
+ let prop_name = &p.name;
+ let prop_type = &p.ty;
+ let wrapped_name = p.wrapped_name.as_ref().unwrap();
+ let next_step_name = &step_names[step + 1];
+
+ quote! {
+ #[doc(hidden)]
+ #vis fn #prop_name(mut self, #prop_name: #prop_type) -> #builder_name<#next_step_name, #generic_idents> {
+ self.wrapped.#wrapped_name = ::std::option::Option::Some(#prop_name);
+ #builder_name {
+ wrapped: self.wrapped,
+ _marker: ::std::marker::PhantomData,
+ }
+ }
+ }
+ });
+
+ token_stream.extend(quote! {
+ impl #generics #builder_name<#step_name, #generic_idents> #generic_where {
+ #(#optional_prop_fn)*
+ #(#required_prop_fn)*
+ }
+ });
+ }
+ token_stream
+}
diff --git a/crates/props-derive/tests/cases.rs b/crates/props-derive/tests/cases.rs
new file mode 100644
index 000000000..0659ef9b2
--- /dev/null
+++ b/crates/props-derive/tests/cases.rs
@@ -0,0 +1,6 @@
+#[test]
+fn tests() {
+ let t = trybuild::TestCases::new();
+ t.pass("tests/pass.rs");
+ t.compile_fail("tests/fail.rs");
+}
diff --git a/crates/props-derive/tests/fail.rs b/crates/props-derive/tests/fail.rs
new file mode 100644
index 000000000..ec6bf1a46
--- /dev/null
+++ b/crates/props-derive/tests/fail.rs
@@ -0,0 +1,53 @@
+#![recursion_limit = "128"]
+
+use yew::html::Properties;
+use yew_props_derive::Properties;
+
+mod t1 {
+ use super::*;
+ struct Value;
+ #[derive(Properties)]
+ pub struct Props {
+ // ERROR: optional params must implement default
+ value: Value,
+ }
+}
+
+mod t2 {
+ use super::*;
+ #[derive(Properties)]
+ pub struct Props {
+ // ERROR: optional is not a tag
+ #[props(optional)]
+ value: String,
+ }
+}
+
+mod t3 {
+ use super::*;
+ #[derive(Properties)]
+ pub struct Props {
+ #[props(required)]
+ value: String,
+ }
+
+ fn required_props_should_be_set() {
+ Props::builder().build();
+ }
+}
+
+mod t4 {
+ use super::*;
+ #[derive(Properties)]
+ pub struct Props {
+ b: i32,
+ #[props(required)]
+ a: i32,
+ }
+
+ fn enforce_ordering() {
+ Props::builder().b(1).a(2).build();
+ }
+}
+
+fn main() {}
diff --git a/crates/props-derive/tests/fail.stderr b/crates/props-derive/tests/fail.stderr
new file mode 100644
index 000000000..00bb9eb4d
--- /dev/null
+++ b/crates/props-derive/tests/fail.stderr
@@ -0,0 +1,34 @@
+error: expected `props(required)`
+ --> $DIR/fail.rs:21:11
+ |
+21 | #[props(optional)]
+ | ^^^^^
+
+error[E0277]: the trait bound `t1::Value: std::default::Default` is not satisfied
+ --> $DIR/fail.rs:9:14
+ |
+9 | #[derive(Properties)]
+ | ^^^^^^^^^^ the trait `std::default::Default` is not implemented for `t1::Value`
+ |
+ = note: required by `std::default::Default::default`
+
+error[E0599]: no method named `build` found for type `t3::PropsBuilder` in the current scope
+ --> $DIR/fail.rs:35:26
+ |
+28 | #[derive(Properties)]
+ | - method `build` not found for this
+...
+35 | Props::builder().build();
+ | ^^^^^
+
+error[E0599]: no method named `b` found for type `t4::PropsBuilder` in the current scope
+ --> $DIR/fail.rs:49:26
+ |
+41 | #[derive(Properties)]
+ | - method `b` not found for this
+...
+49 | Props::builder().b(1).a(2).build();
+ | ^ help: there is a method with a similar name: `a`
+
+Some errors have detailed explanations: E0277, E0599.
+For more information about an error, try `rustc --explain E0277`.
diff --git a/crates/props-derive/tests/pass.rs b/crates/props-derive/tests/pass.rs
new file mode 100644
index 000000000..fc1013294
--- /dev/null
+++ b/crates/props-derive/tests/pass.rs
@@ -0,0 +1,68 @@
+#![recursion_limit = "128"]
+
+use yew::html::Properties;
+use yew_props_derive::Properties;
+
+mod t1 {
+ use super::*;
+
+ #[derive(Properties)]
+ pub struct Props {
+ value: T,
+ }
+
+ fn optional_prop_generics_should_work() {
+ Props::::builder().build();
+ Props::::builder().value(true).build();
+ }
+}
+
+mod t2 {
+ use super::*;
+
+ struct Value;
+ #[derive(Properties)]
+ pub struct Props {
+ #[props(required)]
+ value: T,
+ }
+
+ fn required_prop_generics_should_work() {
+ Props::::builder().value(Value).build();
+ }
+}
+
+mod t3 {
+ use super::*;
+
+ #[derive(Properties)]
+ pub struct Props {
+ #[props(required)]
+ b: i32,
+ a: i32,
+ }
+
+ fn order_is_alphabetized() {
+ Props::builder().b(1).build();
+ Props::builder().a(1).b(2).build();
+ }
+}
+
+mod t4 {
+ use super::*;
+
+ #[derive(Properties)]
+ pub struct Props
+ where
+ T: Default,
+ {
+ value: T,
+ }
+
+ fn optional_prop_generics_should_work() {
+ Props::::builder().build();
+ Props::::builder().value(true).build();
+ }
+}
+
+fn main() {}
diff --git a/examples/custom_components/src/barrier.rs b/examples/custom_components/src/barrier.rs
index d24bf68e6..dcc606427 100644
--- a/examples/custom_components/src/barrier.rs
+++ b/examples/custom_components/src/barrier.rs
@@ -1,32 +1,23 @@
use crate::button::Button;
-use yew::{html, Callback, Component, ComponentLink, Html, Renderable, ShouldRender};
+use yew::prelude::*;
pub struct Barrier {
limit: u32,
counter: u32,
- onsignal: Option>,
+ onsignal: Callback<()>,
}
pub enum Msg {
ChildClicked,
}
-#[derive(PartialEq, Clone)]
+#[derive(PartialEq, Properties)]
pub struct Props {
pub limit: u32,
- pub onsignal: Option>,
+ #[props(required)]
+ pub onsignal: Callback<()>,
}
-impl Default for Props {
- fn default() -> Self {
- Props {
- limit: 0,
- onsignal: None,
- }
- }
-}
-
-
impl Component for Barrier {
type Message = Msg;
type Properties = Props;
@@ -44,10 +35,8 @@ impl Component for Barrier {
Msg::ChildClicked => {
self.counter += 1;
if self.counter >= self.limit {
- if let Some(ref mut callback) = self.onsignal {
- callback.emit(());
- self.counter = 0;
- }
+ self.onsignal.emit(());
+ self.counter = 0;
}
}
}
diff --git a/examples/custom_components/src/button.rs b/examples/custom_components/src/button.rs
index e7b93a259..4d5ab7de4 100644
--- a/examples/custom_components/src/button.rs
+++ b/examples/custom_components/src/button.rs
@@ -1,27 +1,19 @@
-use yew::{html, Callback, Component, ComponentLink, Html, Renderable, ShouldRender};
+use yew::prelude::*;
pub struct Button {
title: String,
- onsignal: Option>,
+ onsignal: Callback<()>,
}
pub enum Msg {
Clicked,
}
-#[derive(PartialEq, Clone)]
+#[derive(PartialEq, Properties)]
pub struct Props {
pub title: String,
- pub onsignal: Option>,
-}
-
-impl Default for Props {
- fn default() -> Self {
- Props {
- title: "Send Signal".into(),
- onsignal: None,
- }
- }
+ #[props(required)]
+ pub onsignal: Callback<()>,
}
impl Component for Button {
@@ -38,9 +30,7 @@ impl Component for Button {
fn update(&mut self, msg: Self::Message) -> ShouldRender {
match msg {
Msg::Clicked => {
- if let Some(ref mut callback) = self.onsignal {
- callback.emit(());
- }
+ self.onsignal.emit(());
}
}
false
diff --git a/examples/custom_components/src/counter.rs b/examples/custom_components/src/counter.rs
index 52ec4b122..93cd445ff 100644
--- a/examples/custom_components/src/counter.rs
+++ b/examples/custom_components/src/counter.rs
@@ -1,4 +1,4 @@
-use yew::{html, Callback, Component, ComponentLink, Html, Renderable, ShouldRender};
+use yew::prelude::*;
#[derive(PartialEq, Clone)]
pub enum Color {
@@ -7,31 +7,28 @@ pub enum Color {
Blue,
}
+impl Default for Color {
+ fn default() -> Self {
+ Color::Green
+ }
+}
+
pub struct Counter {
value: u32,
color: Color,
- onclick: Option>,
+ onclick: Callback,
}
pub enum Msg {
Increase,
}
-#[derive(PartialEq, Clone)]
+#[derive(PartialEq, Properties)]
pub struct Props {
pub initial: u32,
pub color: Color,
- pub onclick: Option>,
-}
-
-impl Default for Props {
- fn default() -> Self {
- Props {
- initial: 0,
- color: Color::Green,
- onclick: None,
- }
- }
+ #[props(required)]
+ pub onclick: Callback,
}
impl Component for Counter {
@@ -50,9 +47,7 @@ impl Component for Counter {
match msg {
Msg::Increase => {
self.value = self.value + 1;
- if let Some(ref onclick) = self.onclick {
- onclick.emit(self.value);
- }
+ self.onclick.emit(self.value);
}
}
true
diff --git a/examples/custom_components/src/lib.rs b/examples/custom_components/src/lib.rs
index d1cbdb638..7557d23a4 100644
--- a/examples/custom_components/src/lib.rs
+++ b/examples/custom_components/src/lib.rs
@@ -1,12 +1,12 @@
#![recursion_limit = "128"]
-mod counter;
-mod button;
mod barrier;
+mod button;
+mod counter;
-use yew::{html, Component, ComponentLink, Html, Renderable, ShouldRender};
-use counter::{Counter, Color};
use barrier::Barrier;
+use counter::{Color, Counter};
+use yew::prelude::*;
pub struct Model {
with_barrier: bool,
@@ -19,8 +19,7 @@ pub enum Msg {
ChildClicked(u32),
}
-impl Component for Model
-{
+impl Component for Model {
type Message = Msg;
type Properties = ();
@@ -41,17 +40,17 @@ impl Component for Model
self.with_barrier = !self.with_barrier;
true
}
- Msg::ChildClicked(_value) => {
- false
- }
+ Msg::ChildClicked(_value) => false,
}
}
}
impl Renderable for Model {
fn view(&self) -> Html {
- let counter = |x| html! {
-
+ let counter = |x| {
+ html! {
+
+ }
};
html! {
diff --git a/examples/js_callback/Cargo.toml b/examples/js_callback/Cargo.toml
index 5a5137a9a..6abf6189b 100644
--- a/examples/js_callback/Cargo.toml
+++ b/examples/js_callback/Cargo.toml
@@ -6,4 +6,7 @@ edition = "2018"
[dependencies]
yew = { path = "../.." }
-stdweb = "0.4.7"
+stdweb = "^0.4.16"
+
+[target.'cfg(all(target_arch = "wasm32", not(cargo_web)))'.dependencies]
+wasm-bindgen = "0.2"
diff --git a/examples/js_callback/src/lib.rs b/examples/js_callback/src/lib.rs
index b0c2e5401..8950f80d5 100644
--- a/examples/js_callback/src/lib.rs
+++ b/examples/js_callback/src/lib.rs
@@ -1,10 +1,8 @@
-#![recursion_limit="128"]
+#![recursion_limit = "128"]
#![deny(warnings)]
-#[macro_use]
-extern crate stdweb;
-
-use yew::{html, Callback, Component, ComponentLink, Html, Renderable, ShouldRender};
+use stdweb::{_js_impl, js};
+use yew::prelude::*;
pub struct Model {
payload: String,
@@ -18,16 +16,12 @@ pub enum Msg {
AsyncPayload,
}
-#[derive(Default, PartialEq, Eq, Clone)]
-pub struct Props {
- payload: String,
-}
-
impl Component for Model {
type Message = Msg;
- type Properties = Props;
+ type Properties = ();
- fn create(Props { payload }: Self::Properties, link: ComponentLink
) -> Self {
+ fn create(_: Self::Properties, link: ComponentLink) -> Self {
+ let payload = String::default();
let debugged_payload = format!("{:?}", payload);
Self {
payload,
@@ -39,7 +33,15 @@ impl Component for Model {
fn update(&mut self, msg: Self::Message) -> ShouldRender {
use Msg::*;
match msg {
- Payload(payload) => self.change(Self::Properties { payload }),
+ Payload(payload) => {
+ if payload != self.payload {
+ self.debugged_payload = format!("{:?}", payload);
+ self.payload = payload;
+ true
+ } else {
+ false
+ }
+ }
AsyncPayload => {
get_payload_later(self.link.send_back(Msg::Payload));
false
@@ -47,14 +49,8 @@ impl Component for Model {
}
}
- fn change(&mut self, Self::Properties { payload }: Self::Properties) -> ShouldRender {
- if payload == self.payload {
- false
- } else {
- self.debugged_payload = format!("{:?}", payload);
- self.payload = payload;
- true
- }
+ fn change(&mut self, _: Self::Properties) -> ShouldRender {
+ false
}
}
@@ -73,7 +69,7 @@ impl Renderable for Model {
{ "Get the payload later!" }
- { nbsp(self.debugged_payload.as_ref()) }
+ { nbsp(self.debugged_payload.as_str()) }