✨ 0.7.0

Release post: https://sycamore-rs.netlify.app/news/announcing-v0.7.0

• ⚡️ Features

  • Implement TryFromSegments for T: Route. This allows the creation of nested routers. See the docs for more information about usage.
  • Make parenthesis optional in cloned! macro. The following syntax is now accepted, in addition to the old syntax:

    // Before
    cloned!((my, variables, to, clone) => move || { ... })
    // After
    cloned!(my, variables, to, clone => move || { ... })

  • Builder API. Check out the hello-builder example for more usage details.
  • Make wasm-bindgen-interning a feature. This feature is enabled by default but can be opted-out which would disable wasm-bindgen/enable-interning. Opting-out can lead to a slight decrease in binary size at the cost of performance.
  • Introduce render_get_scope function. This allows accessing (and disposing of) the ReactiveScope created by the render function.
  • Hydration support. To enable hydration, replace calls to render and render_to with hydrate and hydrate_to.
  • Add #[track_caller] to use_context. This makes it much easier to debug the "context not found for type" error.
  • Better debugging utilities for inspecting the ReactiveScope hierarchy.

• 🛠 Fixes

  • Prevent data binding from panicking when not in browser.
  • Extend ReactiveScope into scopes that are siblings.
  • Fix Lerp implementation for integers.
  • Fix context API not working through Indexed and Keyed.
  • Update TodoMVC example to use context API.
  • Remove autocomplete from the list of boolean attributes for codegen.
  • Fix parenthesizing of expressions in view! macro interpolation syntax.
  • Fix context API when effects are re-executed.
  • Allow constant generics to be used with #[component] macro.

• 📃 Documentation

  • Add a note in the docs about Trunk CSS support.
  • Fix typo in README.md.

• Internal

  • Collect code coverage in CI.
  • Deprecate create_root in favor of create_scope.
  • Fix website npm build script.

• 🚨 BREAKING CHANGES

  • Refactor GenericNode and introduce Html trait. Add IS_BROWSER constant to Html.. For projects that target HTML, it is recommended to use the Html trait instead of GenericNode. This will ensure that it cannot be used on rendering backends that are not for HTML. To check if code is executing on the browser, access the Html::IS_BROWSER constant on the generic rendering backend. This also slightly changes the GenericNode interface which is why it is a breaking change but would most likely not influence you.
  • Make GenericNode generic over the event type. The event type is now an associated type to allow rendering backends to use another type from web_sys::Event.
  • Rename Template to View and template! to view!. For most cases, a simple search-and-replace will suffice, replacing all instances of Template to View and all instances of template! to view!.
  • Rename StateHandle to ReadSignal. The old name was somewhat confusing and did not reflect that StateHandle was just a read-only signal.

✨ 0.6.3

• 🛠 Fixes

  • Respect basename when navigating using router.

✨ 0.6.2

• ⚡️ Features

  • Add GenericNode::remove_property method.
  • Add node! macro for creating a single node.

• 🛠 Fixes

  • Do not strip leading / from pathname. This fixes an issue with the router on Firefox when navigating to the index page.

• Internal

  • Remove ToTokens impl for TagName.

✨ 0.6.1

• 🛠 Fixes

  • Disable full feature on syn to reduce compile times.
  • Use a global HashSet for void elements lookup in SSR.
  • Remove part of formatting machinery from sycamore and sycamore-reactive to reduce binary size.
  • Fix panic on updating dynamic node inside a template fragment.
  • Implement Default for Signal.
  • Implement Default for StateHandle.

• 📃 Documentation

  • Update docs to use boolean for disabled attribute on button.
  • Add documentation on topological dependency tracking.

✨ 0.6.0

Release post: https://sycamore-rs.netlify.app/news/announcing-v0.6.0

• ⚡️ Features

  • Add integrations for sycamore-router.
  • Added dangerously_set_inner_html special attribute to html elements. This allows directly setting an element's inner html without going through a NodeRef and manually calling .set_inner_html().
  • Implement Portals. Portals allow adding nodes to elements that are in another tree.
  • Allow instantiating components with the Component trait. You can now also create components that are generic over another component. This pattern can be seen in the higher-order-components example.
  • Respect base html tag in router.
  • Dark mode on website!
  • create_reducer hook. The create_reducer hook is an alternative to Signal::new. It allows you to use a reducer function to get the next state from the previous state.

    enum Msg {
        Increment,
        Decrement,
    }
    let (state, dispatch) = create_reducer(0, |state, msg: Msg| match msg {
        Msg::Increment => *state + 1,
        Msg::Decrement => *state - 1,
    });

  • Opt out of router by using rel="external" on an anchor tag. Adding rel="external" to an anchor tag will use the browser's default navigation behavior.

    template! {
        a(href="path", rel="external") { "Link" }
    }

