summaryrefslogtreecommitdiff
path: root/addons/web/static/lib/nearest/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'addons/web/static/lib/nearest/README.md')
-rw-r--r--addons/web/static/lib/nearest/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/addons/web/static/lib/nearest/README.md b/addons/web/static/lib/nearest/README.md
new file mode 100644
index 00000000..cc40c5fe
--- /dev/null
+++ b/addons/web/static/lib/nearest/README.md
@@ -0,0 +1,22 @@
+jQuery Nearest Element plugin
+======
+
+**Full documentation is at <http://gilmoreorless.github.io/jquery-nearest/>**
+
+**Demo:** <http://gilmoreorless.github.io/jquery-nearest/demo.html>
+
+Method signatures:
+
+ * `$.nearest({x, y}, selector)` - find `$(selector)` closest to x/y point on screen
+ * `$(elem).nearest(selector)` - find `$(selector)` closest to elem
+ * `$(elemSet).nearest({x, y})` - filter `$(elemSet)` and return closest to x/y point on screen
+
+Reverse logic:
+
+ * `$.furthest()`
+ * `$(elem).furthest()`
+
+Intersecting/touching:
+
+ * `$.touching()`
+ * `$(elem).touching()`