Bug Tracker

Ticket #11210 (closed bug: invalid)

Opened 3 years ago

Last modified 3 years ago

toggleClass documentation

Reported by: guettli Owned by: guettli
Priority: low Milestone: None
Component: unfiled Version: 1.7.1
Keywords: Cc:
Blocking: Blocked by:

Description

The jquery toggleClass documentation needs to be updated.

 http://api.jquery.com/toggleClass/

Please advice the user to use a Boolean for the "switch" parameter, since this is required by toggleClass implementation of jquery-ui

Related bug in jquery-ui (there the swich paramter (called "force" in the source, is even not documented):  http://bugs.jqueryui.com/ticket/8049

Change History

comment:1 Changed 3 years ago by dmethvin

  • Owner set to guettli
  • Status changed from new to pending

It already says this, what is unclear?

A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.

jQuery UI extensions are covered in the jQuery UI docs, not in the core docs.

comment:2 Changed 3 years ago by guettli

  • Status changed from pending to new

jquery docs says "... (not just truthy/falsy)" and jquery-ui only supports Boolean. If it is not a boolean, jquery-ui tries to use this value as animation.

Please use something like this instead of "(not just truthy/falsy)":

"since jquery-ui overwrites this method, it is recommended to use a boolean object."

jquery-ui source of toggleClass:

 https://github.com/jquery/jquery-ui/blob/master/ui/jquery.effects.core.js#LC310

I know that jquery-ui is not part of jquery. But many people use it.

comment:3 Changed 3 years ago by addyosmani

  • Priority changed from undecided to low
  • Status changed from new to closed
  • Resolution set to invalid

Thanks for submitting a ticket to the jQuery bug tracker. As Dave as mentioned earlier, extensions to jQuery UI are covered in their docs  http://jqueryui.com/demos/. To request any changes to these docs, please file a ticket here as this tracker is for core issues only:  http://bugs.jqueryui.com/

Version 0, edited 3 years ago by addyosmani (next)
Note: See TracTickets for help on using tickets.