Skip to content

removeProp and prop: clarify recommendations regarding native properties #1189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timmywil merged 2 commits into from
May 14, 2021
Merged

removeProp and prop: clarify recommendations regarding native properties #1189

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8107238
removeProp: clarify recommendations regarding native properties
timmywil May 13, 2021
f047f25
prop: change wording about removeProp
timmywil May 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
removeProp: clarify recommendations regarding native properties 
Ref jquery/jquery#4887
Close gh-1189
  • Loading branch information
@timmywil
timmywil committed May 14, 2021
commit 8107238c6afed15954a05e2f3194c243830b559f
4 changes: 2 additions & 2 deletions entries/removeProp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
<desc>Remove a property for the set of matched elements.</desc>
<longdesc>
<p>The <code>.removeProp()</code> method removes properties set by the <code><a href="/prop/">.prop()</a></code> method.</p>
<p>With some built-in properties of a DOM element or <code>window</code> object, browsers may generate an error if an attempt is made to remove the property. jQuery first assigns the value <code>undefined</code> to the property and ignores any error the browser generates. In general, it is only necessary to remove custom properties that have been set on an object, and not built-in (native) properties.</p>
<p><strong>Note:</strong> Do not use this method to remove native properties such as checked, disabled, or selected. This will remove the property completely and, once removed, cannot be added again to element. Use <code><a href="/prop/">.prop()</a></code> to set these properties to <code>false</code> instead.</p>
<p><strong>Note:</strong>This method should not be used to remove built-in (native) properties such as "checked", "disabled", "selected", or others. This can lead to unexpected behavior.</p>
<p>It's almost always better to use <code><a href="/prop/">.prop()</a></code> to set native properties to <code>false</code> instead of removing them.</p>
</longdesc>
<note id="prop-memory-leaks" type="additional"/>
<example>
Expand Down