fix: add CSSStyleValue to Keyframe index signatures#2466
Open
Ankitajainkuniya wants to merge 1 commit intomicrosoft:mainfrom
Open
fix: add CSSStyleValue to Keyframe index signatures#2466Ankitajainkuniya wants to merge 1 commit intomicrosoft:mainfrom
Ankitajainkuniya wants to merge 1 commit intomicrosoft:mainfrom
Conversation
… signatures The Web Animations API allows passing CSS Typed Object Model values (CSSStyleValue and its subtypes like CSSUnitValue, CSSKeywordValue, CSSTransformValue, etc.) directly to animation keyframes via element.animate() and KeyframeEffect. However, the current Keyframe and PropertyIndexedKeyframes interfaces only accept string | number, causing type errors for valid CSS Typed OM usage. This adds CSSStyleValue to the index signatures of: - Keyframe: accepts CSSStyleValue for individual keyframe properties - PropertyIndexedKeyframes: accepts CSSStyleValue and CSSStyleValue[] ComputedKeyframe is intentionally left unchanged since getKeyframes() returns computed string values, not CSSStyleValue objects. Fixes microsoft/TypeScript#63325
Contributor
|
Thanks for the PR! This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged. |
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CSSStyleValueto theKeyframeandPropertyIndexedKeyframesindex signatureselement.animate(),KeyframeEffect(), andsetKeyframes()Problem
The Web Animations API supports passing CSS Typed OM values (e.g.,
CSSUnitValue,CSSKeywordValue,CSSTransformValue) to animation keyframes. This is valid at runtime:However, the current
Keyframeinterface only acceptsstring | number | null | undefinedin its index signature, causing a TypeScript error for this valid usage.Changes
inputfiles/overridingTypes.jsonc:Keyframe:[property: string]: string | number | CSSStyleValue | null | undefinedPropertyIndexedKeyframes:[property: string]: string | string[] | number | CSSStyleValue | CSSStyleValue[] | null | (number | null)[] | undefinedComputedKeyframeis intentionally left unchanged —getKeyframes()returns computed string values, notCSSStyleValueobjects.Motivation
KeyframeAnimationOptionsinterface already usesCSSNumericValue | CSSKeywordValueforrangeStart/rangeEnd, showing these types are recognized for animationsFixes microsoft/TypeScript#63325