aboutsummaryrefslogtreecommitdiffstats
path: root/docs/angular.element.ngdoc
diff options
context:
space:
mode:
authorMisko Hevery2010-11-22 12:05:01 -0800
committerMisko Hevery2010-12-06 15:48:40 -0800
commit58d0e8945d772eddbfecbe6a645b2f1c4dd38bf2 (patch)
tree2f6b7ec1b0cc09a1976c381c42452d258d239ca8 /docs/angular.element.ngdoc
parent2bbced212e2ee93948c45360fee00b2e3f960392 (diff)
downloadangular.js-58d0e8945d772eddbfecbe6a645b2f1c4dd38bf2.tar.bz2
allow documentation to be in external file
* Load templates once instead of per request * show timing information * load files ending in .ngdoc and process them
Diffstat (limited to 'docs/angular.element.ngdoc')
-rw-r--r--docs/angular.element.ngdoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/angular.element.ngdoc b/docs/angular.element.ngdoc
new file mode 100644
index 00000000..a636cc25
--- /dev/null
+++ b/docs/angular.element.ngdoc
@@ -0,0 +1,43 @@
+@workInProgress
+@ngdoc function
+@name angular.element
+@function
+
+@description
+Wraps a raw DOM element or HTML string as [jQuery](http://jquery.com) element.
+`angular.element` is either an alias for [jQuery](http://api.jquery.com/jQuery/) function if
+jQuery is loaded or a function that wraps the element or string in angular's jQuery lite
+implementation.
+
+Real jQuery always takes precedence if it was loaded before angular.
+
+Angular's jQuery lite implementation is a tiny API-compatible subset of jQuery which allows
+angular to manipulate DOM. The functions implemented are usually just the basic versions of
+them and might not support arguments and invocation styles.
+
+NOTE: All element references in angular are always wrapped with jQuery (lite) and are never
+raw DOM references.
+
+Angular's jQuery lite implements these functions:
+
+- [addClass()](http://api.jquery.com/addClass/)
+- [after()](http://api.jquery.com/after/)
+- [append()](http://api.jquery.com/append/)
+- [attr()](http://api.jquery.com/attr/)
+- [bind()](http://api.jquery.com/bind/)
+- [children()](http://api.jquery.com/children/)
+- [clone()](http://api.jquery.com/clone/)
+- [css()](http://api.jquery.com/css/)
+- [data()](http://api.jquery.com/data/)
+- [hasClass()](http://api.jquery.com/hasClass/)
+- [parent()](http://api.jquery.com/parent/)
+- [remove()](http://api.jquery.com/remove/)
+- [removeAttr()](http://api.jquery.com/removeAttr/)
+- [removeClass()](http://api.jquery.com/removeClass/)
+- [removeData()](http://api.jquery.com/removeData/)
+- [replaceWith()](http://api.jquery.com/replaceWith/)
+- [text()](http://api.jquery.com/text/)
+- [trigger()](http://api.jquery.com/trigger/)
+
+@param {string|DOMElement} element HTML string or DOMElement to be wrapped into jQuery.
+@returns {Object} jQuery object.