3.0.0

Author: WezomDev

README.md

@@ -20,13 +20,13 @@ Below is a list of these methods and properties. Then you can see [an example im
 ---
 
 - [`constructor()`](#constructor)
+- [`defaults`](#defaults)
+- [`defaultSettings`](#defaultsettings)
+- [`defaultProps`](#defaultprops)
 - [`_setup()`](#_setup)
 - [`_beforeInitialize()`](#_beforeinitialize)
 - [`_afterInitialize()`](#_afterinitialize)
 - [`initialize()`](#initialize)
-- [`defaults`](#defaults)
-- [`defaultSettings`](#defaultsettings)
-- [`defaultProps`](#defaultprops)
 
 
 ### `constructor()`
@@ -35,6 +35,25 @@ Here we describe the future instances.:
 - get data from arguments  
 - declare instance properties
 
+### `defaults`
+
+> since v3.0.0 property renamed to `defaultSettings`
+
+### `defaultSettings`
+
+_`public`_  
+_**`since v3.0.0`**_
+
+A getter that returns an object with default options, settings, or configuration for your plugin.
+
+### `defaultProps`
+
+_`public`_  
+_**`since v3.0.0`**_
+
+A getter that returns an object with predefined props.  
+Most often this is a list of options that are not included in the list of certain options of your plugin. But you need them for individual processing your options, settings, data, etc.
+
 
 ### `_setup()`
 
@@ -63,25 +82,6 @@ _`public`_
 
 Directly launch your plugin.
 
-### `defaults`
-
-> since v3.0.0 property renamed to `defaultSettings`
-
-### `defaultSettings`
-
-_`public`_  
-_**`since v3.0.0`**_
-
-A getter that returns an object with default options, settings, or configuration for your plugin.
-
-### `defaultProps`
-
-_`public`_  
-_**`since v3.0.0`**_
-
-A getter that returns an object with predefined props.  
-Most often this is a list of options that are not included in the list of certain options of your plugin. But you need them for individual processing your options, settings, data, etc.
-
 ---
 
 ## Usage example
@@ -113,70 +113,86 @@ export class SomeJqueryPluginAbstract extends WebPluginInterface {
         this.readyCssClass = 'is-ready';
         this.initializedCssClass = 'is-initialized';
     }
+    
+    /**
+     * @type {Object}
+     */
+    get defaultSettings () {
+        return {
+            // an example of some options of your plugin
+            autoplay: true,
+            speed: 500
+        }
+    }
 
-    /** @protected */
+    /**
+     * @type {Object}
+     */
+    get defaultProps () {
+        return {
+            // an example of options that is native for your plugin
+            stopAutoPlayIfOutView: true
+        }
+    }
+
+    /**
+     * @protected
+     */
     _setup () {
         this.props = $.extends({}, this.defaultProps, this.customProps);
         this.settings = $.extends({}, this.defaultSettings, this.customSettings);
 
         // props example
         if (this.props.stopAutoPlayIfOutView) {
-        	this.settings.autoplay = this.detectIfInView();
+            this.settings.autoplay = this.detectIfInView;
         }
     }
 
-    /** @protected */
+    /**
+     * @protected
+     */
     _beforeInitialize () {
         this.$container.addClass(this.readyCssClass);
     }
 
-    /** @protected */
+    /**
+     * @protected
+     */
     _afterInitialize () {
         this.$container.addClass(this.initializedCssClass);
 
         // props example
         if (this.props.stopAutoPlayIfOutView) {
-        	this.autoplayInViewObserve()
+            this._autoplayInViewObserve();
         }
     }
 
-    /** @public */
     initialize () {
-    	this._setup();
-    	this._beforeInitialize();
+        this._setup();
+        this._beforeInitialize();
+
+        // fire up
         this.$container.someJqueryPlugin(this.settings);
+
         this._afterInitialize();
     }
-    
-    /**
-     * @public
-     * @returns Object
-     */
-    get defaultSettings () {
-        return {
-            // an example of some options of your plugin
-            autoplay: true,
-            speed: 500
-        }
-    }
-    
-    get defaultProps () {
-    	return {
-    		// an example of options that is native for your plugin
-    		stopAutoPlayIfOutView: true
-    	}
-    }
 
-	// ------------------------------
-	// Custom extend implemented interface
-	// ------------------------------
+    // ------------------------------
+    // Custom extend implemented interface
+    // ------------------------------
 
-    detectIfInView () {
-    	// your code
+    /**
+     * @type {boolean}
+     */  
+    get detectIfInView () {
+        // your code
     }
 
-    autoplayInViewObserve () {
-    	// your code
+    /**
+     * @protected
+     */
+    _autoplayInViewObserve () {
+        // your code
     }
 }
 ```

index.js

@@ -14,6 +14,20 @@ export class WebPluginInterface {
 		// code
 	}
 
+	/**
+	 * @type {Object}
+	 */
+	get defaultSettings () {
+		return {};
+	}
+
+	/**
+	 * @type {Object}
+	 */
+	get defaultProps () {
+		return {};
+	}
+
 	/**
 	 * @protected
 	 */
@@ -38,12 +52,4 @@ export class WebPluginInterface {
 	initialize () {
 		// code
 	}
-
-	get defaultSettings () {
-		return {};
-	}
-
-	get defaultProps () {
-		return {};
-	}
 }