#11210 closed bug (invalid)
toggleClass documentation
| Reported by: | guettli | Owned by: | guettli |
|---|---|---|---|
| Priority: | low | Milestone: | None |
| Component: | unfiled | Version: | 1.7.1 |
| Keywords: | Cc: | ||
| Blocked by: | Blocking: |
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 (3)
comment:1 Changed 12 years ago by
| Owner: | set to guettli |
|---|---|
| Status: | new → pending |
comment:2 Changed 12 years ago by
| Status: | pending → 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 12 years ago by
| Priority: | undecided → low |
|---|---|
| Resolution: | → invalid |
| Status: | new → closed |
Thanks for submitting a ticket to the jQuery bug tracker. As Dave has 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/
It already says this, what is unclear?
jQuery UI extensions are covered in the jQuery UI docs, not in the core docs.