# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [7.5.0] - 2026-01-31 ### Added - Added `x-run` directive to conditionally execute embedded scripts in templates. See [README](./README.md#x-run-directive). Thanks to @boustanihani for the suggestion (#84) ## [7.4.1] - 2026-01-30 ### Fixed - Scope of template is no longer dismissed when a target element is specified. (issue introduced in [7.3.1]) ## [7.4.0] - 2026-01-30 ### Changed - Programmatically added routes will have their templates added as actual template elements at the end of the body. Now they also use the `x-template` directive, streamlining all template logic there. This should have no impact on existing sites. - Programmatic templates no longer throws an error when a targetID is not set through options or globally, as they will just be rendered next to their created template element ie. at the bottom of the body tag. - removing a route with a template now removes the template. ### Fixed - Programmatically added templates will now correctly remove when switching to a different route. - Preload modifier/option now take precedence over global setting. - Proper clean up for different cases when directives are removes. ### Removed - Removed properties related to programmatic templates in the [Route Object](./README.md##route-object), these were exposed but were internal so there are no breaking changes in this regard. ## [7.3.1] - 2026-01-29 ### Fixed - Fixed embedded scripts not working correctly in programmatic templates (#81) - Templates with a specified target element now have access to the Alpine data scope of that element rather than the scope of the template element. - Programmatic templates now access to the data scope of their target element. ## [7.3.0] - 2025-10-30 ### Added - Added `PineconeRouter.match` method that allows checking routes externally using Javascript. (#82) ### Fixed - Fixed embeded scripts not running when adding routes using `PineconeRouter.add` (Fix #81) ## [7.2.0] - 2025-06-09 ### Added - Added [`Settings.pushState`](./README.md#settings-object) boolean property to allow disabling of browser history updates. ie. no changes to the URL when navigating. Built-in [NavigationHistory](./README.md#navigation-history) can be used in this case. ## [7.1.3] - 2025-06-05 ### Fixed - Fixed basePath not added to history path ([#76](https://github.com/pinecone-router/router/issues/76)) ## [7.1.2] - 2025-06-03 ### Fixed - Fixed context.path includes query params after navigate() is called [#73](https://github.com/pinecone-router/router/issues/73) ## [7.1.0] - 2025-05-10 ### Added - Added `Settings.fetchOptions` property as an object to be passed to every template fetch request including preloads. (Addresses [#72](https://github.com/pinecone-router/router/issues/72)) ## [7.0.3] - 2025-04-24 ### Fixed - Fixed interpolating templates not clearing when navigating to a different route - Fixed hash routing not working with github pages ### Added - Settings.basePath now works with hash routing, by adding the basePath to template urls automatically. ## [7.0.2] - 2025-04-11 ### Fixed - Fixed loading not ending when there are no templates or handlers. ## [7.0.1] - 2025-04-11 ### Fixed - Fixed path not added to NavigationHistory on first page load. ## [7.0.0] - 2025-04-11 This is release contains a major overhaul to the codebase, code structure and quality improvements, and better Tyepscript support. Therefore, 7.0 contains some changes to the way you use Pinecone Router which are documented in detail below. Also, with this release, I've sunset the Middlewares feature which proved to be not as useful as I thought it would be long back in 2021!. Their purpose has been very well accomplished with handlers for a while now, but only now did I really give it the thought to make such a decision. I continue to support Pinecone Router within my capacities, and this refactor will let me have easier time finding the issues as they come up, and implement more features if needed. And hopefully even make it less intimidating for contributors to do so as well! For a more concise upgrade guide, [look here](./upgrade_to_v7.md) ### Added - Added `$params` magic helper. - Added [`$history`](./README.md#navigation-history) magic helper to access history related methods and properties. - Added support for multiple-child templates. - You can include as many root elements inside the template file as you want. - Added support for multiple scripts inside the template. - Added support for params in template urls (interpolation) for routes added [programmatically](./README.md#adding--removing-routes-with-javascript) - Added ability to name routes with the `x-route:name="...."` syntax. See: [Named Routes](./README.md#named-routes) - Added [`Settings.preload`](./README.md#settings) to enable preloading all templates. - Added proper priority option to preloading requests, they are now of 'low' priority rather than the previous default of 'high'. - Preloading now waits for the first page to be fully rendered before starting. - Added reactive [`PineconeRouter.loading`](./README.md#pineconerouter-object) boolean property set to true when loading. - Added an [AbortController](AbortController) passed to [handlers](./README.md#handler-arguments), for better experience. - You can now pass data to the next handler by simply returning it. - Added a `HandlerContext.data` field inside the [context object passed to handlers](./README.md#handler-arguments), which includes the returned data by the previous handler, if any. - Added support for [extension param modifier](./README.md#route-matching): - [`Settings.basePath`](./README.md#settings) is now automatically added to the route path. - This means if you set the `basePath` to `/parent`, you can now just write `x-route="/"` and `x-route="/about"` rather than `x-route="/parent"` and `x-route="/parent/about"`. - [`Settings.basePath`](./README.md#settings) is now automatically added to the template URLS. - Added proper Typescript types for all parts of the router. - Added unit tests for some parts of the router using Bun. ### Changed - Instead of providing the context object, `$router` now does what it says and provides [`PineconeRouter object`](./README.md#pineconerouter-object) . - [inline templates](./README.md#inline-templates) now must use an empty `x-template` directive. - This also support `x-template.target`. - This change was made to separate template code from `x-route`, although it was handy, this change results in cleaner and more concise code. - `Context.route` is now a [Route object](./README.md#route-object) instead of a `Route.path` string. - Changed [PineconeRouter.settings](./README.md#pineconerouter-object) from a [Settings object](./README.md#settings-object) to a function that returns the `Settings` object and takes `Partial` object in order to configure. [See more](./README.md#settings) - During navigation—ie while handlers are being executed—the global context object wont be updated until the handlers are finished. - This means handlers must now use the provided context object, if they didn't before for whatever reason. - The navigation methods `navigate|back|forward` etc. are no longer part of the context object. - Instead use `$router.navigate`, `this.$router.navigate`, `window.PineconeRouter.navigate`, or `Alpine.$router.navigate` etc. - Renamed `Settings.templateTargetId` to `Settings.targetID` - Renamed RouteOptions.templateTargetId to `RouteOptions.targetID`. - Renamed `Settings.interceptLinks` to `Settings.handleClicks` to clearly represent what it does. - Templates will not be automatically hidden until the handlers are done, meaning the previous template will stay visible while next route's handlers are running. - This means you will not get an empty page while loading a page with async handlers. - `Context.navigationStack` and `Context.navigationIndex` are now `PineconeRouter.history.entries` and `PineconeRouter.history.index` respectively. [See docs](./README.md#navigation-history). - Navigation stack and index will only be updated after the handlers have finished executing successfuly. - In case of handlers canceling or redirecting, the stack wont be updated. - This prevents being stuck when going `back()` to a path that redirects to the current one. - Renamed the events `pinecone-start`, `pinecone-end`, and `fetch-error` into `pinecone:start`, `pinecone:end`, and `pinecone:fetch-error` respectively. - loading start and end events (above), are now always dispatched regardless if there are handlers/templates or not (`alwaysSendLoadingEvents` by default). - No longer passes the hash portion when navigating using normal mode - ie. if you're on `/home` and click an anchor link to '#tab1', then clicking a link to '/profile' after wont take you to '/profile#tab1' anymore. - Switched from pnpm/esbuild/node to bun for package management, bundling, and testing. ### Removed - Removed `redirect` method, as it's no longer needed now that all navigation requests now cancel handlers in progress, for example `navigate()`. - Removed `Context.query` and `Context.hash`, as they aren't useful since you can get them using `window.location.search` and `window.location.hash` respectively. - Removed inline templates support from `x-route` in favor of [`inline x-template`](./README.md#inline-templates). - Removed `Settings.alwaysSendLoadingEvents`, it is now default and unchangable. - Removed _internal_ properties from the [PineconeRouter object](./README.md#pineconerouter-object) which weren't supposed to be accessed or modified by the end user. These properties weren't documented besides from code and now they no longer polute the public API. ### Fixed - All navigation requests now cancel ongoing handlers, including `back()` and `forward()`. - Trailing slashes are now properly always ignored by default. - Routes that share the same `x-template` value—ie. the same template urls—used to be ignored after the first one, this can now be solved by adding a unique `id` to the template elements. - Fixed a bug where x-effect/$watch callback inside a template still run after the route changes due to the global context updating prematurely (fix [#62](https://github.com/pinecone-router/router/issues/62)). - Fixed browser back and forth navigation not always always work ([#16](https://github.com/pinecone-router/router/issues/16)) - Fixed query being used as part of the path on initial load. - Fixed Context.path being empty on init (fixes [#67](https://github.com/pinecone-router/router/issues/67)). ## [6.2.5] - 2025-04-11 ### Fixed - Fixed query being read as part of the path on first page load. - Fixed empty path on init (fix [#67](https://github.com/pinecone-router/router/issues/67)) ## [6.2.4] - 2025-03-20 ### Fixed - Fixed interpolating templates not clearing when changing route ## [6.2.3] - 2025-03-20 ### Fixed - Changed template url interpolataion regex to `[^/.]+` ## [6.2.2] - 2025-03-20 ### Fixed - Changed template url interpolataion regex to `[^/]+` to match anything but a slash instead of `/:([a-zA-Z0-9_]+)/g` ## [6.2.1] - 2025-03-15 ### Fixed - Fixed error in `x-template.interpolate` modifier ## [6.2.0] - 2025-03-15 ### Added - Added `x-template.interpolate` modifier for fetching templates based on route params ## [6.1.0] - 2025-03-15 ### Added - Added support for `