newspack-components 2.1.0 → 2.2.0

package/dist/cjs/plugin-settings/index.js

@@ -1,37 +1,28 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _classnames = _interopRequireDefault(require("classnames"));
-
 var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
-
 var _element = require("@wordpress/element");
-
 var _i18n = require("@wordpress/i18n");
-
 var _ = require("../");
-
 var _SettingsSection = _interopRequireDefault(require("./SettingsSection"));
-
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-
 /**
  * External dependencies
  */
-
 /**
  * WordPress dependencies.
  */
+/**
+ * Internal dependencies.
+ */
 const __ = _i18n.__;
-
 class PluginSettings extends _element.Component {
   constructor() {
     super(...arguments);
@@ -51,7 +42,6 @@ class PluginSettings extends _element.Component {
           settings,
           error: null
         });
-
         if ('function' === typeof afterFetch) {
           afterFetch(settings);
         }
@@ -79,7 +69,8 @@ class PluginSettings extends _element.Component {
         }
       });
       this.setState({
-        settings: { ...this.state.settings,
+        settings: {
+          ...this.state.settings,
           [sectionKey]: sectionSettings
         }
       });
@@ -102,10 +93,12 @@ class PluginSettings extends _element.Component {
         }
       }).then(settings => {
         this.setState({
-          settings,
+          settings: {
+            ...this.state.settings,
+            [sectionKey]: settings[sectionKey]
+          },
           error: null
         });
-
         if ('function' === typeof afterUpdate) {
           afterUpdate(settings);
         }
@@ -119,27 +112,55 @@ class PluginSettings extends _element.Component {
         });
       });
     });
+    /**
+     * Get the section setting containing section information.
+     *
+     * @param {string} sectionKey The section name.
+     * @return {Object} The section setting.
+     */
     (0, _defineProperty2.default)(this, "getSectionInfo", sectionKey => {
       return this.state.settings[sectionKey]?.find(setting => !setting.key || setting.key === 'active');
     });
+    /**
+     * Get the section title.
+     *
+     * @param {string} sectionKey The section name.
+     * @return {string} The section title.
+     */
     (0, _defineProperty2.default)(this, "getSectionTitle", sectionKey => {
       return this.getSectionInfo(sectionKey)?.description;
     });
+    /**
+     * Get the section description.
+     *
+     * @param {string} sectionKey The section name.
+     * @return {string} The section description.
+     */
     (0, _defineProperty2.default)(this, "getSectionDescription", sectionKey => {
       return this.getSectionInfo(sectionKey)?.help;
     });
+    /**
+     * Get whether a section is active.
+     *
+     * @param {string} sectionKey The section name.
+     * @return {?boolean} Whether the section is active or not. Null if the section is not found or does not support activation.
+     */
     (0, _defineProperty2.default)(this, "isSectionActive", sectionKey => {
       const {
         settings
       } = this.state;
       const activation = settings[sectionKey]?.find(setting => setting.key === 'active');
-
       if (!activation) {
         return null;
       }
-
       return activation.value;
     });
+    /**
+     * Get list of section field settings.
+     *
+     * @param {string} sectionKey The section name.
+     * @return {?Array} List of section fields.
+     */
     (0, _defineProperty2.default)(this, "getSectionFields", sectionKey => {
       return this.state.settings[sectionKey]?.filter(setting => setting.key && setting.key !== 'active');
     });
@@ -149,11 +170,9 @@ class PluginSettings extends _element.Component {
       error: null
     };
   }
-
   componentDidMount() {
     this.fetchSettings();
   }
-
   /**
    * Render.
    */
@@ -194,9 +213,7 @@ class PluginSettings extends _element.Component {
       })]
     });
   }
-
 }
-
 PluginSettings.defaultProps = {
   title: __('General Settings', 'newspack')
 };

package/dist/cjs/plugin-toggle/index.js

@@ -1,31 +1,24 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
-
 var _element = require("@wordpress/element");
-
 var _i18n = require("@wordpress/i18n");
