Merge branch 'master' into hackday-upvote-downvote-ama

client/coral-embed-stream/src/reducers/configure.js

@@ -8,7 +8,7 @@ const initialState = {
   errors: {},
 };
 
-export default function config(state = initialState, action) {
+export default function configure(state = initialState, action) {
   switch (action.type) {
     case actions.UPDATE_PENDING: {
       let next = state;

client/coral-embed-stream/src/tabs/stream/containers/Stream.js

@@ -465,7 +465,6 @@ const mapStateToProps = state => ({
   activeStreamTab: state.stream.activeTab,
   previousStreamTab: state.stream.previousTab,
   commentClassNames: state.stream.commentClassNames,
-  pluginConfig: state.config.plugin_config,
   sortOrder: state.stream.sortOrder,
   sortBy: state.stream.sortBy,
 });

client/coral-embed/src/Stream.js

@@ -161,6 +161,14 @@ export default class Stream {
     );
   }
 
+  enablePluginsDebug() {
+    this.pym.sendMessage('enablePluginsDebug');
+  }
+
+  disablePluginsDebug() {
+    this.pym.sendMessage('disablePluginsDebug');
+  }
+
   login(token) {
     this.pym.sendMessage('login', token);
   }

client/coral-embed/src/StreamInterface.js

@@ -7,6 +7,10 @@ export default class StreamInterface {
     return this._stream.emitter.on(eventName, callback);
   }
 
+  off(eventName, callback) {
+    return this._stream.emitter.off(eventName, callback);
+  }
+
   login(token) {
     return this._stream.login(token);
   }
@@ -18,4 +22,12 @@ export default class StreamInterface {
   remove() {
     return this._stream.remove();
   }
+
+  enablePluginsDebug() {
+    return this._stream.enablePluginsDebug();
+  }
+
+  disablePluginsDebug() {
+    return this._stream.disablePluginsDebug();
+  }
 }

client/coral-framework/actions/config.js

@@ -1,6 +1,18 @@
-import { MERGE_CONFIG } from '../constants/config';
+import {
+  MERGE_CONFIG,
+  ENABLE_PLUGINS_DEBUG,
+  DISABLE_PLUGINS_DEBUG,
+} from '../constants/config';
 
 export const mergeConfig = config => ({
   type: MERGE_CONFIG,
   config,
 });
+
+export const enablePluginsDebug = () => ({
+  type: ENABLE_PLUGINS_DEBUG,
+});
+
+export const disablePluginsDebug = () => ({
+  type: DISABLE_PLUGINS_DEBUG,
+});

client/coral-framework/components/Slot.css

@@ -3,5 +3,36 @@
 }
 
 .debug {
-  background-color: coral;
+  background-color: #e2e2e2;
+  border-style: dotted solid;
+  border-width: 2px;
+  border: dotted 2px coral;
+  padding: 2px;
+  margin: 1px;
+  position: relative; 
+}
+
+.debug::before {
+  content: attr(data-slot-name);
+  display: inline-block;
+  position: absolute;
+
+  background: #000;
+  color: #FFF;
+  padding: 5px;
+  border-radius: 5px;
+  opacity: 0;
+  transition: 0.3s;
+  overflow: hidden;
+  pointer-events: none;
+  z-index: 999!important;
+  white-space: pre-wrap;
+  min-height: 16px;
+  top: 50%;
+  left: 0;
+}
+
+.debug:hover::before {
+  opacity: 1;
+  top: 100%;
 }

client/coral-framework/components/Slot.js

@@ -30,6 +30,7 @@ class Slot extends React.Component {
           className,
           `talk-slot-${kebabCase(fill)}`
         )}
+        data-slot-name={fill}
       >
         {children}
       </Component>

client/coral-framework/constants/config.js

@@ -1,3 +1,5 @@
 const prefix = `TALK_FRAMEWORK`;
 
 export const MERGE_CONFIG = `${prefix}_MERGE_CONFIG`;
+export const ENABLE_PLUGINS_DEBUG = `${prefix}_ENABLE_PLUGINS_DEBUG`;
+export const DISABLE_PLUGINS_DEBUG = `${prefix}_DISABLE_PLUGINS_DEBUG`;

client/coral-framework/hocs/withSlotElements.js

@@ -83,6 +83,13 @@ const createHOC = ({
         }
 
         if (changes.length === 1 && changes[0] === 'reduxState') {
+          // If config changed, we'll have to rerender everything.
+          // Should only happen during development as this is
+          // usually static.
+          if (this.props.reduxState.config !== next.reduxState.config) {
+            return true;
+          }
+
           const prevChildrenKeys = this.getSlotElements(this.props).map(
             child => child.key
           );

client/coral-framework/reducers/config.js

@@ -1,10 +1,30 @@
-import { MERGE_CONFIG } from '../constants/config';
+import {
+  MERGE_CONFIG,
+  ENABLE_PLUGINS_DEBUG,
+  DISABLE_PLUGINS_DEBUG,
+} from '../constants/config';
 import { LOGOUT } from '../constants/auth';
 
 const initialState = {};
 
 export default function config(state = initialState, action) {
   switch (action.type) {
+    case ENABLE_PLUGINS_DEBUG:
+      return {
+        ...state,
+        plugins_config: {
+          ...state.plugins_config,
+          debug: true,
+        },
+      };
+    case DISABLE_PLUGINS_DEBUG:
+      return {
+        ...state,
+        plugins_config: {
+          ...state.plugins_config,
+          debug: false,
+        },
+      };
     case LOGOUT:
       return {
         ...state,

client/coral-framework/services/bootstrap.js

@@ -25,7 +25,11 @@ import { createIntrospection } from 'coral-framework/services/introspection';
 import introspectionData from 'coral-framework/graphql/introspection.json';
 import coreReducers from '../reducers';
 import { checkLogin as checkLoginAction } from '../actions/auth';
-import { mergeConfig } from '../actions/config';
+import {
+  mergeConfig,
+  enablePluginsDebug,
+  disablePluginsDebug,
+} from '../actions/config';
 import { setAuthToken, logout } from '../actions/auth';
 
 /**
@@ -62,8 +66,19 @@ function initExternalConfig({ store, pym, inIframe }) {
   }
   return new Promise(resolve => {
     pym.sendMessage('getConfig');
-    pym.onMessage('config', config => {
-      store.dispatch(mergeConfig(JSON.parse(config)));
+    pym.onMessage('config', rawConfig => {
+      const config = JSON.parse(rawConfig);
+      if (config.plugin_config) {
+        // @Deprecated
+        if (process.env.NODE_ENV !== 'production') {
+          console.warn(
+            'Deprecation Warning: `config.plugin_config` will be phased out soon, please replace `config.plugin_config  with `config.plugins_config`'
+          );
+        }
+        config.plugins_config = config.plugin_config;
+        delete config.plugin_config;
+      }
+      store.dispatch(mergeConfig(config));
       resolve();
     });
   });
@@ -215,6 +230,14 @@ export async function createContext({
     pym.onMessage('logout', () => {
       store.dispatch(logout());
     });
+
+    pym.onMessage('enablePluginsDebug', () => {
+      store.dispatch(enablePluginsDebug());
+    });
+
+    pym.onMessage('disablePluginsDebug', () => {
+      store.dispatch(disablePluginsDebug());
+    });
   }
 
   const preInitList = [];

client/coral-framework/services/plugins.js

@@ -11,7 +11,7 @@ import values from 'lodash/values';
 import { getDisplayName } from 'coral-framework/helpers/hoc';
 import camelize from '../helpers/camelize';
 
-// This is returned for pluginConfig when it is empty.
+// This is returned for pluginsConfig when it is empty.
 const emptyConfig = {};
 
 // Memoize the warnings so we only show them once.
@@ -73,10 +73,10 @@ function addMetaDataToSlotComponents(plugins) {
  * query datas are only passed to the component if it is defined in `component.fragments`.
  */
 function getSlotComponentProps(component, reduxState, props, queryData) {
-  const pluginConfig = get(reduxState, 'config.plugin_config') || emptyConfig;
+  const pluginsConfig = get(reduxState, 'config.plugins_config') || emptyConfig;
   return {
     ...props,
-    config: pluginConfig,
+    config: pluginsConfig,
     ...(component.fragments
       ? pick(queryData, Object.keys(component.fragments))
       : withWarnings(component, queryData)),
@@ -125,15 +125,16 @@ class PluginsService {
    * Returns React Elements for given slot.
    */
   getSlotElements(slot, reduxState, props = {}, options = {}) {
-    const pluginConfig = get(reduxState, 'config.plugin_config') || emptyConfig;
+    const pluginsConfig =
+      get(reduxState, 'config.plugins_config') || emptyConfig;
     const { size = 0 } = options;
     const { queryData, rest } = splitProps(props);
 
     const isDisabled = component => {
       if (
-        pluginConfig &&
-        pluginConfig[component.talkPluginName] &&
-        pluginConfig[component.talkPluginName].disable_components
+        pluginsConfig &&
+        pluginsConfig[component.talkPluginName] &&
+        pluginsConfig[component.talkPluginName].disable_components
       ) {
         return true;
       }

docs/_config.yml

@@ -136,6 +136,8 @@ sidebar:
           url: /plugins-directory/
         - title: Plugin Recipes
           url: /plugin-recipes/
+        - title: Slots and Plugins
+          url: /slots-and-plugins/
     - title: Tutorials
       children:
         - title: Creating a Basic Plugin

docs/source/04-06-slots-and-plugins.md

@@ -0,0 +1,169 @@
+---
+title: Slots and Plugins
+permalink: /slots-and-plugins/
+---
+
+Plugins make use of **"slots"** in order to change Talk's interface.
+
+By default, Talk has various plugins provided by default. We can see this in `plugins.default.json`: 
+
+```json
+{
+  "server": [
+    "talk-plugin-auth",
+    "talk-plugin-featured-comments",
+    "talk-plugin-offtopic",
+    "talk-plugin-respect"
+  ],
+  "client": [
+    "talk-plugin-auth",
+    "talk-plugin-author-menu",
+    "talk-plugin-comment-content",
+    "talk-plugin-featured-comments",
+    "talk-plugin-flag-details",
+    "talk-plugin-ignore-user",
+    "talk-plugin-member-since",
+    "talk-plugin-moderation-actions",
+    "talk-plugin-offtopic",
+    "talk-plugin-permalink",
+    "talk-plugin-respect",
+    "talk-plugin-sort-most-replied",
+    "talk-plugin-sort-most-respected",
+    "talk-plugin-sort-newest",
+    "talk-plugin-sort-oldest",
+    "talk-plugin-viewing-options",
+    "talk-plugin-profile-settings"
+  ]
+}
+```
+
+Let's only focus on the plugins which are listed under `client` - these are the plugins that use *slots* to inject certain functionality into the Talk UI.
+
+For example, if we look at the Respect plugin (`talk-plugin-respect`), we can see its `client/index.js` looks like this:
+
+
+```js
+import RespectButton from './RespectButton';
+import translations from './translations.yml';
+
+export default {
+  translations,
+  slots: {
+    commentReactions: [RespectButton],
+  },
+};
+
+```
+
+Inside the `slots` property, we specify which **slots** the plugin will use. Above we are saying that the `RespectButton` component is being injected into the slot `commentReactions`.
+
+Slots can receive an Array of components, so we can use one plugin or many for one slot.
+
+### Anatomy of the Slot Component
+
+In Talk core, we have 32 slots available for us to use. The component `Slot` has a `fill` property where we establish the name of the slot. It looks like this:
+
+
+```js
+<Slot 
+  fill="commentReactions"
+	{...props}
+/>
+```
+
+You won't have to use this to build plugins, but it's helpful to find where to embed your plugin.
+
+### Slot List
+
+* `adminCommentDetailArea`
+* `adminCommentMoreDetails`
+* `adminCommentLabels`
+* `adminModerationSettings`
+* `adminStreamSettings`
+* `adminTechSettings`
+* `adminCommentInfoBar`
+* `adminCommentContent`
+* `adminSideActions`
+* `adminModeration`
+* `adminModerationIndicator`
+
+* `commentInputDetailArea`
+* `commentAvatar`
+* `commentAuthorName`
+* `commentAuthorTags`
+* `commentTimestamp`
+* `commentInfoBar`
+* `commentContent`
+* `commentReactions`
+* `commentActions`
+* `commentInputArea`
+
+* `draftArea`
+* `streamSettings`
+* `historyCommentTimestamp`
+* `profileSections`
+* `embed`
+* `stream`
+* `streamFilter`
+* `streamQuestionArea`
+* `login`
+* `userProfile`
+* `userDetailCommentContent`
+
+### Where should I insert my plugin?
+
+The first thing we should consider is what components will be affected by our plugin's functionality. For example, if we want to add functionality to all the comments that are rendered in a total list of comments, we would use the component `Comment`.
+
+The slots that are able to add functionality to comments start with `comment`, like `commentContent`, or `commentReactions`, as you can see above.
+
+### Disabling plugins via `plugins_config`
+
+Typically, you will manage plugins via your `plugins.json` file. If you want to remove a plugin, you would simply delete it there. However, we can also do this directly with the `plugins_config`.
+
+Let's look at our example article, `views/article.ejs`. Here we see we have the Talk embed, and within the embed, we can also send a configuration object. To disable a plugin visually, we can pass `true` to the property `disable_components`. Like so:
+
+
+```js 
+plugins_config: {
+  'talk-plugin-love': {
+    disable_components: true,
+   },
+}
+```
+
+### Sending information to slots and plugins
+
+
+Inside our `plugins_config`, we can also send properities and our plugins will receive them. For example, if we send this:
+
+```js 
+plugins_config: {
+  test: 'data'
+}
+```
+
+The plugin will receive a config object with the properties we've passed. If we do a `console.log` with `this.props`, we would see:
+
+```js
+config: {test: 'data'}
+```
+
+### Debugging slots and plugins
+
+
+You can debug slots and plugins simply by passing the `debug` property with value `true`:
+
+
+```js 
+plugins_config: {
+  debug: true
+}
+```
+
+This will turn on a visual aid to show you all of Talk's available slots and their names. Just move your mouse around!
+
+### Slot ClassNames
+
+Slots autogenerate their classes with the prefix `talk-slot`, followed by the name of the slot in kebab case.
+
+For example, the class autogenerated for the slot `commentContent` is `talk-slot-comment-content`.

plugin-api/beta/client/selectors/index.js

@@ -1 +1 @@
-export const pluginConfigSelector = state => state.config.pluginConfig;
+export const pluginsConfigSelector = state => state.config.plugins_config;

views/article.ejs

@@ -42,7 +42,7 @@
          *    });
          *  },
          */
-        plugin_config: {
+        plugins_config: {
           /**
            *  You can disable rendering slot components of a plugin by doing:
            *