Merge pull request #46 from typecode/issue-15

#15 - Custom color config & handling
typecode · Aug 20, 2018 · 7d8cf78 · 7d8cf78
2 parents c1ce7d8 + e537ae9
commit 7d8cf78
Show file tree

Hide file tree

Showing 14 changed files with 256 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,10 @@ Setting up Typester on your page is as easy as:
 ```
 import Typester from 'typester-editor'
 
-new Typester({ el: document.querySelector('[contenteditable]') }) // Where document.querySelector(...) is a single DOM element.
+const typesterInstance = new Typester({ el: document.querySelector('[contenteditable]') }) // Where document.querySelector(...) is a single DOM element.
+
+// If you need to tear down for any reason:
+typesterInstance.destroy();
 ```
 
 ### Configuration
@@ -43,6 +46,15 @@ new Typester({
     configs: {
         toolbar: {
             buttons: ['bold', 'italic', 'h1', 'h2', 'orderedlist', 'unorderedlist', 'quote', 'link']
+        },
+
+        styles: {
+          colors: {
+            flyoutBg: 'rgb(32, 31, 32)',
+            menuItemIcon: 'rgb(255, 255, 255)',
+            menuItemHover: 'rgb(0, 174, 239)',
+            menuItemActive: 'rgb(0, 156, 215)'
+          }
         }
     }
 });

diff --git a/src/scripts/config/styles.js b/src/scripts/config/styles.js
@@ -0,0 +1,8 @@
+export default {
+    colors: {
+        flyoutBg: 'rgb(32, 31, 32)',
+        menuItemIcon: 'rgb(255, 255, 255)',
+        menuItemHover: 'rgb(0, 174, 239)',
+        menuItemActive: 'rgb(0, 156, 215)'
+    }
+};
diff --git a/src/scripts/containers/AppContainer.js b/src/scripts/containers/AppContainer.js
@@ -116,6 +116,15 @@ const AppContainer = Container({
          */
         handleBlur () {
             // Should the container require to do anything in particular here
+        },
+
+        /**
+         * Destroy the entire Typeset instance
+         * @func destroy
+         */
+        destroy () {
+            const { mediator } = this;
+            mediator.emit('app:destroy');
         }
     }
 });

diff --git a/src/scripts/containers/UIContainer.js b/src/scripts/containers/UIContainer.js
@@ -19,6 +19,7 @@ import Container from '../core/Container';
 import Toolbar from '../modules/Toolbar';
 import Flyout from '../modules/Flyout';
 import Mouse from '../modules/Mouse';
+import Styles from '../modules/Styles';
 
 /**
  * @constructor UIContainer
@@ -32,7 +33,7 @@ const UIContainer = Container({
     /**
      * Child Modules: [{@link modules/Flyout}, {@link modules/Toolbar}]
      * Note: The Toobar is instantiated with the document body set as it's dom.el.
-     * @enum {Array<{class:Module}>} modules    
+     * @enum {Array<{class:Module}>} modules
      */
     modules: [
         {
@@ -48,6 +49,9 @@ const UIContainer = Container({
         },
         {
             class: Mouse
+        },
+        {
+            class: Styles
         }
     ]
 });

diff --git a/src/scripts/core/Container.js b/src/scripts/core/Container.js
@@ -166,7 +166,9 @@ const Container = function Container(containerObj) {
             return {
                 setMediatorParent (parentMediator) {
                     mediator.setParent(parentMediator);
-                }
+                },
+
+                destroy: boundMethods.destroy
             };
         }
     };

diff --git a/src/scripts/core/Mediator.js b/src/scripts/core/Mediator.js
@@ -122,6 +122,10 @@ const Mediator = function (opts={}) {
             if (requestHandler) {
                 return requestHandler(options);
             }
+        },
+
+        destroy () {
+            requests.handlers = {};
         }
     };
 
@@ -152,6 +156,10 @@ const Mediator = function (opts={}) {
             if (commandHandler) {
                 commandHandler(options);
             }
+        },
+
+        destroy () {
+            commands.handlers = {};
         }
     };
 