• 🛠 Fixes

  • Fix logic error in reconcile_fragments.
  • Fix grammar on website index page.
  • Scroll to top when navigating to a page.
  • Use ahash instead of default SipHash for better performance.
  • Explicitly define MSRV to 1.53 and run CI in a matrix.
  • Remove inline JS snippet. This removes the need to load an extra JS file before Sycamore can start.
  • Add some UI tests for #[component] attribute macro.
  • Generate a sitemap.xml for the website.
  • Fix broken link to the reactivity page on the website index page.
  • Explain that Trunk needs a index.html file in Hello World docs.
  • Remove internal Rc from DomNode. This significantly improves performance and memory usage. See the PR for benchmarks.
  • Optimize the website with wasm-opt to reduce binary size.
  • Optimize create_effect.
  • Fix SsrNode's implementation of remove_child removing two children instead of just one.
  • Hold a backlink for each ReactiveScope to its parent scope. This fixes a bug where use_context could only access the context on the first render and would panic on subsequent accesses.
  • Remove dependency on chrono. This was replaced with direct access to browser APIs to reduce the number of dependencies and thus to improve build times.
  • Replace internal usage of .unwrap() with .unwrap_throw(). Slightly improves binary sizes.
  • Derive Clone for sycamore_router path types.
  • Update todomvc example with latest features.
  • Fix router not actually parsing identifiers. Fixes a bug where a dynamic parameter followed by a dynamic segment would parse as a single segment.
  • Build rustdocs in CI. The API documentation for the master branch is available at sycamore-rs.netlify.app/api.
  • Reorganize documentation a bit.

• 🚨 BREAKING CHANGES

  • Extract reactive primitives into separate crate sycamore-reactive. Reactive primitives are now re-exported in the sycamore crate to avoid adding new dependencies to your project. It is also now possible to use reactive primitives without using sycamore by directly depending on sycamore-reactive.
  • Rename sub-module sycamore::rx to sycamore::reactive. rx might be ambiguous with Rx family of libraries. Renaming to reactive makes it clear that it works differently from Rx libraries.
  • Refactored router with new API. See the new documentation for more details.
  • Support boolean attributes. Some attributes now expect a bool instead of impl ToString. This also fixes an issue where previously, attributes couldn't be removed directly from the template! macro.

    // Before
    template! {
        input(type="checkbox", checked="") { "Checkbox" }
    }
    // After
    template! {
        input(type="checkbox", checked=true) { "Checkbox" }
    }

✨ 0.5.2

Changelog

