Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(v3)!: [closes #177] Convert to TypeScript #178

Merged
merged 95 commits into from
Jul 2, 2023

Conversation

jeremyckahn
Copy link
Owner

@jeremyckahn jeremyckahn commented Jul 2, 2023

For #177, this PR updates Shifty to use TypeScript. This will be version 3 of Shifty.

In this PR:

  • Convert Shifty to be authored in TypeScript
  • Publish ES6 artifacts
  • Remove Core build
  • Switch from JSDoc to TypeDoc
  • Fix various minor bugs

Breaking changes

  • Tweenable.formulas has been renamed to Tweenable.easing
  • tweenConfig.step has been removed in favor of tweenConfig.render (behavior and API is unchanged).
  • tweenConfig.attachment has been removed in favor of tweenConfig.data (behavior and API is unchanged).
  • Tweenable#tweenable has been removed.
  • Tweenable#set() is now Tweenable#setState.
  • Tweenable#get() is now Tweenable#state (a getter, not a method).
  • Tweenable#hasEnded() is now Tweenable#hasEnded (a getter, not a method).
  • Tweenable#isPlaying() is now Tweenable#isPlaying (a getter, not a method).
  • Tweenable#setScheduleFunction has been removed. The static method Tweenable.setScheduleFunction method should be used instead.
  • Render handler parameters have been reordered:
    • In v2, the function signature was (state: TweenState, data: Data, timeElapsed: number) => void
    • In v3, the function signature is (state: TweenState, timeElapsed: number, data: Data) => void
  • Scene#play() has been renamed to Scene#tween.
  • Scene#isPlaying() is now Scene#isPlaying (a getter, not a method).
  • Scene#playingTweenables() has been removed.
  • unsetBezierFunction has been removed.
  • Shifty "Core" build has been removed.

@jeremyckahn jeremyckahn self-assigned this Jul 2, 2023
@vercel
Copy link

vercel bot commented Jul 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
shifty ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 2, 2023 11:02pm

@jeremyckahn jeremyckahn changed the title feat(v3)!: Convert to TypeScript feat(v3)!: [closes #177] Convert to TypeScript Jul 2, 2023
@jeremyckahn jeremyckahn merged commit 1f4725f into main Jul 2, 2023
3 checks passed
@jeremyckahn jeremyckahn deleted the feature/177__typescript branch July 19, 2023 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant