README says noScroll becomes lowercase noscroll, but @solidjs/web types the anchor attribute as noScroll
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start by comparing the README.md references at lines 419, 427, and 915 with the anchor declaration in packages/web/types/jsx.d.ts around line 1131. Check src/data/events.ts around line 97 to confirm runtime handling, then resolve the documented spelling and update the relevant documentation or type reference so the README and TypeScript usage agree.
Written by the indexing model from the issue text.
Description
Two sources disagree on the spelling of the scroll opt-out attribute on plain anchors (router next, f7602bf; core next, 344ed054):
README.mdline 419 listsnoscrollin the attribute table, line 427 shows<a href={paths.docs} noscroll>Docs</a>, and line 915 in the migration section says<A href replace noScroll state>→<a href replace noscroll state>"(attributes, all lowercase)".packages/web/types/jsx.d.tsline 1131 in@solidjs/webdeclares the anchor attribute asnoScroll?: BooleanAttribute | RemoveAttribute;(withlink,state,replace,preloadlowercase beside it).
Consequences today:
<a href={...} noscroll>is a type error:Property 'noscroll' does not exist on type 'AnchorHTMLAttributes<HTMLAnchorElement>'. Did you mean 'noScroll'?<a href={...} noScroll>type-checks and also works at runtime, becausesetAttributeand the HTML parser lowercase the name andsrc/data/events.tsline 97 readsa.hasAttribute("noscroll").
So the README documents the spelling that does not compile. Either the README should say noScroll (matching the type, and the only spelling TypeScript users can write), or the type should be noscroll to match the README's "all lowercase" rule for the other attributes. The 2.0 docs have gone with noScroll for now since that is what type-checks.
- Dominant language
- TypeScript
- Stars
- 1.3k
- Forks
- 180
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 19
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from solidjs/solid-router
-
Difficulty 3/5 1-2 days Newbie friendliness 78/100
solidjs/solid-router#603 · 1 comment ·
-
<A> costs ~6us of server CPU per instance during SSR (20x a plain <a>), mostly mergeProps/splitProps Open
Difficulty 4/5 3-5 days Newbie friendliness 55/100
solidjs/solid-router#583 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
solidjs/solid-router#569 · 3 comments ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 38/100
solidjs/solid-router#518 · 2 comments ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 64/100
solidjs/solid-router#502 · 4 comments ·
All issues in solidjs/solid-router
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·