Skip to content

README says noScroll becomes lowercase noscroll, but @solidjs/web types the anchor attribute as noScroll #605

Description

@ryansolid

Two sources disagree on the spelling of the scroll opt-out attribute on plain anchors (router next, f7602bf; core next, 344ed054):

  • README.md line 419 lists noscroll in 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.ts line 1131 in @solidjs/web declares the anchor attribute as noScroll?: BooleanAttribute | RemoveAttribute; (with link, state, replace, preload lowercase 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, because setAttribute and the HTML parser lowercase the name and src/data/events.ts line 97 reads a.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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions