selection-ranges - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

CHANGELOG.md

@@ -9,2 +9,6 @@ # Changelog
 
+## 1.1.0
+
+* `FEAT`: add `isSelected(el)` util
+
 ## 1.0.1
@@ -11,0 +15,0 @@

index.js

@@ -37,2 +37,26 @@ 'use strict';
 /**
+ * Return true if element is part of window selection.
+ *
+ * @param  {Element}  el
+ * @return {Boolean}
+ */
+function isSelected(el) {
+
+  if (!selection.rangeCount) {
+    return null;
+  }
+
+  var focusNode = selection.focusNode;
+
+  if (el !== focusNode && !el.contains(focusNode)) {
+    return false;
+  }
+
+  return true;
+}
+
+module.exports.isSelected = isSelected;
+
+
+/**
  * Set cursor or selection position.
@@ -60,12 +84,6 @@ *
 
-  if (!selection.rangeCount) {
+  if (!isSelected(el)) {
     return null;
   }
 
-  var focusNode = selection.focusNode;
-
-  if (el !== focusNode && !el.contains(focusNode)) {
-    return null;
-  }
-
   var range = selection.getRangeAt(0);
@@ -72,0 +90,0 @@

package.json

 {
   "name": "selection-ranges",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Selection range manipulation for contenteditable elements",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -8,2 +8,36 @@ # selection-ranges
 
+## API
+
+```javascript
+/**
+ * Return the selection on the given element as {start, end}.
+ *
+ * @param {Element} el
+ *
+ * @return {Object} selection range or null if element is not selected
+ */
+getRange(el);
+```
+
+```javascript
+/**
+ * Selects the given range on the specified element.
+ *
+ * @param {Element} el
+ * @param {Object} range {start, end}
+ */
+setRange(el, range);
+```
+
+```javascript
+/**
+ * Return true if element is part of window selection.
+ *
+ * @param  {Element}  el
+ * @return {Boolean}
+ */
+isSelected(el);
+```
+
+
 ## Usage
@@ -35,4 +69,9 @@
 
+## Related
+
+* [selection-update](https://github.com/nikku/selection-update) - compute input selection updates on external content changes
+
+
 ## License
 
 MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8552

increased by12.62%

Lines of code

247

increased by5.56%

Number of lines in readme file

75

increased by108.33%

No dependency changes