Router #68
Router #68
Conversation
|
@jberggg I hope you don't mind, your work on the fs2 router also inspired me to explore some ideas in this space 😃 if you have a chance I would really appreciate your feedback and ideas here 🙏 thanks in advance! I was largely motivated by Calico's special requirements: unlike Outwatch, which uses a virtual DOM for rendering, the Calico DSL is in terms of the raw DOM. I wanted to make sure that Calico provides a router API that implements navigation without re-rendering the entire page (or a large portion of it), since this would be prohibitively bad for performance. I've pre-published the docs: As well as a snapshot: resolvers += Resolver.sonatypeOssRepos("snapshots")
libraryDependencies += "com.armanbilge" %%% "calico-router" % "0.1.1-99-27bfdf3-SNAPSHOT" |
|
Hey Arman 👋🏽 We just moved so there was not much time to work on my router mini project. Will push it to a first release as soon as I can. I don't mind your specialised router and I will have a look at this PR tomorrow, today is a busy day for me 🧑💼 |
| def replaceState(state: S, url: URL): F[Unit] | ||
|
|
||
| object History: | ||
| def make[F[_], S: Decoder: Encoder](using F: Async[F]): Resource[F, History[F, S]] = |
There was a problem hiding this comment.
Still learning some Scala3 idioms...
Is it common to use this the F name to bind the implicit instances?
There was a problem hiding this comment.
Yes! I would say this is a Typelevel/Cats idiom, not specific to Scala 3 :)
| object History: | ||
| def make[F[_], S: Decoder: Encoder](using F: Async[F]): Resource[F, History[F, S]] = | ||
| Dispatcher[F].map { dispatcher => | ||
| new: |
There was a problem hiding this comment.
The new: ? This is Scala 3 shorthand for new History[F, S] { ... }
| sealed trait History[F[_], S]: | ||
|
|
||
| def state: Signal[F, S] | ||
| def length: Signal[F, Int] | ||
|
|
||
| def forward: F[Unit] | ||
| def back: F[Unit] | ||
| def go: F[Unit] | ||
| def go(delta: Int): F[Unit] | ||
|
|
||
| def pushState(state: S): F[Unit] | ||
| def pushState(state: S, url: URL): F[Unit] | ||
|
|
||
| def replaceState(state: S): F[Unit] | ||
| def replaceState(state: S, url: URL): F[Unit] |
There was a problem hiding this comment.
I like this API, very simple and clean!
I've seen some other implementations like in https://github.com/raquo/scala-dom-types to link out to the underlying MDN docs as well
Do you think it makes sense to do that?
Does it also make sense to add some scaladoc to this (outside of the awesome conceptual overview in the readme) ?
There was a problem hiding this comment.
Yes, scaladocs are a bit overdue 😅 . Linking to MDN seems good :)
| given Monoid[F[Option[Route[F]]]] with | ||
| def empty = F.pure(None) | ||
| def combine(x: F[Option[Route[F]]], y: F[Option[Route[F]]]) = | ||
| (x, y).mapN(_.orElse(_)) |
There was a problem hiding this comment.
I've been looking for a simple pattern that's similar to <|> from Haskell's Alternative
I like this, I'mma start using it (:
| def navigate(uri: Uri): F[Unit] | ||
| def teleport(uri: Uri): F[Unit] |
There was a problem hiding this comment.
What are the intended differences between these 2 method?
Otherwise, they looks kind of like synonyms (as I'm currently reading it)
There was a problem hiding this comment.
Yup, another one need scaladoc. Feel free to suggest better names!
navigate is like pushState: you change location, and also push it into your browser history.
teleport is like replaceState: you change location wihtout pushing into your browser history, instead replacing the current entry.
https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState
Sad 😕 this is probably mostly http4s |
Pretty much done I think, just needs an example.