Repository navigation
Type definition for ScrollBehavior appears to be wrong #28755
Description
Raising this here as per contribution guidelines for the TSJS-lib-generator repo
https://github.com/Microsoft/TSJS-lib-generator#contribution-guidelines
To confirm that this is indeed an issue before I open a PR to fix it over there.
TypeScript Version: 3.2.1
Search Terms:
instant
scrollbehavior
types
type defs
type definitions
Code
Sans react code
export class TestScrollTypeBug {
scrollToEnd(smooth: boolean = false) {
const thing: HTMLDivElement = null
thing.lastElementChild.scrollIntoView({
block: 'end',
inline: 'nearest',
behavior: smooth
? 'smooth'
: 'instant'
})
}
}Expected behavior:
scrollIntoViewOptions option behavior should allow the value 'instant' as it doesn't appear to be a deprecated value (according to MDN):
https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
Actual behavior:
node_modules/typescript/lib/lib.dom.d.ts line 17972 is defined as
type ScrollBehavior = "auto" | "smooth";
previously the ScrollBehavior type was defined as
type ScrollBehavior = "auto" | "instant" | "smooth";
which seems to be correct.
Playground Link:
Here
Related Issues:
Activity
jglover commentedon Nov 30, 2018
Closing as it looks like this is in fact correct.
microsoft/TypeScript-DOM-lib-generator@fe01c9a
MDN docs were just updated to reflect this.
https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView$compare?locale=en-US&to=1440135&from=1438785
DanielRuf commentedon Jun 19, 2023
This seems to be wrong / still broken for scrollTo: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo
DanielRuf commentedon Jun 19, 2023
Will be fixed in 5.1: #47441 (comment)
SleighJ commentedon Oct 4, 2023
Currently on 5.2 and having this issue
pauIbanez commentedon Mar 14, 2024
Is this still not added or re-broken?
RyanCavanaugh commentedon Mar 14, 2024
Please log a new issue using the appropriate template
alp-ex commentedon Mar 20, 2024
fixed in 5.1 as mentioned here 👌🏼
at least it's the correct type in 5.4.2
Sebastp commentedon Oct 7, 2024
still an issue for me