@@ -176,9 +184,18 @@ const Mediator = function (opts={}) {
 
         emit (eventKey, options) {
             const eventHandlers = events.getHandlers(eventKey);
+
             if (eventHandlers.length) {
                 eventHandlers.forEach((eventHandler) => eventHandler(options));
             }
+
+            if (eventKey === 'app:destroy') {
+                fn.destroy();
+            }
+        },
+
+        destroy () {
+            events.handlers = {};
         }
     };
 
@@ -370,6 +387,12 @@ const Mediator = function (opts={}) {
 
         getId () {
             return internal.id;
+        },
+
+        destroy () {
+            requests.destroy();
+            commands.destroy();
+            events.destroy();
         }
     };
 

diff --git a/src/scripts/core/Module.js b/src/scripts/core/Module.js
@@ -112,6 +112,11 @@ const Module = function (moduleObj) {
             moduleUtils.bindDomEvents(handlerMethods, context);
         },
 
+        deregisterDomHandlers (domHandlersMap, context) {
+            let handlerMethods = moduleUtils.getHandlerMethods(domHandlersMap, context);
+            moduleUtils.unbindDomEvents(handlerMethods, context);
+        },
+
         getHandlerMethods (handlerMap, context) {
             let routedHandlers = {};
 
@@ -171,6 +176,22 @@ const Module = function (moduleObj) {
             });
         },
 
+        unbindDomEvents (handlers, context) {
+            const { dom } = context;
+
+            if (!dom) {
+                return;
+            }
+
+            Object.keys(handlers).forEach((eventElKey) => {
+                const [eventKey, elemKey] = eventElKey.split(' @');
+                const elem = elemKey ? dom[elemKey][0] : dom.el[0];
+                const eventHandler = handlers[eventElKey];
+
+                elem.removeEventListener(eventKey, eventHandler);
+            });
+        },
+
         mergeProps (defaultProps, props={}) {
             let mergedProps = {};
 
@@ -248,6 +269,10 @@ const Module = function (moduleObj) {
                 context.setup();
             }
 
+            context.mediator.registerHandler('event', 'app:destroy', function () {
+                moduleProto.destroyModule(opts);
+            });
+
             if (moduleHandlers) {
                 moduleUtils.registerHandlers(opts.mediator, moduleHandlers, context);
             }
@@ -280,8 +305,12 @@ const Module = function (moduleObj) {
             }
         },
 
-        destroyModule () {
+        destroyModule (opts) {
+            const { context } = opts;
 
+            if (moduleHandlers.domEvents) {
+                moduleUtils.deregisterDomHandlers(moduleHandlers.domEvents, context);
+            }
         }
     };
 

diff --git a/src/scripts/modules/Config.js b/src/scripts/modules/Config.js
@@ -1,11 +1,12 @@
 import Module from '../core/Module';
 import toolbarConfig from '../config/toolbar';
 import config from '../config/config';
