Bug Tracker

Opened 7 years ago

Closed 7 years ago

#11532 closed feature (notabug)

Document jQuery.Tween

Reported by: SineSwiper Owned by: gnarf
Priority: low Milestone: 1.8
Component: effects Version: 1.7.2
Keywords: Cc:
Blocked by: Blocking:

Description

Within the animate() documentation, the Step Function docs mention the "jQuery.fx prototype", but there is no separate reference to the specifications of the prototype. It mentions a few properties, but there should be a separate page for the prototype. The jQuery.fx prototype is also mentioned in cssHooks.

Properties and methods for jQuery.fx include:

update cur custom show hide step elem start end now pos unit tick prop options startTime speeds etc.

Change History (6)

comment:1 Changed 7 years ago by dmethvin

Component: unfiledeffects
Milestone: None1.8
Priority: undecidedlow
Status: newopen
Type: bugenhancement

I don't think we *want* to document everything and should be very careful about documenting things that prevent further optimization or implementation changes down the road. There definitely is a subset that deserves a few words, but since gnarf is planning to do some changes for 1.8 it should probably wait until then.

comment:2 Changed 7 years ago by gnarf

This will be docs for jQuery.Tween objects anyway in 1.8 :)

comment:3 Changed 7 years ago by timmywil

Owner: set to gnarf
Status: openassigned
Summary: No documentation for the jQuery.fx prototypeDocument jQuery.Tween

comment:5 Changed 7 years ago by dmethvin

Type: enhancementfeature

Bulk change from enhancement to feature.

comment:6 Changed 7 years ago by gnarf

Resolution: notabug
Status: assignedclosed

This is an api issue, one that we are already tracking.

Note: See TracTickets for help on using tickets.