@acanto/core-dom - npm Package Compare versions

Comparing version 0.0.9 to 0.0.10

index.js

 /**
- * @overview core/dom, DOM utilities
+ * @module Description
+ * @overview A set of utilities to interact with the DOM, event listeners and
+ * similar low level tasks. For a more structured API (jQuery like) consider
+ * [DOMtastic](https://github.com/webpro/DOMtastic).
  *
- * For a more structured API (jQuery like) consider the packages:
- * @see https://github.com/webpro/DOMtastic
+ * ```js
+ * import { ... } from "@acanto/core-dom";
+ * ```
+ *
+ *
  */
 
-export { getDataAttr, setDataAttr } from "./data";
-export { listen, unlisten, listenOnce } from "./listen";
-export { default as listenLoaded } from "./listenLoaded";
-export { default as listenResize } from "./listenResize";
-export { default as listenScroll } from "./listenScroll";
-export { default as throttle } from "./throttle";
-export { default as emitEvent } from "./emitEvent";
-export { default as getHeight } from "./getHeight";
-export { getOffset, getOffsetTop } from "./getOffset";
-export { default as getDocumentHeight } from "./getDocumentHeight";
-export { default as getScrollbarWidth } from "./getScrollbarWidth";
-export { default as isTotallyScrolled } from "./isTotallyScrolled";
-export { default as isInViewport } from "./isInViewport";
-
 /**
@@ -40,2 +32,5 @@ * Escape colons to allow use class names as `.module:block__element`
  * @returns {HTMLElement}
+ * @example <caption>Basic DOM selection</caption>
+ * const $container = $(".my-section:");
+ * const $el = $("[data-some-attr]", $container);
  */
@@ -241,1 +236,15 @@ export function $(selector, parent) {
 }
+
+export { getDataAttr, setDataAttr } from "./data";
+export { listen, unlisten, listenOnce } from "./listen";
+export { default as listenLoaded } from "./listenLoaded";
+export { default as listenResize } from "./listenResize";
+export { default as listenScroll } from "./listenScroll";
+export { default as throttle } from "./throttle";
+export { default as emitEvent } from "./emitEvent";
+export { default as getHeight } from "./getHeight";
+export { getOffset, getOffsetTop } from "./getOffset";
+export { default as getDocumentHeight } from "./getDocumentHeight";
+export { default as getScrollbarWidth } from "./getScrollbarWidth";
+export { default as isTotallyScrolled } from "./isTotallyScrolled";
+export { default as isInViewport } from "./isInViewport";

package.json

 {
   "name": "@acanto/core-dom",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "author": "Acanto <[e-mail]> (https://acanto.agency/)",
@@ -18,3 +18,3 @@ "license": "ISC",
   "sideEffects": false,
-  "gitHead": "0d1abd0044d2280a10ebeb961f933cd95db60686"
+  "gitHead": "eae265cfc6d54a26582b74e6ef165fd78ea8cafe"
 }

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22377

increased by1.37%

Number of package files

20

increased by5.26%

Lines of code

729

increased by1.25%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

4

increased byInfinity%

No dependency changes