docs

Author: dutchenkoOleg

docs/examples/abstract-class.js

@@ -25,13 +25,14 @@ import { WebPluginInterface } from 'web-plugin-interface';
 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';
@@ -63,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) {

docs/examples/factory.js

@@ -1,8 +1,8 @@
 'use strict';
 
 /**
- * @module examples/abstract-class
- * @description Abstract class example with WebPluginInterface implementation
+ * @module examples/factory
+ * @description Example of Factories based on SomeJqueryPluginAbstract
  * @author OlegDutchenko <[email protected]>
  * @version 0.0.1
  */

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();
+	});
+}