Deprecations

Deprecations

You've most likely be taken here by this warning message in the developer's console:

Deprecation - Please consult https://github.com/pisi/Reel/wiki/Deprecations

If you happen to link the latest version of Reel from the CDN, there is a real danger your Reel may stop working when the next version is released. Good you landed here!

What The Hell!?

Reel is evolving on many levels and some of the changes happen to render some options, events or mechanisms deprecated (that's the goal anyway, right?). I painstakingly strive for backward compatibility in order to not brake your code, while at the same time I hate to see it limiting the actual evolution . Therefore a careful yet quick deprecation process is in place to satisfy both desires and cut away the deprecation as soon as possible.

Reel's policy on backward compatibility is dead simple. When an evolution of something emerges (and is in fact better - this is an important condition), it renders the old option or event deprecated for the next release, while maintaining the original functionality and access and yielding a warning into the console. It will get cut off in the next next version, along with its backward compatibility quirks (if any). Until then, it has to satisfy all original plus all new tests.

This document's aim is to gather all actual deprecations and help with resolving them.

Your Options

You can resolve this by freezing the current version and live on with the deprecation (which is NOT recommended for fairly obvious reasons).

Better (and recommended) course of action would be to fix the deprecation - it's always a rather quick fix and mostly it is even shorter than what it will replace.

Current Deprecations

Version 1.2

• deprecated step and steps options. Use frame and frames instead.
• deprecated setting data values with "frameChange", "fractionChange" and "rowChange" events. This was called a "before trigger", because it happened before the actual data change. Use .reel() data interface instead, which will eventually trigger the event "after" the data was stored. In short, replace .trigger('frameChange', 5) with .reel('frame', 5) for example.
• deprecated "store" and "recall" events. __Use change events triggered by the [.reel()` data interface](Data) instead.__
• removed (renamed) "start" event, Use "setup" event instead.

Version 1.1

• deprecated tooltip option. Use hint instead.
• deprecated hotspot option. Use area instead.