Merge pull request #9 from dutchenkoOleg/master

docs

Author: OlehDutchenko

docs/examples/abstract-class.js

@@ -7,23 +7,32 @@
  * @version 0.0.1
  */
 
+// ----------------------------------------
+// Imports
+// ----------------------------------------
+
 import $ from 'jquery'; // for example
 import 'some-jquery-plugin'; // for example
 import { WebPluginInterface } from 'web-plugin-interface';
 
+// ----------------------------------------
+// Exports
+// ----------------------------------------
+
 /**
  * @implements WebPluginInterface
  */
 export class SomeJqueryPluginAbstract extends WebPluginInterface {
 	/**
 	 * @param {jQuery} $container
-	 * @param {Object} [customSettings={}]
-	 * @param {Object} [customProps={}]
+	 * @param {Object} [clientSettings={}]
+	 * @param {Object} [clientProps={}]
 	 */
-	constructor ($container, customSettings = {}, customProps = {}) {
+	constructor ($container, clientSettings = {}, clientProps = {}) {
 		super();
 		this.$container = $container;
-		this.customSettings = customSettings;
+		this.clientSettings = clientSettings;
+		this.clientProps = clientProps;
 		this.settings = {};
 		this.props = {};
 		this.readyCssClass = 'is-ready';
@@ -55,8 +64,8 @@ export class SomeJqueryPluginAbstract extends WebPluginInterface {
 	 * @protected
 	 */
 	_setup () {
-		this.props = $.extends({}, this.defaultProps, this.customProps);
-		this.settings = $.extends({}, this.defaultSettings, this.customSettings);
+		this.props = $.extends({}, this.defaultProps, this.clientProps);
+		this.settings = $.extends({}, this.defaultSettings, this.clientSettings);
 
 		// props example
 		if (this.props.stopAutoPlayIfOutView) {
@@ -93,9 +102,9 @@ export class SomeJqueryPluginAbstract extends WebPluginInterface {
 		this._afterInitialize();
 	}
 
-	// ------------------------------
+	// ***********************************
 	// Custom extend implemented interface
-	// ------------------------------
+	// ***********************************
 
 	/**
 	 * @type {boolean}

docs/examples/factory.js

@@ -0,0 +1,66 @@
+'use strict';
+
+/**
+ * @module examples/factory
+ * @description Example of Factories based on SomeJqueryPluginAbstract
+ * @author OlegDutchenko <[email protected]>
+ * @version 0.0.1
+ */
+
+// ----------------------------------------
+// Imports
+// ----------------------------------------
+
+import { SomeJqueryPluginAbstract } from './abstract-class';
+
+// ----------------------------------------
+// Exports
+// ----------------------------------------
+
+// A
+export class FactoryA extends SomeJqueryPluginAbstract {
+	/**
+	 * @type {Object}
+	 */
+	get defaultSettings () {
+		return {
+			autoplay: false,
+			speed: 750,
+			fade: true
+		}
+	}
+
+	/**
+	 * @type {Object}
+	 */
+	get defaultProps () {
+		return {
+			stopAutoPlayIfOutView: false
+		}
+	}
+}
+
+
+// B
+export class FactoryB extends SomeJqueryPluginAbstract {
+	/**
+	 * @protected
+	 */
+	_afterInitialize () {
+		super._afterInitialize();
+		// individual extend
+		// ...
+	}
+
+	/**
+	 * @type {Object}
+	 */
+	get defaultSettings () {
+		return {
+			speed: 600
+		}
+	}
+}
+
+// C
+// ...

docs/examples/index.js

@@ -0,0 +1,62 @@
+'use strict';
+
+/**
+ * @module examples/index
+ * @description Initialize all factories
+ * @author OlegDutchenko <[email protected]>
+ * @version 0.0.1
+ */
+
+// ----------------------------------------
+// Imports
+// ----------------------------------------
+
+import $ from 'jquery';
+import 'custom-jquery-methods/fn/has-inited-key'; // optional
+import { SomeJqueryPluginAbstract } from './abstract-class';
+import * as factory from './factory';
+
+// ----------------------------------------
+// Private
+// ----------------------------------------
+
+/**
+ * @param {jQuery} $container
+ * @param {string} key
+ * @return {SomeJqueryPluginAbstract}
+ * @private
+ */
+function _create ($container, key) {
+	const {
+		Factory,
+		settings: clientSettings = {},
+		props: clientProps = {}
+	} = $container.data(key) || {};
+
+	if (Factory in factory) {
+		return new factory[Factory]($container, clientSettings, clientProps);
+	}
+	return new SomeJqueryPluginAbstract($container, clientSettings, clientProps);
+}
+
+// ----------------------------------------
+// Exports
+// ----------------------------------------
+
+/**
+ * @param {jQuery} $containers
+ */
+export function initialize ($containers) {
+	$containers.each((i, container) => {
+		const $container = $(container);
+
+		// optional action
+		// avoid duplicated initializing
+		if ($container.hasInitedKey('someJqueryPluginIsInitialized')) {
+			return true;
+		}
+
+		const instance = _create($container, 'initialize-some-jquery-plugin');
+		instance.initialize();
+	});
+}

docs/index.md

@@ -8,3 +8,5 @@
 1. [Interface](./interface.md)
 1. Code examples
     - [examples/abstract-class](./examples/abstract-class.js)
+    - [examples/factory](./examples/factory.js)
+    - [examples/index](./examples/index.js)