-
 var _ = require("../");
-
 require("./style.scss");
-
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-
 /**
  * WordPress dependencies.
  */
+/**
+ * Internal dependencies.
+ */
 const __ = _i18n.__;
-
 /**
  * Plugin toggle group component.
  */
@@ -38,6 +31,9 @@ class PluginToggle extends _element.Component {
     (0, _defineProperty2.default)(this, "componentDidMount", () => {
       this.retrievePluginInfo();
     });
+    /**
+     * Retrieve complete data about Newspack plugins.
+     */
     (0, _defineProperty2.default)(this, "retrievePluginInfo", () => {
       return new Promise(() => {
         (0, _apiFetch.default)({
@@ -47,6 +43,9 @@ class PluginToggle extends _element.Component {
         }));
       });
     });
+    /**
+     * Install/activate or remove a plugin.
+     */
     (0, _defineProperty2.default)(this, "managePlugin", (plugin, value) => {
       const {
         plugins
@@ -60,8 +59,10 @@ class PluginToggle extends _element.Component {
         method: 'post'
       };
       this.setState({
-        pluginInfo: { ...pluginInfo,
-          [plugin]: { ...pluginInfo[plugin],
+        pluginInfo: {
+          ...pluginInfo,
+          [plugin]: {
+            ...pluginInfo[plugin],
             inFlight: action
           }
         }
@@ -75,15 +76,18 @@ class PluginToggle extends _element.Component {
               pluginInfo: currentPluginInfo
             } = _ref;
             return {
-              pluginInfo: { ...currentPluginInfo,
+              pluginInfo: {
+                ...currentPluginInfo,
                 [plugin]: response
               }
             };
           }, () => shouldRefreshAfterUpdate && location.reload());
         }).catch(e => {
           this.setState({
-            pluginInfo: { ...pluginInfo,
-              [plugin]: { ...pluginInfo[plugin],
+            pluginInfo: {
+              ...pluginInfo,
+              [plugin]: {
+                ...pluginInfo[plugin],
                 error: e.message || __('There was an error managing this plugin.', 'newspack')
               }
             }
@@ -91,23 +95,31 @@ class PluginToggle extends _element.Component {
         });
       });
     });
-    (0, _defineProperty2.default)(this, "prepareDataForRender", (pluginsFromProps, pluginsFromAPI) => Object.keys(pluginsFromProps).map(pluginSlug => pluginsFromAPI[pluginSlug] ? Object.keys(pluginsFromAPI[pluginSlug]).reduce((accumulator, key) => ({ ...accumulator,
+    /**
+     * Prepare plugins data for render. Change all keys to camelCase, merge API-fetched data with prop.
+     */
+    (0, _defineProperty2.default)(this, "prepareDataForRender", (pluginsFromProps, pluginsFromAPI) => Object.keys(pluginsFromProps).map(pluginSlug => pluginsFromAPI[pluginSlug] ? Object.keys(pluginsFromAPI[pluginSlug]).reduce((accumulator, key) => ({
+      ...accumulator,
       [key.charAt(0).toLowerCase() + key.slice(1)]: pluginsFromAPI[pluginSlug][key]
     }), {}) : {}).map(plugin => Object.assign(plugin, pluginsFromProps[plugin.slug])));
+    /**
+     * Generate a classname for the ActionCard based on plugin state. Applies 'in-flight' class if an API is underway and 'loading' if the plugin data is not yet available.
+     */
     (0, _defineProperty2.default)(this, "classNameForPlugin", plugin => {
       const {
         status,
         inFlight
       } = plugin;
-
       if (inFlight) {
         return 'in-flight';
       }
-
       if (!status) {
         return 'loading';
       }
     });
+    /**
+     * Generate the ActionCard action text for a plugin.
+     */
     (0, _defineProperty2.default)(this, "actionTextForPlugin", plugin => {
       const {
         actionText,
@@ -115,8 +127,8 @@ class PluginToggle extends _element.Component {
         href,
         inFlight,
         name
-      } = plugin; // Show spinner when plugin data is unavailable, or when an API call is in flight.
-
+      } = plugin;
+      // Show spinner when plugin data is unavailable, or when an API call is in flight.
       if ('configure' === inFlight) {
         return (0, _jsxRuntime.jsxs)(_element.Fragment, {
           children: [__('Installing…', 'newspack'), " ", (0, _jsxRuntime.jsx)(_.Waiting, {
@@ -124,7 +136,6 @@ class PluginToggle extends _element.Component {
           })]
         });
       }
-
       if ('deactivate' === inFlight) {
         return (0, _jsxRuntime.jsxs)(_element.Fragment, {
           children: [__('Deactivating…', 'newspack'), " ", (0, _jsxRuntime.jsx)(_.Waiting, {
@@ -132,24 +143,24 @@ class PluginToggle extends _element.Component {
           })]
         });
       }
-
       if (!name) {
         return (0, _jsxRuntime.jsxs)(_element.Fragment, {
           children: [__('Loading…', 'newspack'), " ", (0, _jsxRuntime.jsx)(_.Waiting, {
             isRight: true
           })]
         });
-      } // No action button at all if the plugin isn't installed and active.
-
-
+      }
+      // No action button at all if the plugin isn't installed and active.
       if (!this.isPluginInstalledAndActive(plugin)) {
         return null;
       }
-
       if (href || editPath) {
         return actionText ? actionText : __('Configure', 'newspack');
       }
     });
+    /**
+     * Get error message for this plugin.
+     */
     (0, _defineProperty2.default)(this, "errorForPlugin", plugin => {
       const {
         slug
@@ -159,6 +170,9 @@ class PluginToggle extends _element.Component {
       } = this.state;
       return pluginInfo[slug]?.error || null;
     });
+    /**
+     * Get installation/activation status for a plugin.
+     */
     (0, _defineProperty2.default)(this, "isPluginInstalledAndActive", plugin => {
       const {
         status
@@ -166,7 +180,6 @@ class PluginToggle extends _element.Component {
       return status === 'active';
     });
   }
-
   /**
    * Render.
    */
@@ -204,12 +217,6 @@ class PluginToggle extends _element.Component {
       }, index);
     });
   }
-  /**
-   * Prepare plugins data for render. Change all keys to camelCase, merge API-fetched data with prop.
-   */
-
-
 }
-
 var _default = PluginToggle;
 exports.default = _default;

package/dist/cjs/plugin-toggle/style.scss

@@ -2,7 +2,7 @@
  * Plugin Toggle
  */
 
-@import '~@wordpress/base-styles/colors';
+@use '~@wordpress/base-styles/colors' as wp-colors;
 
 .newspack-action-card {
 	&.in-flight,
@@ -11,7 +11,7 @@
 
 		.newspack-action-card__region-right {
 			.newspack-button {
-				color: $gray-700;
+				color: wp-colors.$gray-700;
 				pointer-events: none;
 				text-decoration: none;
 			}

package/dist/cjs/popover/index.js

@@ -1,22 +1,15 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _components = require("@wordpress/components");
-
 var _element = require("@wordpress/element");
-
 require("./style.scss");
-
 var _classnames = _interopRequireDefault(require("classnames"));
-
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-
 /**
  * WordPress dependencies
  */
@@ -31,8 +24,7 @@ var _jsxRuntime = require("@emotion/react/jsx-runtime");
 
 /**
  * Popover
- */
-class Popover extends _element.Component {
+ */class Popover extends _element.Component {
   /**
    * Render
    */
@@ -48,9 +40,7 @@ class Popover extends _element.Component {
       ...otherProps
     });
   }
-
 }
-
 Popover.defaultProps = {
   padding: false
 };

package/dist/cjs/popover/style.scss

@@ -2,30 +2,29 @@
  * Popover
  */
 
-@import '../../../shared/scss/colors';
-@import '~@wordpress/base-styles/colors';
+@use '../../../shared/scss/colors';
+@use '~@wordpress/base-styles/colors' as wp-colors;
 
 .newspack-popover {
 	.components-popover__content {
-		border: 1px solid $gray-300;
-		border-radius: 2px;
-		box-shadow: 0 4px 8px rgba( black, 0.08 );
 		min-width: 238px;
 
 		.newspack-button {
-			color: $gray-700;
+			color: wp-colors.$gray-700;
 			display: flex;
 			font-weight: normal;
 			padding: 6px 8px;
 
 			&:hover {
+				color: colors.$primary-500;
+
 				.components-menu-items__item-icon {
-					fill: currentColor;
+					fill: currentcolor;
 				}
 			}
 
 			&:focus:not( :disabled ) {
-				box-shadow: inset 0 0 0 2px $primary-500;
+				box-shadow: inset 0 0 0 2px colors.$primary-500;
 				position: relative;
 				z-index: 1;
 			}
@@ -36,14 +35,14 @@
 				text-decoration: none;
 
 				&:not( .is-destructive ) {
-					color: $gray-700;
+					color: wp-colors.$gray-700;
 
 					&:active,
 					&:active:enabled,
 					&:focus,
 					&:focus:enabled &:hover,
-					&:not( :disabled ):not( [aria-disabled='true'] ):not( .is-default ):hover {
-						color: $primary-500;
+					&:not( :disabled, [aria-disabled='true'], .is-default ):hover {
+						color: colors.$primary-500;
 					}
 				}
 
@@ -53,8 +52,12 @@
 				}
 			}
 
+			&.is-destructive:not( :focus ) {
+				box-shadow: none !important;
+			}
+
 			.components-menu-items__item-icon {
-				fill: $gray-900;
+				fill: wp-colors.$gray-900;
 			}
 
 			.components-menu-item__item {
@@ -64,7 +67,7 @@
 		}
 
 		.components-menu-group__label {
-			color: $gray-900;
+			color: wp-colors.$gray-900;
 			font-size: 12px;
 			font-weight: bold;
 			line-height: 16px;
@@ -86,8 +89,8 @@
 					min-height: 36px;
 
 					&:focus ~ div.components-input-control__backdrop {
-						border-color: $primary-500;
-						box-shadow: inset 0 0 0 1px $primary-500;
+						border-color: colors.$primary-500;
+						box-shadow: inset 0 0 0 1px colors.$primary-500;
 					}
 				}
 
@@ -129,7 +132,7 @@
 	}
 
 	&:not( .is-without-arrow )::before {
-		border-color: $gray-300;
+		border-color: wp-colors.$gray-300;
 	}
 
 	&.is-from-bottom {

package/dist/cjs/position-control/index.js

@@ -0,0 +1,113 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = PositionControl;
+var _i18n = require("@wordpress/i18n");
+var _components = require("@wordpress/components");
+var _classnames = _interopRequireDefault(require("classnames"));
+require("./style.scss");
+var _jsxRuntime = require("@emotion/react/jsx-runtime");
+/**
+ * WordPress dependencies
+ */
+const __ = _i18n.__;
+/**
+ * External dependencies
+ */
+/**
+ * Internal dependencies
+ */
+function PositionControl(_ref) {
+  let {
+    allowedPositions,
+    value,
+    label,
+    help,
+    onChange,
+    size,
+    ...props
+  } = _ref;
+  /**
+   * Set layout options
+   */
+  const options = size === 'full-width' ? [{
+    value: 'top',
+    /* translators: Overlay Position */
+    label: __('Top', 'newspack')
+  }, {
+    value: 'center',
+    /* translators: Overlay Position */
+    label: __('Center', 'newspack')
+  }, {
+    value: 'bottom',
+    /* translators: Overlay Position */
+    label: __('Bottom', 'newspack')
+  }] : [{
+    value: 'top_left',
+    /* translators: Overlay Position */
+    label: __('Top Left', 'newspack')
+  }, {
+    value: 'top',
+    /* translators: Overlay Position */
+    label: __('Top Center', 'newspack')
+  }, {
+    value: 'top_right',
+    /* translators: Overlay Position */
+    label: __('Top Right', 'newspack')
+  }, {
+    value: 'center_left',
+    /* translators: Overlay Position */
+    label: __('Center Left', 'newspack')
+  }, {
+    value: 'center',
+    /* translators: Overlay Position */
+    label: __('Center', 'newspack')
+  }, {
+    value: 'center_right',
+    /* translators: Overlay Position */
+    label: __('Center Right', 'newspack')
+  }, {
+    value: 'bottom_left',
+    /* translators: Overlay Position */
+    label: __('Bottom Left', 'newspack')
+  }, {
+    value: 'bottom',
+    /* translators: Overlay Position */
+    label: __('Bottom Center', 'newspack')
+  }, {
+    value: 'bottom_right',
+    /* translators: Overlay Position */
+    label: __('Bottom Right', 'newspack')
+  }];
+  return (0, _jsxRuntime.jsxs)("div", {
+    className: (0, _classnames.default)('newspack-position-placement-control', 'size-' + size),
+    children: [(0, _jsxRuntime.jsx)("p", {
+      className: "components-base-control__label",
+      children: label
+    }), (0, _jsxRuntime.jsx)(_components.ButtonGroup, {
+      "aria-label": __('Select Position', 'newspack'),
+      ...props,
+      children: options.map((option, index) => {
+        return (0, _jsxRuntime.jsx)("div", {
+          className: option.value === value ? 'is-selected' : null,
+          children: (0, _jsxRuntime.jsx)(_components.Button, {
+            isSmall: true,
+            title: option.label,
+            "aria-label": option.label,
+            isPrimary: option.value === value,
+            onClick: () => {
+              onChange(option.value);
+            },
+            disabled: allowedPositions?.length && !allowedPositions.includes(option.value)
+          })
+        }, `newspack-position-placement-item-${index}`);
+      })
+    }), (0, _jsxRuntime.jsx)("p", {
+      className: "components-base-control__help",
+      children: help
+    })]
+  });
+}

package/dist/cjs/position-control/style.scss

@@ -0,0 +1,66 @@
+@use '~@wordpress/base-styles/colors' as wp-colors;
+
+.newspack-position-placement-control {
+	margin-bottom: 1em;
+
+	.components-base-control__label {
+		margin-bottom: 8px;
+		margin-top: 1em;
+	}
+
+	.components-button-group {
+		display: grid;
+		grid-template-columns: repeat( 3, 1fr );
+		grid-template-rows: repeat( 3, 1fr );
+
+		div {
+			padding: 1px;
+		}
+
+		.components-button {
+			border-radius: 0 !important;
+			height: 100%;
+			padding: 20px;
+			width: 100%;
+		}
+
+		div:nth-of-type( 1 ) .components-button {
+			border-radius: 4px 0 0 !important;
+		}
+
+		div:nth-of-type( 3 ) .components-button {
+			border-radius: 0 4px 0 0 !important;
+		}
+
+		div:nth-last-of-type( 1 ) .components-button {
+			border-radius: 0 0 4px !important;
+		}
+
+		div:nth-last-of-type( 3 ) .components-button {
+			border-radius: 0 0 0 4px !important;
+		}
+	}
+
+	&.size-full-width .components-button-group {
+		grid-template-columns: 1fr;
+
+		div:first-of-type .components-button {
+			border-radius: 4px 4px 0 0 !important;
+		}
+
+		div:nth-of-type( 2 ) .components-button {
+			border-radius: 0 !important;
+		}
+
+		div:last-of-type .components-button {
+			border-radius: 0 0 4px 4px !important;
+		}
+	}
+
+	.components-base-control__help {
+		color: wp-colors.$gray-700;
+		font-size: 12px;
+		font-style: normal;
+		margin-top: 8px;
+	}
+}