newspack-components 3.0.0-alpha.2 → 3.0.0-alpha.3

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

@@ -0,0 +1,106 @@
+/**
+ * WordPress dependencies
+ */
+import { __ } from '@wordpress/i18n';
+import { ButtonGroup, Button } from '@wordpress/components';
+
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
+/**
+ * Internal dependencies
+ */
+import './style.scss';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+export default function PositionControl({
+  allowedPositions,
+  value,
+  label,
+  help,
+  onChange,
+  size,
+  ...props
+}) {
+  /**
+   * Set layout options
+   */
+  const options = size === 'full-width' ? [{
+    value: 'top',
+    /* translators: Overlay Position */
+    label: __('Top', 'newspack-plugin')
+  }, {
+    value: 'center',
+    /* translators: Overlay Position */
+    label: __('Center', 'newspack-plugin')
+  }, {
+    value: 'bottom',
+    /* translators: Overlay Position */
+    label: __('Bottom', 'newspack-plugin')
+  }] : [{
+    value: 'top_left',
+    /* translators: Overlay Position */
+    label: __('Top Left', 'newspack-plugin')
+  }, {
+    value: 'top',
+    /* translators: Overlay Position */
+    label: __('Top Center', 'newspack-plugin')
+  }, {
+    value: 'top_right',
+    /* translators: Overlay Position */
+    label: __('Top Right', 'newspack-plugin')
+  }, {
+    value: 'center_left',
+    /* translators: Overlay Position */
+    label: __('Center Left', 'newspack-plugin')
+  }, {
+    value: 'center',
+    /* translators: Overlay Position */
+    label: __('Center', 'newspack-plugin')
+  }, {
+    value: 'center_right',
+    /* translators: Overlay Position */
+    label: __('Center Right', 'newspack-plugin')
+  }, {
+    value: 'bottom_left',
+    /* translators: Overlay Position */
+    label: __('Bottom Left', 'newspack-plugin')
+  }, {
+    value: 'bottom',
+    /* translators: Overlay Position */
+    label: __('Bottom Center', 'newspack-plugin')
+  }, {
+    value: 'bottom_right',
+    /* translators: Overlay Position */
+    label: __('Bottom Right', 'newspack-plugin')
+  }];
+  return /*#__PURE__*/_jsxs("div", {
+    className: classnames('newspack-position-placement-control', 'size-' + size),
+    children: [/*#__PURE__*/_jsx("p", {
+      className: "components-base-control__label",
+      children: label
+    }), /*#__PURE__*/_jsx(ButtonGroup, {
+      "aria-label": __('Select Position', 'newspack-plugin'),
+      ...props,
+      children: options.map((option, index) => {
+        return /*#__PURE__*/_jsx("div", {
+          className: option.value === value ? 'is-selected' : null,
+          children: /*#__PURE__*/_jsx(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}`);
+      })
+    }), /*#__PURE__*/_jsx("p", {
+      className: "components-base-control__help",
+      children: help
+    })]
+  });
+}

package/dist/esm/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;
+	}
+}

package/dist/esm/progress-bar/index.js

@@ -0,0 +1,68 @@
+/**
+ * Progress Bar
+ */
+
+/**
+ * WordPress dependencies.
+ */
+import { Component } from '@wordpress/element';
+
+/**
+ * Internal dependencies.
+ */
+import './style.scss';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+class ProgressBar extends Component {
+  /**
+   * Get completion as a percentage.
+   *
+   * @param {number} completed The number of steps completed.
+   * @param {number} total     The total number of steps.
+   * @return {number} completion percentage
+   */
+  getCompletionPercentage(completed, total) {
+    if (!total) {
+      return 100;
+    }
+    return Math.max(Math.min(Math.round(completed / total * 100), 100), 0);
+  }
+
+  /**
+   * Render.
+   */
+  render() {
+    const {
+      label,
+      completed,
+      total,
+      displayFraction
+    } = this.props;
+    const cleanTotal = Math.max(0, parseInt(total) || 0);
+    const cleanCompleted = Math.max(0, Math.min(parseInt(completed) || 0, parseInt(cleanTotal)));
+    const barStyle = {
+      width: this.getCompletionPercentage(cleanCompleted, cleanTotal) + '%'
+    };
+    return /*#__PURE__*/_jsxs("div", {
+      className: "newspack-progress-bar",
+      children: [(label || displayFraction) && /*#__PURE__*/_jsxs("div", {
+        className: "newspack-progress-bar__headings",
+        children: [label && /*#__PURE__*/_jsx("h2", {
+          children: label
+        }), displayFraction && /*#__PURE__*/_jsx("p", {
+          className: "is-dark",
+          children: /*#__PURE__*/_jsxs("strong", {
+            children: [cleanCompleted, "/", cleanTotal]
+          })
+        })]
+      }), /*#__PURE__*/_jsx("div", {
+        className: "newspack-progress-bar__container",
+        children: /*#__PURE__*/_jsx("div", {
+          className: "newspack-progress-bar__bar",
+          style: barStyle,
+          "data-testid": "progress-bar-indicator"
+        })
+      })]
+    });
+  }
+}
+export default ProgressBar;

package/dist/esm/progress-bar/index.test.js

@@ -0,0 +1,108 @@
+import React, { createElement as _createElement } from 'react';
+import { render } from '@testing-library/react';
+import ProgressBar from './';
+import { jsx as _jsx } from "react/jsx-runtime";
+describe('ProgressBar', () => {
+  it('should render a progress indicator', () => {
+    const {
+      getByTestId
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "1",
+      total: "2"
+    }));
+    const indicator = getByTestId('progress-bar-indicator');
+    expect(indicator).toHaveAttribute('style', 'width: 50%;');
+  });
+  it('should render a label', () => {
+    const label = 'test label';
+    const {
+      getByText
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "1",
+      total: "2",
+      label: label
+    }));
+    expect(getByText(label)).toBeInTheDocument();
+  });
+  it('should render progress as a fraction', () => {
+    const {
+      getByText
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "1",
+      total: "2",
+      displayFraction: true
+    }));
+    expect(getByText('1/2')).toBeInTheDocument();
+  });
+  it('should render with both label and fraction', () => {
+    const label = 'test label';
+    const {
+      getByText
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "1",
+      total: "2",
+      label: label,
+      displayFraction: true
+    }));
+    expect(getByText(label)).toBeInTheDocument();
+    expect(getByText('1/2')).toBeInTheDocument();
+  });
+  describe('should calculate progress correctly', () => {
+    [{
+      props: {
+        completed: 1,
+        total: 2
+      },
+      expectedWidth: 50
+    }, {
+      props: {
+        completed: 2,
+        total: 3
+      },
+      expectedWidth: 67
+    }, {
+      props: {
+        completed: 6,
+        total: 3
+      },
+      expectedWidth: 100
+    }].forEach(({
+      props,
+      expectedWidth
+    }) => {
+      it(`with expected  progress of ${expectedWidth}`, () => {
+        const {
+          getByTestId
+        } = render( /*#__PURE__*/_createElement(ProgressBar, {
+          ...props,
+          key: expectedWidth
+        }));
+        expect(getByTestId('progress-bar-indicator')).toHaveAttribute('style', `width: ${expectedWidth}%;`);
+      });
+    });
+  });
+  it('should handle non-numeric values in ProgressBar element', () => {
+    const {
+      getByText,
+      getByTestId
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "cats",
+      total: "dogs",
+      displayFraction: true
+    }));
+    expect(getByText('0/0')).toBeInTheDocument();
+    expect(getByTestId('progress-bar-indicator')).toHaveAttribute('style', 'width: 100%;');
+  });
+  it('should handle non-logical values in ProgressBar element', () => {
+    const {
+      getByText,
+      getByTestId
+    } = render( /*#__PURE__*/_jsx(ProgressBar, {
+      completed: "3",
+      total: "-1",
+      displayFraction: true
+    }));
+    expect(getByText('0/0')).toBeInTheDocument();
+    expect(getByTestId('progress-bar-indicator')).toHaveAttribute('style', 'width: 100%;');
+  });
+});

package/dist/esm/progress-bar/style.scss

@@ -0,0 +1,42 @@
+/**
+ * Progress Bar
+ */
+
+@use "../../../shared/scss/colors";
+@use "~@wordpress/base-styles/colors" as wp-colors;
+
+.newspack-progress-bar {
+	margin: 32px 0;
+
+	& &__headings {
+		align-items: center;
+		display: flex;
+		justify-content: space-between;
+		margin-bottom: 8px;
+
+		h2,
+		p {
+			margin-bottom: 0;
+			margin-top: 0;
+		}
+
+		p {
+			margin-left: auto;
+		}
+	}
+
+	&__container {
+		background-color: wp-colors.$gray-100;
+		border-radius: 4px;
+		height: 8px;
+		overflow: hidden;
+		position: relative;
+		z-index: 1;
+	}
+
+	&__bar {
+		background-color: colors.$primary-500;
+		height: 8px;
+		transition: width 125ms ease-in-out;
+	}
+}

package/dist/esm/proxied-imports/router.js

@@ -0,0 +1,8 @@
+/**
+ * A proxy for react-router-dom.
+ * Ensures that both components and the plugin use the same instance of
+ * React Router, even if there are node_modules in components.
+ */
+
+import * as ReactRouterDOM from 'react-router-dom';
+export default ReactRouterDOM;

package/dist/esm/radio-control/index.js

@@ -0,0 +1,37 @@
+/**
+ * WordPress dependencies.
+ */
+import { RadioControl as BaseComponent } from '@wordpress/components';
+import { Component } from '@wordpress/element';
+
+/**
+ * Internal dependencies.
+ */
+import './style.scss';
+
+/**
+ * External dependencies.
+ */
+import classnames from 'classnames';
+
+/**
+ * Radio Control.
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
+class RadioControl extends Component {
+  /**
+   * Render.
+   */
+  render() {
+    const {
+      className,
+      ...otherProps
+    } = this.props;
+    const classes = classnames('newspack-radio-control', className);
+    return /*#__PURE__*/_jsx(BaseComponent, {
+      className: classes,
+      ...otherProps
+    });
+  }
+}
+export default RadioControl;

package/dist/esm/radio-control/style.scss

@@ -0,0 +1,92 @@
+/**
+ * Radio Control
+ */
+
+@use "../../../shared/scss/colors";
+@use "~@wordpress/base-styles/colors" as wp-colors;
+
+.newspack-radio-control {
+	color: wp-colors.$gray-700;
+	font-size: 14px;
+	line-height: 24px;
+	margin: 32px 0;
+
+	label {
+		color: inherit;
+		font-size: 14px;
+		line-height: 24px;
+		margin: 0;
+	}
+
+	.components-base-control__label {
+		color: wp-colors.$gray-900;
+		font-weight: bold;
+	}
+
+	// Options
+
+	.components-radio-control__option {
+		align-items: center;
+		display: flex;
+		margin: 0 0 8px;
+
+		&:first-of-type {
+			margin-top: 8px;
+		}
+
+		&:last-child {
+			margin-bottom: 0;
+		}
+	}
+
+	// Radio
+
+	input[type="radio"] {
+		height: 24px;
+		margin-right: 8px;
+		width: 24px;
+
+		@media screen and ( min-width: 782px ) {
+			height: 20px;
+			width: 20px;
+		}
+
+		&:checked {
+			background-color: colors.$primary-500;
+			border-color: colors.$primary-500;
+
+			&::before {
+				border: none;
+			}
+		}
+
+		&:focus {
+			border-color: colors.$primary-500;
+			box-shadow: 0 0 0 2px white, 0 0 0 3.5px colors.$primary-500;
+		}
+	}
+
+	// Multiple Radio Controls
+
+	& + & {
+		margin-bottom: 32px;
+		margin-top: -16px;
+	}
+
+	// Multiple Controls
+
+	+ .newspack-select-control,
+	+ .newspack-text-control {
+		margin-bottom: 32px;
+		margin-top: -16px;
+	}
+
+	// Reset
+
+	.components-base-control__field,
+	.components-base-control__label,
+	.components-base-control__help {
+		display: block;
+		margin: 0;
+	}
+}

package/dist/esm/section-header/index.js

@@ -0,0 +1,67 @@
+/**
+ * Section Header
+ */
+
+/**
+ * WordPress dependencies
+ */
+import { useEffect, useRef } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import { Grid } from '..';
+import './style.scss';
+
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const SectionHeader = ({
+  centered = false,
+  className = null,
+  description = '',
+  heading = 2,
+  isWhite = false,
+  noMargin = false,
+  title,
+  id = null
+}) => {
+  // If id is in the URL as a scrollTo param, scroll to it on render.
+  const ref = useRef();
+  useEffect(() => {
+    const params = new Proxy(new URLSearchParams(window.location.search), {
+      get: (searchParams, prop) => searchParams.get(prop)
+    });
+    const scrollToId = params.scrollTo;
+    if (scrollToId && scrollToId === id) {
+      // Let parent scroll action run before running this.
+      window.setTimeout(() => ref.current.scrollIntoView({
+        behavior: 'smooth'
+      }), 250);
+    }
+  }, []);
+  const classes = classnames('newspack-section-header', centered && 'newspack-section-header--is-centered', isWhite && 'newspack-section-header--is-white', noMargin && 'newspack-section-header--no-margin', className);
+  const HeadingTag = `h${heading}`;
+  return /*#__PURE__*/_jsx("div", {
+    id: id,
+    className: "newspack-section-header__container",
+    ref: ref,
+    children: /*#__PURE__*/_jsxs(Grid, {
+      columns: 1,
+      gutter: 8,
+      className: classes,
+      children: [typeof title === 'string' && /*#__PURE__*/_jsx(HeadingTag, {
+        children: title
+      }), typeof title === 'function' && /*#__PURE__*/_jsx(HeadingTag, {
+        children: title()
+      }), description && typeof description === 'string' && /*#__PURE__*/_jsx("p", {
+        children: description
+      }), typeof description === 'function' && /*#__PURE__*/_jsx("p", {
+        children: description()
+      })]
+    })
+  });
+};
+export default SectionHeader;

package/dist/esm/section-header/style.scss

@@ -0,0 +1,45 @@
+/**
+ * Section Header
+ */
+
+@use "~@wordpress/base-styles/colors" as wp-colors;
+
+.newspack-section-header {
+	margin: 64px 0 32px;
+
+	&__container:not(:first-child) {
+		margin-top: 48px;
+	}
+
+	&--no-margin,
+	h1,
+	h2,
+	h3,
+	h4,
+	h5,
+	h6 {
+		margin: 0 !important;
+	}
+
+	&--is-centered {
+		text-align: center;
+	}
+
+	&:not( #{&}--no-margin ) + *:not( #{&} ) {
+		margin-top: -16px !important;
+	}
+
+	&#{&}--is-white {
+		> * {
+			color: white;
+		}
+	}
+
+	p {
+		color: wp-colors.$gray-700;
+	}
+
+	.newspack-wizard__content &:first-child {
+		margin-top: 32px;
+	}
+}

package/dist/esm/select-control/ButtonGroupControl.js

@@ -0,0 +1,53 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
+/**
+ * WordPress dependencies
+ */
+import { Icon } from '@wordpress/icons';
+import { BaseControl, Button, ButtonGroup } from '@wordpress/components';
+
+/**
+ * Internal dependencies
+ */
+import { hooks } from '..';
+import { jsx as _jsx } from "react/jsx-runtime";
+const ButtonGroupControl = ({
+  buttonOptions,
+  buttonSmall,
+  className,
+  hideLabelFromVision,
+  label,
+  onChange,
+  value
+}) => {
+  const id = hooks.useUniqueId('button-group');
+  return /*#__PURE__*/_jsx(BaseControl, {
+    label: label,
+    hideLabelFromVision: hideLabelFromVision,
+    id: id.current,
+    className: classnames(className, 'components-select-control'),
+    children: /*#__PURE__*/_jsx(ButtonGroup, {
+      children: buttonOptions.map(option => {
+        const isSelected = value === option.value;
+        let Label = () => option.label;
+        if (option.icon) {
+          // eslint-disable-next-line react/display-name
+          Label = () => /*#__PURE__*/_jsx(Icon, {
+            icon: option.icon
+          });
+        }
+        return /*#__PURE__*/_jsx(Button, {
+          variant: isSelected ? 'primary' : null,
+          isPressed: isSelected,
+          onClick: () => onChange(option.value),
+          isSmall: buttonSmall,
+          children: /*#__PURE__*/_jsx(Label, {})
+        }, option.value);
+      })
+    })
+  });
+};
+export default ButtonGroupControl;