#9427 closed bug (fixed)
Passing undefined to .text() does not trigger setter
Reported by: | Xavi | Owned by: | |
---|---|---|---|
Priority: | low | Milestone: | 1.7.2 |
Component: | manipulation | Version: | 1.6.1 |
Keywords: | Cc: | ||
Blocked by: | Blocking: |
Description
Passing undefined to $.fn.text()
triggers getter functionality instead of the setter functionality. For example the following code throws an exception:
var text; $("<div/>").text(text).append($("<span/>"))
Change History (16)
comment:1 Changed 12 years ago by
Component: | unfiled → manipulation |
---|---|
Priority: | undecided → low |
Resolution: | → invalid |
Status: | new → closed |
comment:3 Changed 12 years ago by
Why is it expected behavior? It breaks chaining and causes unexpected exceptions.
comment:4 Changed 12 years ago by
It's expected that the developer knows to test their own variables before passing them to methods that have overloaded signatures.
var text; $("<div/>").text( text || "" ).append($("<span/>"))
http://jsfiddle.net/rwaldron/sTesj/
The code above will work fine without breaking the existing api.
comment:5 Changed 12 years ago by
As noted on the pull request: http://api.jquery.com/text/ The documentation specifies the valid input to the method and their expected outcome.
comment:6 Changed 12 years ago by
FWIW, I would recommend using this work around instead:
var text; $("<div/>").text( text + "" ).append($("<span/>"));
It handles 0
and null
better and saves 1 byte.
Also, FWIW, this bug also affects $.fn.html
, $.fn.attr
, $.fn.width
, $.fn.height
, and number other functions.
I replied to http://bugs.jquery.com/ticket/5571, but it might be worth repeating my argument here. Basically, I feel that the getter/setter functionality should be determined by arguments.length
instead of the argument values. IMO, this leads to a more consistent API and is less surprising to the user.
There is the argument that undefined
is an invalid value, so breaking the chain makes sense since it acts like a form of error reporting. I disagree with this logic. As a form of error reporting, breaking the chain doesn't always work and leads to confusing error messages. (See ticket for more detailed explanation).
comment:12 Changed 12 years ago by
Keywords: | 1.8-discuss added |
---|---|
Resolution: | invalid |
Status: | closed → reopened |
Reopening for 1.8 discussion -- should we have uniform behavior for .method(undefined/null)
?
comment:13 Changed 12 years ago by
Status: | reopened → open |
---|
comment:14 Changed 11 years ago by
Keywords: | 1.8-discuss removed |
---|---|
Resolution: | → fixed |
Status: | open → closed |
We landed this space-saving bug fix in https://github.com/jquery/jquery/commit/6c2a501de40a5f6b3ad382e2d309e5a10fce04d0
comment:15 Changed 11 years ago by
Milestone: | 1.next → 1.7.2 |
---|
comment:16 Changed 11 years ago by
text + ""
text || ""
Note that these two have different behavior in cases other than those you've considered. If text is an empty array, for example, the previous effective value would have been [], while in jQuery 1.7.2 it becomes "[object Object]".
It appears that .text([]) is a no-op in jQuery pre-1.7.2. Some of my code was unknowingly relying on this behavior, and broke when I upgraded to 1.7.2. I'm fixing the code in question, which shouldn't be passing [] to text() in the first place. But I figured you might want to know about this, since it does represent an undocumented change, however minor.
This is expected behaviour.