#[component] macro (#92)

* Move template! into sub-module * Move ui tests into template/ folder * Add component macro * Fix intra-doc links * Add component! to prelude * Implement component macro * Use #[component] attribute macro * Fix ssr benchmarks * Fix tests * Update documentation
sycamore-rs · Apr 7, 2021 · 2ef0a44 · 2ef0a44
1 parent 5644494
commit 2ef0a44
Show file tree

Hide file tree

Showing 44 changed files with 743 additions and 466 deletions.
diff --git a/docs/markdown/advanced/higher_order_components.md b/docs/markdown/advanced/higher_order_components.md
diff --git a/docs/markdown/basics/components.md b/docs/markdown/basics/components.md
@@ -1,7 +1,9 @@
 # Components
 
-Components in `maple` are simply functions that return `TemplateResult<G>`.
-They receive their props through function arguments.
+Components in `maple` are structs that implement `Component`. A component can automatically be
+created with the `#[component(ComponentName<G>)]` attribute on a function.
+
+Components receive their props through function arguments.
 
 For components to automatically react to prop changes, they should accept a prop with type `StateHandle<T>` and call the function in the `template!` to subscribe to the state.
 A `StateHandle<T>` is just a readonly `Signal<T>`.
@@ -11,14 +13,10 @@ Getting a `StateHandle<T>` from a `Signal<T>` is easy. Just call the `.handle()`
 Here is an example of a simple component that displays the value of its prop:
 
 ```rust
-// This is temporary and will later be removed.
-// Currently, the template! macro assumes that all
-// components start with an uppercase character.
-#![allow(non_snake_case)]
-
 use maple_core::prelude::*;
 
-fn MyComponent<G: GenericNode>(value: StateHandle<i32>) -> TemplateResult<G> {
+#[component(MyComponent<G>)]
+fn my_component(value: StateHandle<i32>) -> TemplateResult<G> {
     template! {
         div(class="my-component") {
             "Value: " (value.get())

diff --git a/docs/src/content.rs b/docs/src/content.rs
@@ -8,7 +8,8 @@ extern "C" {
     fn highlight_all();
 }
 
-pub fn Content<G: GenericNode>() -> TemplateResult<G> {
+#[component(Content<G>)]
+pub fn content() -> TemplateResult<G> {
     let location = web_sys::window()
         .unwrap()
         .document()

diff --git a/docs/src/header.rs b/docs/src/header.rs
@@ -1,6 +1,7 @@
 use maple_core::prelude::*;
 
-pub fn Header<G: GenericNode>() -> TemplateResult<G> {
+#[component(Header<G>)]
+pub fn header() -> TemplateResult<G> {
     template! {
         header {
             nav(class="navbar navbar-expand-sm navbar-dark bg-dark") {

diff --git a/docs/src/index.rs b/docs/src/index.rs
@@ -1,6 +1,7 @@
 use maple_core::prelude::*;
 
-pub fn Index<G: GenericNode>() -> TemplateResult<G> {
+#[component(Index<G>)]
+pub fn index() -> TemplateResult<G> {
     template! {
         div {
             h1 {

diff --git a/docs/src/main.rs b/docs/src/main.rs
@@ -1,13 +1,12 @@
-#![allow(non_snake_case)]
-
 mod content;
 mod header;
 mod index;
 mod sidebar;
 
 use maple_core::prelude::*;
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let location = web_sys::window()
         .unwrap()
         .document()

diff --git a/docs/src/sidebar.rs b/docs/src/sidebar.rs
@@ -1,6 +1,7 @@
 use maple_core::prelude::*;
 
-pub fn Sidebar<G: GenericNode>() -> TemplateResult<G> {
+#[component(Sidebar<G>)]
+pub fn sidebar() -> TemplateResult<G> {
     template! {
         div(class="p-3 bg-white", style="min-width: 180px") {
             ul(class="list-unstyled ps-0") {
@@ -69,9 +70,6 @@ pub fn Sidebar<G: GenericNode>() -> TemplateResult<G> {
                         a(class="btn btn-sm btn-light btn-block", href="/advanced/js_interop") {
                             "JS Interop"
                         }
-                        a(class="btn btn-sm btn-light btn-block", href="/advanced/higher_order_components") {
-                            "Higher-Order Components"
-                        }
                     }
                 }
                 li(class="mb-1") {

diff --git a/examples/components/src/main.rs b/examples/components/src/main.rs
@@ -1,8 +1,7 @@
-#![allow(non_snake_case)]
-
 use maple_core::prelude::*;
 
-fn MyComponent<G: GenericNode>(num: StateHandle<i32>) -> TemplateResult<G> {
+#[component(MyComponent<G>)]
+fn my_component(num: StateHandle<i32>) -> TemplateResult<G> {
     template! {
         div(class="my-component") {
             "My component"
@@ -14,7 +13,8 @@ fn MyComponent<G: GenericNode>(num: StateHandle<i32>) -> TemplateResult<G> {
     }
 }
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let state = Signal::new(1);
 
     let increment = cloned!((state) => move |_| {

diff --git a/examples/counter/src/main.rs b/examples/counter/src/main.rs
@@ -1,8 +1,7 @@
-#![allow(non_snake_case)]
-
 use maple_core::prelude::*;
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let counter = Signal::new(0);
 
     create_effect(cloned!((counter) => move || {

diff --git a/examples/hello/src/main.rs b/examples/hello/src/main.rs
@@ -1,10 +1,9 @@
-#![allow(non_snake_case)]
-
 use maple_core::prelude::*;
 use wasm_bindgen::JsCast;
 use web_sys::{Event, HtmlInputElement};
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let name = Signal::new(String::new());
 
     let handle_change = cloned!((name) => move |event: Event| {

diff --git a/examples/ssr/src/main.rs b/examples/ssr/src/main.rs
@@ -1,8 +1,7 @@
-#![allow(non_snake_case)]
-
 use maple_core::prelude::*;
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let name = Signal::new(String::new());
 
     let handle_change = move |_| unreachable!();

diff --git a/examples/todomvc/src/copyright.rs b/examples/todomvc/src/copyright.rs
@@ -1,6 +1,7 @@
 use maple_core::prelude::*;
 
-pub fn Copyright<G: GenericNode>() -> TemplateResult<G> {
+#[component(Copyright<G>)]
+pub fn copyright() -> TemplateResult<G> {
     template! {
         footer(class="info") {
             p { "Double click to edit a todo" }

diff --git a/examples/todomvc/src/footer.rs b/examples/todomvc/src/footer.rs
@@ -2,7 +2,8 @@ use maple_core::prelude::*;
 
 use crate::{AppState, Filter};
 
-pub fn Footer<G: GenericNode>(app_state: AppState) -> TemplateResult<G> {
+#[component(Footer<G>)]
+pub fn footer(app_state: AppState) -> TemplateResult<G> {
     let items_text = cloned!((app_state) => move || {
         match app_state.todos_left() {
             1 => "item",
@@ -24,7 +25,7 @@ pub fn Footer<G: GenericNode>(app_state: AppState) -> TemplateResult<G> {
                 span { " " (items_text()) " left" }
             }
             ul(class="filters") {
-                Indexed(IndexedProps {
+                Indexed<_, _>(IndexedProps {
                     iterable: Signal::new(vec![Filter::All, Filter::Active, Filter::Completed]).handle(),
                     template: cloned!((app_state2) => move |filter| {
                         let selected = cloned!((app_state2) => move || filter == *app_state2.filter.get());

diff --git a/examples/todomvc/src/header.rs b/examples/todomvc/src/header.rs
@@ -4,7 +4,8 @@ use web_sys::{Event, HtmlInputElement, KeyboardEvent};
 
 use crate::AppState;
 
-pub fn Header<G: GenericNode>(app_state: AppState) -> TemplateResult<G> {
+#[component(Header<G>)]
+pub fn header(app_state: AppState) -> TemplateResult<G> {
     let value = Signal::new(String::new());
 
     let input_ref = NodeRef::<G>::new();

diff --git a/examples/todomvc/src/item.rs b/examples/todomvc/src/item.rs
@@ -4,7 +4,15 @@ use web_sys::{Event, HtmlInputElement, KeyboardEvent};
 
 use crate::{AppState, Todo};
 
-pub fn Item<G: GenericNode>(todo: Signal<Todo>, app_state: AppState) -> TemplateResult<G> {
+pub struct ItemProps {
+    pub todo: Signal<Todo>,
+    pub app_state: AppState,
+}
+
+#[component(Item<G>)]
+pub fn item(props: ItemProps) -> TemplateResult<G> {
+    let ItemProps { todo, app_state } = props;
+
     let title = cloned!((todo) => move || todo.get().title.clone());
     let completed = create_selector(cloned!((todo) => move || todo.get().completed));
     let id = todo.get().id;

diff --git a/examples/todomvc/src/list.rs b/examples/todomvc/src/list.rs
@@ -3,7 +3,8 @@ use web_sys::HtmlInputElement;
 
 use crate::{AppState, Filter};
 
-pub fn List<G: GenericNode>(app_state: AppState) -> TemplateResult<G> {
+#[component(List<G>)]
+pub fn list(app_state: AppState) -> TemplateResult<G> {
     let todos_left = create_selector(cloned!((app_state) => move || {
         app_state.todos_left()
     }));
@@ -40,10 +41,10 @@ pub fn List<G: GenericNode>(app_state: AppState) -> TemplateResult<G> {
             label(for="toggle-all")
 
             ul(class="todo-list") {
-                Keyed(KeyedProps {
+                Keyed<_, _, _, _>(KeyedProps {
                     iterable: filtered_todos,
                     template: move |todo| template! {
-                        crate::item::Item(todo, app_state.clone())
+                        crate::item::Item(crate::item::ItemProps { todo, app_state: app_state.clone() })
                     },
                     key: |todo| todo.get().id,
                 })

diff --git a/examples/todomvc/src/main.rs b/examples/todomvc/src/main.rs
@@ -1,5 +1,3 @@
-#![allow(non_snake_case)]
-
 mod copyright;
 mod footer;
 mod header;
@@ -132,7 +130,8 @@ impl Filter {
 
 const KEY: &str = "todos-maple";
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let local_storage = web_sys::window()
         .unwrap()
         .local_storage()

diff --git a/examples/tweened/src/main.rs b/examples/tweened/src/main.rs
@@ -1,11 +1,10 @@
-#![allow(non_snake_case)]
-
 use std::time::Duration;
 
 use maple_core::reactive::Tweened;
 use maple_core::{easing, prelude::*};
 
-fn App<G: GenericNode>() -> TemplateResult<G> {
+#[component(App<G>)]
+fn app() -> TemplateResult<G> {
     let progress = Tweened::new([0.0, 1.0], Duration::from_millis(250), easing::quad_out);
     let progress0 = progress.clone();
     let progress1 = progress.clone();

diff --git a/maple-core-macro/src/component.rs b/maple-core-macro/src/component.rs