@ecl/ec-component-gallery - npm Package Compare versions

Comparing version 2.15.0 to 2.16.0

ec-component-gallery.js

@@ -5,3 +5,34 @@ import createFocusTrap from 'focus-trap';
 
+/**
+ * @param {HTMLElement} element DOM element for component instantiation and scope
+ * @param {Object} options
+ * @param {String} options.galleryItemSelector Selector for gallery element
+ * @param {String} options.descriptionSelector Selector for gallery description element
+ * @param {String} options.metaSelector Selector for gallery meta info element
+ * @param {String} options.closeButtonSelector Selector for close button element
+ * @param {String} options.overlaySelector Selector for gallery overlay element
+ * @param {String} options.overlayHeaderSelector Selector for gallery overlay header element
+ * @param {String} options.overlayFooterSelector Selector for gallery overlay footer element
+ * @param {String} options.overlayImageSelector DEPRECATED! Selector for gallery overlay image element
+ * @param {String} options.overlayMediaSelector Selector for gallery overlay media element
+ * @param {String} options.overlayCounterCurrentSelector Selector for gallery overlay current number element
+ * @param {String} options.overlayCounterMaxSelector Selector for display of number of elements in the gallery overlay
+ * @param {String} options.overlayDownloadSelector Selector for gallery overlay download element
+ * @param {String} options.overlayShareSelector Selector for gallery overlay share element
+ * @param {String} options.overlayDescriptionSelector Selector for gallery overlay description element
+ * @param {String} options.overlayMetaSelector Selector for gallery overlay meta info element
+ * @param {String} options.overlayPreviousSelector Selector for gallery overlay previous link element
+ * @param {String} options.overlayNextSelector Selector for gallery overlay next link element
+ * @param {Boolean} options.attachClickListener Whether or not to bind click events
+ * @param {Boolean} options.attachKeyListener Whether or not to bind keyup events
+ */
 export class Gallery {
+  /**
+   * @static
+   * Shorthand for instance creation and initialisation.
+   *
+   * @param {HTMLElement} root DOM element for component instantiation and scope
+   *
+   * @return {Gallery} An instance of Gallery.
+   */
   static autoInit(root, { GALLERY: defaultOptions = {} } = {}) {
@@ -100,2 +131,5 @@ const gallery = new Gallery(root, defaultOptions);
 
+  /**
+   * Initialise component.
+   */
   init() {
@@ -184,2 +218,5 @@ // Query elements
 
+  /**
+   * Destroy component.
+   */
   destroy() {
@@ -221,2 +258,5 @@ if (this.attachClickListener && this.closeButton) {
 
+  /**
+   * @param {HTMLElement} selectedItem Media element
+   */
   updateOverlay(selectedItem) {
@@ -326,2 +366,7 @@ this.selectedItem = selectedItem;
 
+  /**
+   * Handles keyboard events such as Escape and navigation.
+   *
+   * @param {Event} e
+   */
   handleKeyboard(e) {
@@ -335,2 +380,5 @@ // Detect press on Escape
 
+  /**
+   * Invoke listeners for close events.
+   */
   handleClickOnCloseButton() {
@@ -357,2 +405,7 @@ if (this.isDialogSupported) {
 
+  /**
+   * Invoke listeners for on pressing the spacebar button.
+   *
+   * @param {Event} e
+   */
   handleKeyPressOnItem(e) {
@@ -365,2 +418,7 @@ if (e.keyCode === 32) {
 
+  /**
+   * Invoke listeners for on click events on the given gallery item.
+   *
+   * @param {Event} e
+   */
   handleClickOnItem(e) {
@@ -386,2 +444,5 @@ e.preventDefault();
 
+  /**
+   * Invoke listeners for on click events on previous navigation link.
+   */
   handleClickOnPreviousButton() {
@@ -408,2 +469,5 @@ // Get current id
 
+  /**
+   * Invoke listeners for on click events on next navigation link.
+   */
   handleClickOnNextButton() {
@@ -410,0 +474,0 @@ // Get current id

package.json

@@ -5,3 +5,3 @@ {
   "license": "EUPL-1.1",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "ECL Gallery",
@@ -13,8 +13,8 @@ "main": "ec-component-gallery.js",
   "dependencies": {
-    "@ecl/ec-base": "^2.15.0",
+    "@ecl/ec-base": "^2.16.0",
     "focus-trap": "5.1.0"
   },
   "devDependencies": {
-    "@ecl/ec-specs-gallery": "^2.15.0",
-    "@ecl/ec-utility-disablescroll": "^2.15.0"
+    "@ecl/ec-specs-gallery": "^2.16.0",
+    "@ecl/ec-utility-disablescroll": "^2.16.0"
   },
@@ -37,3 +37,3 @@ "publishConfig": {
   ],
-  "gitHead": "2caa0ad75ff8d7b0ad36884dbfa36baea96860c0"
+  "gitHead": "1dd57e99803c12e86f5b6f6a396fd6ad77386cf9"
 }

No alert changes

Improved metrics

Total package byte prevSize

37777

increased by7.87%

Lines of code

426

increased by17.68%

Dependency changes

• Updated@ecl/ec-base@^2.16.0