+import stylesConfig from '../config/styles';
 
 const Config = Module({
     name: 'Config',
     props: {},
-    acceptsConfigs: ['toolbar'],
+    acceptsConfigs: ['toolbar', 'styles'],
 
     handlers: {
         requests: {
@@ -16,7 +17,8 @@ const Config = Module({
             'config:toolbar:listTags' : 'getToolbarListTags',
             'config:toolbar:preventNewlineDefault' : 'getToolbarPreventNewlineDefault',
             'config:blockElementNames' : 'getConfigBlockElementNames',
-            'config:defaultBlock' : 'getDefaultBlock'
+            'config:defaultBlock' : 'getDefaultBlock',
+            'config:styles': 'getStyles'
         }
     },
 
@@ -70,6 +72,13 @@ const Config = Module({
 
         getDefaultBlock () {
             return config.defaultBlock;
+        },
+
+        getStyles () {
+            const { configs } = this;
+            return {
+                colors: Object.assign({}, stylesConfig.colors, configs.styles.colors)
+            };
         }
     }
 });

diff --git a/src/scripts/modules/Styles.js b/src/scripts/modules/Styles.js
@@ -0,0 +1,104 @@
+// jshint strict: false
+
+/**
+ * Styles -
+ * Handle the creation and embedding of custom styles.
+ * @access protected
+ * @module modules/Styles
+ */
+
+import Module from '../core/Module';
+
+const Styles = Module({
+    name: 'Styles',
+
+    props: {
+        stylesheet: null,
+    },
+
+    handlers: {
+        events: {
+            'app:destroy': 'destroy'
+        }
+    },
+
+    methods: {
+        setup () {
+            this.createStylesheet();
+        },
+
+        init () {
+            const { mediator } = this;
+            const config = mediator.get('config:styles');
+            let stylesheetContent = this.stylesTemplate(config);
+
+            this.appendStylesheet();
+            this.updateStylesheet(stylesheetContent);
+        },
+
+        stylesTemplate (config) {
+            return `
+                .typester-toolbar .typester-menu-item,
+                .typester-input-form input[type=text],
+                .typester-link-display a,
+                .typester-input-form button {
+                    color: ${config.colors.menuItemIcon};
+                }
+
+                .typester-toolbar .typester-menu-item svg,
+                .typester-link-display .typester-link-edit svg,
+                .typester-input-form button svg {
+                    fill: ${config.colors.menuItemIcon};
+                }
+
+                .typester-input-form button svg {
+                    stroke: ${config.colors.menuItemIcon};
+                }
+
+                .typester-toolbar .typester-menu-item:hover,
+                .typester-link-display .typester-link-edit:hover
+                .typester-input-form button:hover {
+                    background: ${config.colors.menuItemHover};
+                }
+
+                .typester-toolbar .typester-menu-item.s--active {
+                    background: ${config.colors.menuItemActive};
+                }
+
+                .typester-flyout .typester-flyout-content {
+                    background: ${config.colors.flyoutBg};
+                }
+
+                .typester-flyout.place-above .typester-flyout-arrow {
+                    border-top-color: ${config.colors.flyoutBg};
+                }
+
+                .typester-flyout.place-below .typester-flyout-arrow {
+                    border-bottom-color: ${config.colors.flyoutBg};
+                }
+            `;
+        },
+
+        createStylesheet () {
+            this.stylesheet = document.createElement('style');
+        },
+
+        appendStylesheet () {
+            document.head.appendChild(this.stylesheet);
+        },
+
+        updateStylesheet (stylesheetContent) {
+            this.stylesheet.textContent = stylesheetContent;
+        },
+
+        removeStylesheet () {
+            document.head.removeChild(this.stylesheet);
+        },
+
+        destroy () {
+            this.removeStylesheet();
+        }
+    }
+});
+
+export default Styles;
diff --git a/src/templates/inputForm.html b/src/templates/inputForm.html
@@ -3,7 +3,7 @@
     <button type='submit'>
         <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
              viewBox="0 180 20 20" enable-background="new 0 180 20 20" xml:space="preserve" height="20px" width="20px">
-             <polyline class="checkmark-2" fill="none" stroke="#FFFFFF" stroke-width="5.3" stroke-miterlimit="10" points="1.9,188.8 7.5,194.4 18.1,183.9 "/>
+             <polyline class="checkmark-2" fill="none" stroke-width="5.3" stroke-miterlimit="10" points="1.9,188.8 7.5,194.4 18.1,183.9 "/>
         </svg>
     </button>
     <button type='cancel'>

diff --git a/test/e2e/app/index.html b/test/e2e/app/index.html
@@ -5,11 +5,12 @@
   </head>
   <body>
       <div id='content-editable' class='content-editable' style='margin-top: 200px'></div>
+      <a class='destroy-control'>Destroy</a>
       <script src='/js/typester.js'></script>
       <script>
         console.log('Typester')
         console.log(Typester);
-        new Typester({
+        window.typesterInstance = new Typester({
             el: document.getElementById('content-editable')
         });
       </script>

diff --git a/test/e2e/test/pages/index.js b/test/e2e/test/pages/index.js
@@ -174,6 +174,24 @@ var pageCommands = {
         }, [], function (response) {
             console.log(response);
         });
+        return this;
+    },
+
+    destroy: function () {
+        var api = this.api;
+
+        api.execute(function () {
+            try {
+                window.typesterInstance.destroy();
+                return 'Destroyed!';
+            } catch (e) {
+                return e.message;
+            }
+        }, [], function (response) {
+            console.log('Destroy:');
+            console.log(response);
+        });
+
         return this;
     }
 };