Skip to content

CHANGELOG.md

Latest commit

 

History

History
131 lines (90 loc) · 7.1 KB

CHANGELOG.md

File metadata and controls

131 lines (90 loc) · 7.1 KB

Changelog

Breaking changes in bold.

You can now sponsor Laminar / Airstream / Waypoint development!

master

  • Build: Upgrade to Laminar v18.0.0-M2

  • API: / endOfSegments the default behaviour now with URL-DSL v0.7.0.

    • Migration: To retain existing behaviour, for your segment paths that don't end in / endOfSegments, append / ignoreRemainingSegments to the path; and remove / endOfSegments from any segment paths that do have it.

  • API: Replace Router.initialUrl constructor param with a by-name currentUrl arg (and more).

    • With typical setup, the default value should be used, just as before. currentUrl lets you modify the URL seen by Waypoint, e.g. if any cleanup or corrections are needed.

  • Fix: Allow using fragment paths after # that don't start with '/'. Previously Waypoint would fail to match such URLs. This fix might be needed e.g. to handle Keycloak.js appending #state=... to your URLs.

  • Naming: Route.matchRelativeUrl -> matchAbsoluteUrl (it was incorrectly named)

v10.0.0-M1 – Apr 2025

  • New: Overload for router.navigateTo that accepts Signal[Page] instead of Page.
  • New: Router[Page] now extends traits Router.In[-Page], Router.Out[+Page], and Router.All[Page] that make it easier to abstract over routing functionality. For example, if you want to write a helper that needs contravariance in Page, you can use Router.In[-Page] instead of the invariant Router. Thanks, @arturaz!
  • New: All errors thrown by waypoint are now of new type WaypointException, and their message has [Waypoint] prepended to it. Thanks, @arturaz!
  • Fix: URL matching bug fix for Tauri (#28). Thanks, @arturaz!

v9.0.0 – Dec 2024

  • Build: Waypoint depends on Laminar now (not just Airstream)
    • New: navigateTo example method from the docs is now available on Router
      • Unlike the previous example in the docs, it does not reset scroll position – do that yourself by observing currentPageSignal
    • Migration: Router constructor is now a single argument list, popStateEvents and owner now have default values.
  • New: Total and Partial route types, to improve type-safety for the total routes – by Artūras Šlajus – thank you!
    • New: route.argsFromPageTotal and route.relativeUrlForPage available on Route.Total subtype of Route.
    • Migration: If Route.static complains that it can't find ValueOf for your page type, it's because your type is not a singleton like object LoginPage, so we can't make a total route for it. Use Route.staticPartial instead.
  • New: Router.replacePageTitle
  • Fix: SplitRender.signal should be a lazy val, not def.
  • Build: scalamft config
  • Note: Airstream has a new Split by pattern match feature that you may want to use instead of SplitRender in Scala 3. It's similar in functionality, but macro-based, and more robust.

v8.0.1 – Aug 2024

  • Build: Update URL DSL to 0.6.2
    • Fixed a case with listParam where matching failed if no query parameters were provided in the URL, whereas it should have matched as Nil. Thanks, @arturaz!

v8.0.0 – May 2024

  • Build: Update Airstream to 17.0.0, URL DSL to 0.6.1
  • Build: Fix source maps URLs
  • Misc: Unrouted page exception now includes the exact faulty page in the message

v7.0.0 – Jul 2023

  • Build: Update Airstream to 16.0.0

v6.0.0 – Mar 2023

  • Build: Update Airstream to 15.0.0, URL DSL to 0.6.0
  • Fix: collectStatic and collectStaticStrict now match pages using == equality instead of ClassTag. This fixes matching of Scala 3 enum values.

v6.0.0-M4 – Feb 2023

  • Build: Update Airstream to 15.0.0-M4

v6.0.0-M3 – Jan 2023

  • Build: Update Airstream to 15.0.0-M3

v6.0.0-M2 – Jan 2023

  • Build: Update Airstream to 15.0.0-M2

v6.0.0-M1 – Jan 2023

  • Build: Update Airstream to 15.0.0-M1, URL-DSL to 0.5.0, etc.
  • Naming: $popStateEvent -> popStateEvents
  • Naming: $currentPage -> currentPageSignal
  • Naming: $view -> signal
  • API: Use Tuplez.unapply. Fixes this issue. Thanks, @yurique!
  • API: Non-optional query params now match empty strings, e.g. url?param= and even url?param. See this issue. Thanks, @i10416
  • New: collectStaticStrict for when you want to cache the element.

v0.5.0 – Nov 2021

  • Build: Update Airstream to 0.14.0, bump Scala to 2.13.6 and 3.0.2, Scala.js to 1.7.1, uPickle to 1.4.2

v0.4.2 – July 2021

  • Fix: Work around location.origin being "null" for file:// URLs in Firefox.

v0.4.1 – July 2021

  • Do not use – this version is similar to v0.4.2, but there's a typo in one of the error messages

v0.4.0 – May 2021

  • Fix: When initializing the router, do not update the initial URL to the canonical URL of the initial page
    • Keep the original URL with whatever extraneous query params it might have, to give any third party tools you might be using a chance to look at them
  • Fix: Respond to hashChange events properly
  • New: Base path and fragment matching
    • You can now match routes like /#/note/123 instead of /note/123 by providing basePath = Route.fragmentBasePath to Route constructors
    • You can also use hash routing on a file:// URL now
  • New: Basic route helpers to match URL fragments (text after #)

v0.3.0 – Feb 2021

  • New: Routes can match types partially now (thanks, @pbuszka!)
    • New route creation methods with PF suffix
    • route.argsFromPage returns an Option now
  • New: Customizable error handling
    • You can now specify fallbacks for URLs and page states that fail to match
    • You can now force-render a page without changing URL (useful for rendering full page error screens)
    • Router constructor arguments have changed and are now spread across two argument lists, and some arguments have defaults now
  • New: ContextRouteBuilder (thanks, @pbuszka!)
    • Provides a convenient way to encode URL params like "lang" or "version" that are shared among a set of pages & routes
  • API: Use PatternArgs alias for URL DSL's UlrMatching type
  • Build: Update Airstream to 0.12.0
  • Build: Update url-dsl to 0.3.2
  • Build: Update sbt to 1.4.7

v0.2.0 – Aug 2020

  • API: Waypoint does not depend on Laminar anymore
    • Add $popStateEvent to Router constructor
    • Migration: You should provide $popStateEvent = windowEvents.onPopState if using Laminar

v0.1.0 – Mar 2020

Initial release!