grainjs 1.0.2 → 1.1.0

package/dist/cjs/lib/domMethods.js

@@ -11,9 +11,9 @@ const browserGlobals_1 = require("./browserGlobals");
  */
 const _dataMap = new WeakMap();
 /**
- * Sets multiple attributes of a DOM element. The `attrs()` variant takes no `elem` argument.
+ * Sets multiple attributes of a DOM element.
  * Null and undefined values are omitted, and booleans are either omitted or set to empty string.
- * @param {Object} attrsObj: Object mapping attribute names to attribute values.
+ * @param attrsObj - Object mapping attribute names to attribute values.
  */
 function attrsElem(elem, attrsObj) {
     for (const key of Object.keys(attrsObj)) {
@@ -24,17 +24,20 @@ function attrsElem(elem, attrsObj) {
     }
 }
 exports.attrsElem = attrsElem;
+/**
+ * Sets multiple attributes of a DOM element. Null and undefined values are omitted, and booleans
+ * are either omitted or set to empty string.
+ */
 function attrs(attrsObj) {
     return (elem) => attrsElem(elem, attrsObj);
 }
 exports.attrs = attrs;
 /**
  * Sets an attribute of a DOM element to the given value. Removes the attribute when the value is
- * null or undefined. The `attr()` variant takes no `elem` argument, and `attrValue` may be an
- * observable or function.
- * @param {Element} elem: The element to update.
- * @param {String} attrName: The name of the attribute to bind, e.g. 'href'.
- * @param {String|null} attrValue: The string value or null to remove the attribute.
+ * null or undefined.
+ * @param elem - The element to update.
+ * @param attrName - The name of the attribute to bind, e.g. 'href'.
+ * @param attrValue - The string value, or null or undefined to remove the attribute.
  */
 function attrElem(elem, attrName, attrValue) {
     if (attrValue === null || attrValue === undefined) {
@@ -45,101 +48,133 @@ function attrElem(elem, attrName, attrValue) {
     }
 }
 exports.attrElem = attrElem;
+/**
+ * Sets an attribute of a DOM element to the given value. Removes the attribute when the value is
+ * null or undefined.
+ *
+ * @example
+ * ```ts
+ * dom('a', dom.attr('href', urlObs))
+ * ```
+ */
 function attr(attrName, attrValueObs) {
-    return (elem) => binding_1.subscribeElem(elem, attrValueObs, (val) => attrElem(elem, attrName, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, attrValueObs, (val) => attrElem(elem, attrName, val));
 }
 exports.attr = attr;
 /**
  * Sets or removes a boolean attribute of a DOM element. According to the spec, empty string is a
  * valid true value for the attribute, and the false value is indicated by the attribute's absence.
- * The `boolAttr()` variant takes no `elem`, and `boolValue` may be an observable or function.
- * @param {Element} elem: The element to update.
- * @param {String} attrName: The name of the attribute to bind, e.g. 'checked'.
- * @param {Boolean} boolValue: Boolean value whether to set or unset the attribute.
+ * @param elem - The element to update.
+ * @param attrName - The name of the attribute to bind, e.g. 'checked'.
+ * @param boolValue - Boolean value whether to set or unset the attribute.
  */
 function boolAttrElem(elem, attrName, boolValue) {
     attrElem(elem, attrName, boolValue ? '' : null);
 }
 exports.boolAttrElem = boolAttrElem;
+/**
+ * Dom-method that sets or removes a boolean attribute of a DOM element.
+ * @param attrName - The name of the attribute to bind, e.g. 'checked'.
+ * @param boolValueObs - Value, observable, or function for a whether to set or unset the attribute.
+ */
 function boolAttr(attrName, boolValueObs) {
-    return (elem) => binding_1.subscribeElem(elem, boolValueObs, (val) => boolAttrElem(elem, attrName, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, boolValueObs, (val) => boolAttrElem(elem, attrName, val));
 }
 exports.boolAttr = boolAttr;
 /**
- * Adds a text node to the element. The `text()` variant takes no `elem`, and `value` may be an
- * observable or function.
- * @param {Element} elem: The element to update.
- * @param {String} value: The text value to add.
+ * Adds a text node to the element.
+ * @param elem - The element to update.
+ * @param value - The text value to add.
  */
 function textElem(elem, value) {
     elem.appendChild(browserGlobals_1.G.document.createTextNode(value));
 }
 exports.textElem = textElem;
+/**
+ * Sets text content of a DOM element to a value that may be an observable or a function.
+ */
 function text(valueObs) {
     return (elem) => {
         const textNode = browserGlobals_1.G.document.createTextNode('');
-        binding_1.subscribeElem(elem, valueObs, (val) => { textNode.nodeValue = val; });
+        (0, binding_1.subscribeElem)(elem, valueObs, (val) => { textNode.nodeValue = val; });
         elem.appendChild(textNode);
     };
 }
 exports.text = text;
 /**
- * Sets a style property of a DOM element to the given value. The `style()` variant takes no
- * `elem`, and `value` may be an observable or function.
- * @param {Element} elem: The element to update.
- * @param {String} property: The name of the style property to update, e.g. 'fontWeight'.
- * @param {String} value: The value for the property.
+ * Sets a style property of a DOM element to the given value.
+ * @param elem - The element to update.
+ * @param property - The name of the style property to update, e.g. 'fontWeight'.
+ * @param value - The value for the property.
  */
 function styleElem(elem, property, value) {
     elem.style[property] = value;
 }
 exports.styleElem = styleElem;
+/**
+ * Sets a style property of a DOM element to the given value, which may be an observable or a
+ * function.
+ * @param property - The name of the style property to update, e.g. 'fontWeight'.
+ * @param value - The value for the property.
+ */
 function style(property, valueObs) {
-    return (elem) => binding_1.subscribeElem(elem, valueObs, (val) => styleElem(elem, property, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, valueObs, (val) => styleElem(elem, property, val));
 }
 exports.style = style;
 /**
  * Sets the property of a DOM element to the given value.
- * The `prop()` variant takes no `elem`, and `value` may be an observable or function.
- * @param {Element} elem: The element to update.
- * @param {String} property: The name of the property to update, e.g. 'disabled'.
- * @param {Object} value: The value for the property.
+ * @param elem - The element to update.
+ * @param property - The name of the property to update, e.g. 'disabled'.
+ * @param value - The value for the property.
  */
 function propElem(elem, property, value) {
     elem[property] = value;
 }
 exports.propElem = propElem;
+/**
+ * Sets the property of a DOM element to the given value, which may be an observable or a
+ * function.
+ * @param property - The name of the property to update, e.g. 'disabled'.
+ * @param value - The value for the property.
+ */
 function prop(property, valueObs) {
-    return (elem) => binding_1.subscribeElem(elem, valueObs, (val) => propElem(elem, property, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, valueObs, (val) => propElem(elem, property, val));
 }
 exports.prop = prop;
 /**
  * Shows or hides the element depending on a boolean value. Note that the element must be visible
  * initially (i.e. unsetting style.display should show it).
- * The `show()` variant takes no `elem`, and `boolValue` may be an observable or function.
- * @param {Element} elem: The element to update.
- * @param {Boolean} boolValue: True to show the element, false to hide it.
+ * @param elem - The element to update.
+ * @param boolValue - True to show the element, false to hide it.
  */
 function showElem(elem, boolValue) {
     elem.style.display = boolValue ? '' : 'none';
 }
 exports.showElem = showElem;
+/**
+ * Shows or hides the element depending on a boolean value, which may be an observable or a function.
+ * Note that the element must be visible by default (i.e. unsetting `style.display` should show it).
+ */
 function show(boolValueObs) {
-    return (elem) => binding_1.subscribeElem(elem, boolValueObs, (val) => showElem(elem, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, boolValueObs, (val) => showElem(elem, val));
 }
 exports.show = show;
 /**
  * The opposite of show, hiding the element when boolValue is true.
- * The `hide()` variant takes no `elem`, and `boolValue` may be an observable or function.
- * @param {Element} elem: The element to update.
- * @param {Boolean} boolValue: True to hide the element, false to show it.
+ * @param elem - The element to update.
+ * @param boolValue - True to hide the element, false to show it.
  */
 function hideElem(elem, boolValue) {
     elem.style.display = boolValue ? 'none' : '';
 }
 exports.hideElem = hideElem;
+/**
+ * The opposite of show, hiding the element when boolValue is true. `boolValueObs` may be an
+ * observable or a function.
+ * Note that the element must be visible by default (i.e. unsetting `style.display` should show it).
+ */
 function hide(boolValueObs) {
-    return (elem) => binding_1.subscribeElem(elem, boolValueObs, (val) => hideElem(elem, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, boolValueObs, (val) => hideElem(elem, val));
 }
 exports.hide = hide;
 /**
@@ -157,7 +192,7 @@ function cls(className, boolValue) {
         return (elem) => clsElem(elem, className, boolValue);
     }
     else {
-        return (elem) => binding_1.subscribeElem(elem, boolValue, (val) => clsElem(elem, className, val));
+        return (elem) => (0, binding_1.subscribeElem)(elem, boolValue, (val) => clsElem(elem, className, val));
     }
 }
 exports.cls = cls;
@@ -173,7 +208,7 @@ exports.clsPrefix = clsPrefix;
 function _clsDynamicPrefix(prefix, className) {
     return (elem) => {
         let prevClass = null;
-        binding_1.subscribeElem(elem, className, (name) => {
+        (0, binding_1.subscribeElem)(elem, className, (name) => {
             if (prevClass) {
                 elem.classList.remove(prevClass);
             }
@@ -185,11 +220,10 @@ function _clsDynamicPrefix(prefix, className) {
     };
 }
 /**
- * Associate arbitrary data with a DOM element. The `data()` variant takes no `elem`, and `value`
- * may be an observable or function.
- * @param {Element} elem: The element with which to associate data.
- * @param {String} key: Key to identify this piece of data among others attached to elem.
- * @param {Object} value: Arbitrary value to associate with elem.
+ * Associate arbitrary data with a DOM element.
+ * @param elem - The element with which to associate data.
+ * @param key - Key to identify this piece of data among others attached to elem.
+ * @param value - Arbitrary value to associate with elem.
  */
 function dataElem(elem, key, value) {
     const obj = _dataMap.get(elem);
@@ -197,15 +231,23 @@ function dataElem(elem, key, value) {
         obj[key] = value;
     }
     else {
-        domDispose_1.onDisposeElem(elem, () => _dataMap.delete(elem));
+        (0, domDispose_1.onDisposeElem)(elem, () => _dataMap.delete(elem));
         _dataMap.set(elem, { [key]: value });
     }
 }
 exports.dataElem = dataElem;
+/**
+ * Associate arbitrary data with a DOM element: `value` may be an observable or a function.
+ * @param key - Key to identify this piece of data among others attached to elem.
+ * @param value - Arbitrary value to associate with elem.
+ */
 function data(key, valueObs) {
-    return (elem) => binding_1.subscribeElem(elem, valueObs, (val) => dataElem(elem, key, val));
+    return (elem) => (0, binding_1.subscribeElem)(elem, valueObs, (val) => dataElem(elem, key, val));
 }
 exports.data = data;
+/**
+ * Retrieve data associated with a DOM element using `data()` or `dataElem()`.
+ */
 function getData(elem, key) {
     const obj = _dataMap.get(elem);
     return obj && obj[key];

package/dist/cjs/lib/domMethods.js.map

@@ -1 +1 @@
-{"version":3,"file":"domMethods.js","sourceRoot":"","sources":["../../../lib/domMethods.ts"],"names":[],"mappings":";;;AAAA,uCAAqE;AACrE,6CAA2C;AAG3C,mFAAmF;AACnF,qDAAmC;AAEnC;;;GAGG;AACH,MAAM,QAAQ,GAAwC,IAAI,OAAO,EAAE,CAAC;AAEpE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,IAAa,EAAE,QAAkB;IACzD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,KAAK,KAAK,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACjD;KACF;AACH,CAAC;AAPD,8BAOC;AACD,SAAgB,KAAK,CAAC,QAAkB;IACtC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAFD,sBAEC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CAAC,IAAa,EAAE,QAAgB,EAAE,SAAsB;IAC9E,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE;QACjD,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;KAChC;SAAM;QACL,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;KACxC;AACH,CAAC;AAND,4BAMC;AACD,SAAgB,IAAI,CAAC,QAAgB,EAAE,YAAmC;IACxE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAU,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1F,CAAC;AAFD,oBAEC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAAa,EAAE,QAAgB,EAAE,SAAkB;IAC9E,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAFD,oCAEC;AACD,SAAgB,QAAQ,CAAC,QAAgB,EAAE,YAAoC;IAC7E,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAU,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAC9F,CAAC;AAFD,4BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAU,EAAE,KAAa;IAChD,IAAI,CAAC,WAAW,CAAC,kBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;AACrD,CAAC;AAFD,4BAEC;AACD,SAAgB,IAAI,CAAC,QAA+B;IAClD,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,QAAQ,GAAG,kBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QAC/C,uBAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC,CAAC;AACJ,CAAC;AAND,oBAMC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,IAAa,EAAE,QAAgB,EAAE,KAAa;IACrE,IAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AACxC,CAAC;AAFD,8BAEC;AACD,SAAgB,KAAK,CAAC,QAAgB,EAAE,QAA+B;IACrE,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,uBAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AACxE,CAAC;AAHD,sBAGC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAI,IAAU,EAAE,QAAgB,EAAE,KAAQ;IAC/D,IAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AAClC,CAAC;AAFD,4BAEC;AACD,SAAgB,IAAI,CAAI,QAAgB,EAAE,QAA0B;IAClE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AACtF,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAiB,EAAE,SAAkB;IAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC/C,CAAC;AAFD,4BAEC;AACD,SAAgB,IAAI,CAAC,YAAoC;IACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,uBAAU,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACjE,CAAC;AAHD,oBAGC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAiB,EAAE,SAAkB;IAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/C,CAAC;AAFD,4BAEC;AACD,SAAgB,IAAI,CAAC,YAAoC;IACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,uBAAU,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACjE,CAAC;AAHD,oBAGC;AAED;;GAEG;AACH,SAAgB,OAAO,CAAC,IAAa,EAAE,SAAiB,EAAE,YAAqB,IAAI;IACjF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;AACvD,CAAC;AAFD,0BAEC;AAeD,SAAgB,GAAG,CAAC,SAAuC,EAAE,SAAkC;IAC7F,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,OAAO,iBAAiB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;KACzC;SAAM,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;QACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;KACtD;SAAM;QACL,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAU,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;KACtF;AACH,CAAC;AARD,kBAQC;AAOD,SAAgB,SAAS,CAAC,MAAc,EAAE,SAAuC,EACvD,SAAkC;IAC1D,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,OAAO,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;KAC7C;SAAM;QACL,OAAO,GAAG,CAAC,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,CAAC;KAC3C;AACH,CAAC;AAPD,8BAOC;AAED,SAAS,iBAAiB,CAAC,MAAc,EAAE,SAAgC;IACzE,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,SAAS,GAAgB,IAAI,CAAC;QAClC,uBAAU,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAY,EAAE,EAAE;YAC3C,IAAI,SAAS,EAAE;gBAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;aAAE;YACpD,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,IAAI,SAAS,EAAE;gBAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;aAAE;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAU,EAAE,GAAW,EAAE,KAAU;IAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,GAAG,EAAE;QACP,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAClB;SAAM;QACL,0BAAa,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC,CAAC,GAAG,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC;KACpC;AACH,CAAC;AARD,4BAQC;AACD,SAAgB,IAAI,CAAC,GAAW,EAAE,QAA4B;IAC5D,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,oBAEC;AACD,SAAgB,OAAO,CAAC,IAAU,EAAE,GAAW;IAC7C,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAHD,0BAGC;AA+BD;;GAEG;AACH,SAAgB,UAAU,CAAC,MAAc;IACvC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAFD,gCAEC;AAED;;GAEG;AACI,MAAM,QAAQ,GAAW,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC;AAA1C,QAAA,QAAQ,YAAkC"}
+{"version":3,"file":"domMethods.js","sourceRoot":"","sources":["../../../lib/domMethods.ts"],"names":[],"mappings":";;;AAAA,uCAAqE;AACrE,6CAA2C;AAG3C,mFAAmF;AACnF,qDAAmC;AAEnC;;;GAGG;AACH,MAAM,QAAQ,GAAwC,IAAI,OAAO,EAAE,CAAC;AAEpE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,IAAa,EAAE,QAAkB;IACzD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,KAAK,KAAK,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACjD;KACF;AACH,CAAC;AAPD,8BAOC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,QAAkB;IACtC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAFD,sBAEC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAa,EAAE,QAAgB,EAAE,SAAgC;IACxF,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE;QACjD,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;KAChC;SAAM;QACL,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;KACxC;AACH,CAAC;AAND,4BAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAAC,QAAgB,EAAE,YAAkD;IACvF,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1F,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,IAAa,EAAE,QAAgB,EAAE,SAAkB;IAC9E,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC;AAFD,oCAEC;AACD;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,QAAgB,EAAE,YAAoC;IAC7E,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAC9F,CAAC;AAFD,4BAEC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAU,EAAE,KAAa;IAChD,IAAI,CAAC,WAAW,CAAC,kBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;AACrD,CAAC;AAFD,4BAEC;AAED;;GAEG;AACH,SAAgB,IAAI,CAAC,QAA+B;IAClD,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,QAAQ,GAAG,kBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QAC/C,IAAA,uBAAU,EAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC,CAAC;AACJ,CAAC;AAND,oBAMC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAa,EAAE,QAAgB,EAAE,KAAa;IACrE,IAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,QAAgB,EAAE,QAA+B;IACrE,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,IAAA,uBAAU,EAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AACxE,CAAC;AAHD,sBAGC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAI,IAAU,EAAE,QAAgB,EAAE,KAAQ;IAC/D,IAAY,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AAClC,CAAC;AAFD,4BAEC;AAED;;;;;GAKG;AACH,SAAgB,IAAI,CAAI,QAAgB,EAAE,QAA0B;IAClE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AACtF,CAAC;AAFD,oBAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAiB,EAAE,SAAkB;IAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC/C,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,YAAoC;IACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,IAAA,uBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACjE,CAAC;AAHD,oBAGC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAiB,EAAE,SAAkB;IAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/C,CAAC;AAFD,4BAEC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAC,YAAoC;IACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CACd,IAAA,uBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACjE,CAAC;AAHD,oBAGC;AAED;;GAEG;AACH,SAAgB,OAAO,CAAC,IAAa,EAAE,SAAiB,EAAE,YAAqB,IAAI;IACjF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;AACvD,CAAC;AAFD,0BAEC;AAgBD,SAAgB,GAAG,CAAC,SAAuC,EAAE,SAAkC;IAC7F,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,OAAO,iBAAiB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;KACzC;SAAM,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;QACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;KACtD;SAAM;QACL,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;KACtF;AACH,CAAC;AARD,kBAQC;AAOD,SAAgB,SAAS,CAAC,MAAc,EAAE,SAAuC,EACvD,SAAkC;IAC1D,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,OAAO,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;KAC7C;SAAM;QACL,OAAO,GAAG,CAAC,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,CAAC;KAC3C;AACH,CAAC;AAPD,8BAOC;AAED,SAAS,iBAAiB,CAAC,MAAc,EAAE,SAAgC;IACzE,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,SAAS,GAAgB,IAAI,CAAC;QAClC,IAAA,uBAAU,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAY,EAAE,EAAE;YAC3C,IAAI,SAAS,EAAE;gBAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;aAAE;YACpD,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,IAAI,SAAS,EAAE;gBAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;aAAE;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAU,EAAE,GAAW,EAAE,KAAU;IAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,GAAG,EAAE;QACP,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KAClB;SAAM;QACL,IAAA,0BAAa,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC,CAAC,GAAG,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC;KACpC;AACH,CAAC;AARD,4BAQC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAC,GAAW,EAAE,QAA4B;IAC5D,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,oBAEC;AAED;;GAEG;AACH,SAAgB,OAAO,CAAC,IAAU,EAAE,GAAW;IAC7C,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAHD,0BAGC;AAkCD;;GAEG;AACH,SAAgB,UAAU,CAAC,MAAc;IACvC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAFD,gCAEC;AAED;;GAEG;AACI,MAAM,QAAQ,GAAW,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC;AAA1C,QAAA,QAAQ,YAAkC"}

package/dist/cjs/lib/domevent.d.ts

@@ -1,86 +1,106 @@
+import { IDisposable } from './dispose';
+import { DomElementMethod, DomMethod } from './domImpl';
+export type EventName = keyof HTMLElementEventMap;
+export type EventType<E extends EventName | string> = E extends EventName ? HTMLElementEventMap[E] : Event;
+export type EventCB<E extends Event = Event, T extends EventTarget = EventTarget> = (this: void, event: E, elem: T) => void;
 /**
- * domevent provides a way to listen to DOM events, similar to JQuery's `on()` function. Its
- * methods are also exposed via the dom.js module, as `dom.on()`, etc.
- *
- * It is typically used as an argument to the dom() function:
- *
- *    dom('div', dom.on('click', (event, elem) => { ... }));
- *
- * When the div is disposed, the listener is automatically removed.
- *
- * The underlying interface to listen to an event is this:
- *
- *    let listener = dom.onElem(elem, 'click', (event, elem) => { ... });
- *
- * The callback is called with the event and the element to which it was attached. Unlike in
- * JQuery, the callback's return value is ignored. Use event.stopPropagation() and
- * event.preventDefault() explicitly if needed.
+ * Listen to a DOM event, returning the listener object.
+ * ```ts
+ * const listener = dom.onElem(elem, 'click', (event, elem) => { ... });
+ * ```
  *
  * To stop listening:
+ * ```ts
+ * listener.dispose();
+ * ```
+ *
+ * Disposing the listener returned by `onElem()` is the only way to stop listening to an event. You
+ * can use `autoDispose` to stop listening automatically when subscribing in a `Disposable` object:
+ * ```ts
+ * this.autoDispose(domevent.onElem(document, 'mouseup', callback));
+ * ```
+ *
+ * If you need "once" semantics, i.e. to remove the callback on first call, here's a useful pattern:
+ * ```ts
+ * const lis = domevent.onElem(elem, 'mouseup', e => { lis.dispose(); other_work(); });
+ * ```
+ *
+ * @param elem - DOM Element to listen to.
+ * @param eventType - Event type to listen for (e.g. `'click'`).
+ * @param callback - Callback to call as `callback(event, elem)`, where elem is `elem`.
+ * @param options - `useCapture: boolean`: Add the listener in the capture phase. This should very
+ *    rarely be useful (e.g. JQuery doesn't even offer it as an option).
+ * @returns Listener object whose `.dispose()` method will remove the event listener.
+ */
+export declare function onElem<E extends EventName | string, T extends EventTarget>(elem: T, eventType: E, callback: EventCB<EventType<E>, T>, { useCapture }?: {
+    useCapture?: boolean | undefined;
+}): IDisposable;
+/**
+ * Listen to a DOM event. It is typically used as an argument to the `dom()` function:
+ * ```ts
+ * dom('div', dom.on('click', (event, elem) => { ... }));
+ * ```
  *
- *    listener.dispose();
- *
- * Disposing the listener returned by .onElem() is the only way to stop listening to an event. You
- * can use autoDispose to stop listening automatically when subscribing in a Disposable object:
+ * When the div is disposed, the listener is automatically removed.
  *
- *    this.autoDispose(domevent.onElem(document, 'mouseup', callback));
+ * The callback is called with the event and the element to which it was attached. Unlike in, say,
+ * JQuery, the callback's return value is ignored. Use `event.stopPropagation()` and
+ * `event.preventDefault()` explicitly if needed.
  *
  * To listen to descendants of an element matching the given selector (what JQuery calls
- * "delegated events", see http://api.jquery.com/on/):
- *
- *    dom('div', dom.onMatch('.selector', 'click', (event, elem) => { ... }));
- * or
- *    let lis = domevent.onMatchElem(elem, '.selector', 'click', (event, el) => { ... });
+ * "delegated events", see http://api.jquery.com/on/), see [`onMatch`](#onMatch).
  *
- * In this usage, the element passed to the callback will be a DOM element matching the given
- * selector. If there are multiple matches, the callback is only called for the innermost one.
- *
- * If you need to remove the callback on first call, here's a useful pattern:
- *    let lis = domevent.onElem(elem, 'mouseup', e => { lis.dispose(); other_work(); });
- */
-import { IDisposable } from './dispose';
-import { DomElementMethod, DomMethod } from './domImpl';
-export declare type EventName = keyof HTMLElementEventMap;
-export declare type EventType<E extends EventName | string> = E extends EventName ? HTMLElementEventMap[E] : Event;
-export declare type EventCB<E extends Event = Event, T extends EventTarget = EventTarget> = (this: void, event: E, elem: T) => void;
-/**
- * Listen to a DOM event. The `on()` variant takes no `elem` argument, and may be used as an
- * argument to dom() function.
- * @param {DOMElement} elem: DOM Element to listen to.
- * @param {String} eventType: Event type to listen for (e.g. 'click').
- * @param {Function} callback: Callback to call as `callback(event, elem)`, where elem is `elem`.
- * @param [Boolean] options.useCapture: Add the listener in the capture phase. This should very
- *    rarely be useful (e.g. JQuery doesn't even offer it as an option).
- * @returns {Object} Listener object whose .dispose() method will remove the event listener.
+ * @param eventType - Event type to listen for (e.g. `'click'`).
+ * @param callback - Callback to call as `callback(event, elem)`, where `elem` is the element this
+ *    listener is attached to.
+ * @param options - `useCapture?: boolean`: Add the listener in the capture phase.
  */
-export declare function onElem<E extends EventName | string, T extends EventTarget>(elem: T, eventType: E, callback: EventCB<EventType<E>, T>, { useCapture }?: {
-    useCapture?: boolean | undefined;
-}): IDisposable;
 export declare function on<E extends EventName | string, T extends EventTarget>(eventType: E, callback: EventCB<EventType<E>, T>, { useCapture }?: {
     useCapture?: boolean | undefined;
 }): DomMethod<T>;
 /**
- * Listen to a DOM event on descendants of the given elem matching the given selector. The
- * `onMatch()` variant takes no `elem` argument, and may be used as an argument to dom().
- * @param {DOMElement} elem: DOM Element to whose descendants to listen.
- * @param {String} selector: CSS selector string to filter elements that trigger this event.
+ * Listen to a DOM event on descendants of the given elem matching the given selector.
+ *
+ * ```ts
+ * const let lis = domevent.onMatchElem(elem, '.selector', 'click', (event, el) => { ... });
+ * ```
+ *
+ * @param elem - DOM Element to whose descendants to listen.
+ * @param selector - CSS selector string to filter elements that trigger this event.
  *    JQuery calls it "delegated events" (http://api.jquery.com/on/). The callback will only be
  *    called when the event occurs for an element matching the given selector. If there are
  *    multiple elements matching the selector, the callback is only called for the innermost one.
- * @param {String} eventType: Event type to listen for (e.g. 'click').
- * @param {Function} callback: Callback to call as `callback(event, elem)`, where elem is a
+ * @param eventType - Event type to listen for (e.g. 'click').
+ * @param callback - Callback to call as `callback(event, elem)`, where elem is a
  *    descendent of `elem` which matches `selector`.
- * @param [Boolean] options.useCapture: Add the listener in the capture phase. This should very
- *    rarely be useful (e.g. JQuery doesn't even offer it as an option).
- * @returns {Object} Listener object whose .dispose() method will remove the event listener.
+ * @param options - `useCapture?: boolean`: Add the listener in the capture phase.
+ * @returns Listener object whose `.dispose()` method will remove the event listener.
  */
 export declare function onMatchElem(elem: EventTarget, selector: string, eventType: string, callback: EventCB, { useCapture }?: {
     useCapture?: boolean | undefined;
 }): IDisposable;
+/**
+ * Listen to a DOM event on descendants of the given element matching the given selector.
+ *
+ * This is similar to JQuery's [delegated events](https://api.jquery.com/on/#direct-and-delegated-events)
+ *
+ * ```ts
+ * dom('div', dom.onMatch('.selector', 'click', (event, elem) => { ... }));
+ * ```
+ *
+ * In this usage, the element passed to the callback will be a DOM element matching the given
+ * selector. If there are multiple matches, the callback is only called for the innermost one.
+ *
+ * @param selector - CSS selector string to filter elements that trigger this event.
+ * @param eventType - Event type to listen for (e.g. `'click'`).
+ * @param callback - Callback to call as `callback(event, elem)`, where `elem` is an element
+ *    matching `selector`.
+ * @param options - `useCapture?: boolean`: Add the listener in the capture phase.
+ */
 export declare function onMatch(selector: string, eventType: string, callback: EventCB, { useCapture }?: {
     useCapture?: boolean | undefined;
 }): DomElementMethod;
-export declare type KeyEventType = 'keypress' | 'keyup' | 'keydown';
+export type KeyEventType = 'keypress' | 'keyup' | 'keydown';
 export interface IKeyHandlers<T extends HTMLElement = HTMLElement> {
     [key: string]: (this: void, ev: KeyboardEvent, elem: T) => void;
 }
@@ -88,8 +108,6 @@ export interface IKeyHandlers<T extends HTMLElement = HTMLElement> {
  * Listen to key events (typically 'keydown' or 'keypress'), with specified per-key callbacks.
  * Key names are listed at https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
  *
- * Methods onKeyPress() and onKeyDown() are intended to be used as arguments to dom().
- *
  * By default, handled events are stopped from bubbling with stopPropagation() and
  * preventDefault(). If, however, you register a key with a "$" suffix (i.e. "Enter$" instead of
  * "Enter"), then the event is allowed to bubble normally.
@@ -98,7 +116,7 @@ export interface IKeyHandlers<T extends HTMLElement = HTMLElement> {
  * to allow this element to receive keyboard events.
  *
  * For example:
- *
+ * ```
  *    dom('input', ...
  *      dom.onKeyDown({
  *        Enter: (e, elem) => console.log("Enter pressed"),
@@ -106,7 +124,14 @@ export interface IKeyHandlers<T extends HTMLElement = HTMLElement> {
  *        Delete$: (e, elem) => console.log("Delete pressed, will bubble"),
  *      })
  *    )
+ * ```
  */
 export declare function onKeyElem<T extends HTMLElement>(elem: T, evType: KeyEventType, keyHandlers: IKeyHandlers<T>): IDisposable;
+/**
+ * Add listeners to `"keypress"` events. See [`onKeyElem`](#onKeyElem) for details.
+ */
 export declare function onKeyPress<T extends HTMLElement>(keyHandlers: IKeyHandlers<T>): DomMethod<T>;
+/**
+ * Add listeners to `"keydown"` events. See [`onKeyElem`](#onKeyElem) for details.
+ */
 export declare function onKeyDown<T extends HTMLElement>(keyHandlers: IKeyHandlers<T>): DomMethod<T>;