solidjs / solidjs/solid-router

Link click handling breaks the <Router> isolation/context principle

Open
#298 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
1.3k
Forks
180
Avg merge
1d 13h
Merged PRs (30d)
19

Description

Describe the bug

I'm making the assumption here that this package supports multiple routers running at the same time as it does use context for isolation instead of some kind of global store. Described bug is not an issue if my assumption is wrong.

Router component provides context which isolates and enforces the scope of router functionality.
For example useLocation under <Router> returns the location for that particular router.

Link click handling (A component) breaks that principle and functionality because link click event handler is added to document and if you have multiple routers (with default integration or custom), only one integration setter will be always called.

I propose to handle it in some sort of scoped way, for example:
<Router scopeEl={htmlElementRef} source={integration}> and

const target = args.scopeEl || document;
target .addEventListener("click", handleAnchorClick);

Or a bit more advanced (and potentially buggy): automatically find the nearest parent HTML element for <Router>.

Your Example Website or App

https://codesandbox.io/s/solid-app-router-example-forked-25ysls?file=/Index.js

Steps to Reproduce the Bug or Issue
  1. Go to Home (/) if not already there and open console
  2. Click on any of the "Post X (modal)" links
  3. Clear console log
  4. Click on any of the "Post X (modal)" links in modal (links under router 2)

You can see in logs [router 1] set global loc: that even though this link is rendered under second <Router>, it will still invoke the setter for first <Router> integration.

Expected behavior

Link behaviour respects the context.
Link rendered under <Router1 source={integration1}> should invoke the integration1 setter.
Link rendered under <Router2 source={integration2}> should invoke the integration2 setter.

Screenshots or Videos

No response

Platform
  • OS: any
  • Browser: any
  • Version: 0.8.3
Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in the linked CodeSandbox with two Router instances, then inspect the A component's document-level click handling and the Router context/integration path. Confirm that clicks under each Router invoke that Router's integration setter, and verify the behavior against the listed reproduction steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.