FEATURE: Sveltekit compatibility

[webJose]

This router is not compatible with Sveltekit. You should not be needing a router for Sveltekit projects since Sveltekit does path routing by default and does so very nicely.

But what if you want to add hash routing on top of Sveltekit's path routing? That's a valid case.

Specs

Initially, I'm thinking a specialized sveltekitInit() function should be created to be used instead of the regular init() function. This function should:

1. Limit the number of options. Only the hash mode should be configurable. Full mode cannot be an option; implicit mode is hardcoded to 'hash'.
2. Provide a location object that uses Sveltekit compliant URL-related info and actions.

Location Details

• URL is fed from page.url from $app/state.
• Navigation uses goto, pushState or replaceState from $app/navigation.

[ConveyOS]

Yes please!

[webJose]

No problem. I need to resolve #25 and #20 first, though.

If you feel like contributing, the high-level work is described in this issue. I'll appreciate it. I'm a bit of a hard boss, though, when it comes to coding. 😄 A little bit of a perfectionist, so I'll appreciate attention to detail and of course, unit testing.

[webJose]

@ConveyOS: Issue #25 is code-complete. We're closer to this one. Must document the navigation changes and such. Still some more days. Then either this one or #20. I haven't decided.

[rosano]

If you're close to the finish line maybe I can use the in-progress code to prepare a basic sample SvelteKit app for this project? I'm looking for a routing library that does hash routing on top of Sveltekit's path routing.

[webJose]

@rosano shoot, your timing is impecable.

Maybe an hour ago I finally got the first version working. I haven't uploaded. I need to polish a couple of things. Head to its repository and watch it for updates: @wjfe/n-savant-sk

I'll probably upload the code tomorrow night (so 24 hours or so).

[webJose]

Oh, also note that I have made some changes in this repository as well to support SSR behaviors. These I haven't released to npmjs.com yet. That needs to happen as well.

[webJose]

One more thing: Online Docs

I updated the docs on the extension package, but it still requires changes in light of what I discovered today.

[rosano]

I updated the docs on the extension package, but it still requires changes in light of what I discovered today.

I had read that and thought "how badass to release the docs before the code!"

Well, I appreciate the communication and will wait for your input — muchas gracias 🙏🏽

[webJose]

@rosano, @ConveyOS: I have merged the code for the initial working version. Head to its repository and clone since I won't be publishing to NPM for now because I want to play a bit more with it.

You can produce the NPM package running npm pack after installing dependencies, and can then use the TAR file to install with npm install.

Pay close attention to the README file.

---

Open issues for problems you encounter, and of course, everyone is welcome to contribute if you feel like it.

I will be closing this issue now. As stated, create new issues in the other repository if needed.

Thanks!