• ⚡️ Features

  • Context API: introducing ContextProvider and use_context [[@lukechu10], #169]

• 🛠 Fixes

  • Router should not prevent default if meta keys are held down [[@baile320], #165]
  • Remove some optional tags on dependencies [[@lukechu10], #167]
  • Explicitly enable std feature in indexmap to prevent compile error [[@Gearme], #170]
  • Do not panic when map_keyed is updated with same data in debug mode [[@lukechu10], #173]

• 🛠 Internal Fixes and Improvements

  • Add some integration tests for StaticRouter [[@lukechu10], #168]
  • Fix intra-doc link [[@tshepang], #162]
  • Refactor sycamore-macro static text and splices [[@lukechu10], #175]

• 📃 Documentation

  • Simplify cargo command in documentation [[@tshepang], #163]
  • Fix link to book in website version selector [[@lukechu10], #166]

• 🚅 Performance Improvements

  • Performance tweaks [[@lukechu10], #171]

✨ 0.5.1

Changelog

• 🛠 Fixes

  • Remove Hash trait bound from T in Keyed [[@lukechu10], #148]

• 🛠 Internal Fixes and Improvements

  • Add news section to website with v0.5.0 release post [[@lukechu10], #149, #149]
  • Fix typo in v0.5.0 release post [[@tshepang], #156]
  • Add versioned docs to website [[@lukechu10], #160]

• 🚅 Performance Improvements

  • Reduce allocations when creating Templates [[@lukechu10], #143]
  • Do not create effects when splice is static (using simple heuristic) [[@lukechu10], #155]
  • Set className directly instead of calling setAttribute [[@lukechu10], #157]
  • Optimize create_effect [[@lukechu10], #159]

✨ 0.5.0

Release post: https://sycamore-rs.netlify.app/news/announcing-v0.5.0

Changelog

• ⚡️ Features

  • Tweened signals [[@lukechu10], #86]
  • Add more easing functions [[@tmpr], #90]
  • Document fragments in the template! macro. template! can now accept the following input:

    template! {
        p { "First" }
        p { "Second" }
    }

    template! {} // empty template

    [[@lukechu10], #89]
  • 2-way data binding for certain supported props [[@lukechu10], #93]
  • Allow generic component's type parameters to be inferred from context [[@lukechu10], #100]
  • Refactored Template (renamed from TemplateResult) to allow make the template system more flexible. It is now possible to imperatively construct Templates from raw dom nodes, Vecs, and closures [[@lukechu10], #104]
  • Sycamore router [[@lukechu10], #118]
  • Temporary "fake" hydration [[@lukechu10], #101]
  • Router use anchor tags (<a>) instead of Link components [[@lukechu10], #128]
  • Reactive scope dependency count utility function [[@lukechu10], #144]

• 🛠 Fixes

  • Implement missing operations on SsrNode [[@lukechu10], #82, #138]
  • Remove warning when effects are created outside of a reactive scope [[@JuanMarchetto], #95]
  • Do not assume Signal is valid for entire duration of the effect and make effect triggers deterministic (outer effects rerun first) [[@lukechu10], #145]
  • Eagerly evaluate dynamic Templates with create_memo [[@lukechu10], #146]

• 📃 Documentation

  • Host documentation on website [[@lukechu10], #83]
  • Write documentation [[@lukechu10], #87, #111, #133]
  • Fix CHANGELOG.md typo [[@Riey], #102]
  • Style documentation website with TailwindCSS [[@lukechu10], #117]
  • Use router for documentation website header [[@lukechu10], #132]
  • Extract outline from markdown and new index page [[@lukechu10], #134]
  • Move documentation under /docs/* path [[@lukechu10], #139]

• 🛠 Internal Fixes and Improvements

  • Build website in GitHub Actions [[@lukechu10], #84]
  • Run unit tests in Miri to catch memory errors [[@lukechu10], #91]
  • Update Trunk to v0.11.0 [[@lukechu10], #96]
  • Improve documentation website lighthouse score [[@lukechu10], #97]
  • Setup gitpod.io configuration to make it easier to contribute [[@lukechu10], #98]
  • Update wasm-bindgen to v0.2.74 in .gitpod.Dockerfile [[@lukechu10], #108]
  • Update links to git repository to point to sycamore-rs/sycamore [[@lukechu10], #110]
  • Add micro-benchmarks for map_indexed and map_keyed [[@lukechu10], #115]
  • Run js-framework-benchmark in GitHub Actions. Pull requests with the performance tag will automatically trigger a benchmark run [[@lukechu10], #114]
  • Fix branch naming to work with continuous benchmark [[@lukechu10], #116]
  • Various performance improvements [[@lukechu10], #126]
  • Google search console verification file [[@lukechu10], #135]
  • Get NodeId for DomNode lazily to improve performance when Hash is not used [[@lukechu10], #136]
  • Do not insert unnecessary marker nodes [[@lukechu10], #137]
  • Remove unnecessary Rc<RefCell<_>>s [[@lukechu10], #141]
  • Cache window.document since it is frequently used to prevent going through JS interop [[@lukechu10], #142]

• ⚠ BREAKING CHANGES

  • Abstraction over rendering backend! This introduces the concept of GenericNode which is a trait to access the underlying rendering backend. Currently, Sycamore ships with DomNode and SsrNode out-of-the-box for rendering the the browser DOM and to a static string respectively. Components should now be generic over G: GenericNode to be able to render to multiple backends [[@lights0123], #67]
  • Require using the #[component(_)] attribute macro for defining components. This changes the component syntax to:

    #[component(MyComponent<G>)]
    fn my_component() -> Template<G> {
        todo!()
    }

    The #[component(_)] macro generates a struct under the hood that implements the Component trait for improved type safety. This also means that you no longer need #[allow(non_snake_case)] in your code! [[@lukechu10], #70, #92]
  • Rename Owner to ReactiveScope [[@lukechu10], #99]
  • Renamed crate from maple-core to sycamore and maple-core-macro to sycamore-macro. Also renamed all instances of "Maple" to "Sycamore" [[@lukechu10], #109]
  • Rename TemplateResult to Template [[@lukechu10], #112]
  • Rename reactive sub-module to rx [[@lukechu10], #113]
  • Remove render functions (render, render_to, render_to_string, etc...) from prelude. These functions are generally only called once in a Sycamore app so they do not belong in the prelude [[@lukechu10], #140]

✨ 0.4.3

Changelog

• ⚡️ Features

  • Support '-' in attribute names. This makes the following syntax valid:

    template! {
        button(aria-hidden="true")
    }

    [[@lukechu10], #79]

• 🛠 Fixes

  • Delete removed nodes in Keyed first before adding new nodes and moving existing nodes [[@lukechu10], #77]

✨ 0.4.2

Changelog

• 🛠 Fixes

  • Fix Keyed iteration (hopefully for the last time) when moving nodes already inserted [[@lukechu10], #75]