@instructure/canvas-rce 5.14.0 → 5.14.2

package/es/rce/plugins/shared/CanvasContentTray.js

@@ -15,6 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License along
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
+
 import React, { useCallback, useEffect, useRef, useState } from 'react';
 import { bool, element, func, instanceOf, oneOfType, shape, string } from 'prop-types';
 import { Tray } from '@instructure/ui-tray';
@@ -33,6 +34,7 @@ import { getLinkContentFromEditor } from './ContentSelection';
 import { LinkDisplay } from './LinkDisplay';
 import { showFlashAlert } from '../../../common/FlashAlert';
 import { FILTER_SETTINGS_BY_PLUGIN, DynamicPanel, isLoading } from './canvasContentUtils';
+
 /**
  * Returns the translated tray label
  * @param {string} contentType - The type of content showing on tray
@@ -40,55 +42,48 @@ import { FILTER_SETTINGS_BY_PLUGIN, DynamicPanel, isLoading } from './canvasCont
  * @param {string} contextType - The user's context
  * @returns {string}
  */
-
 function getTrayLabel(contentType, contentSubtype, contextType) {
   if (contentType === 'links' && contextType === 'course') {
     return formatMessage('Course Links');
   } else if (contentType === 'links' && contextType === 'group') {
     return formatMessage('Group Links');
   }
-
   switch (contentSubtype) {
     case ICON_MAKER_ICONS:
       return formatMessage('Icon Maker Icons');
-
     case 'images':
       if (contentType === 'course_files') return formatMessage('Course Images');
       if (contentType === 'group_files') return formatMessage('Group Images');
       return formatMessage('User Images');
-
     case 'media':
       if (contentType === 'course_files') return formatMessage('Course Media');
       if (contentType === 'group_files') return formatMessage('Group Media');
       return formatMessage('User Media');
-
     case 'documents':
       if (contentType === 'course_files') return formatMessage('Course Documents');
       if (contentType === 'group_files') return formatMessage('Group Documents');
       return formatMessage('User Documents');
-
     default:
       return formatMessage('Tray');
     // Shouldn't ever get here
   }
 }
+
 /**
  * This component is used within various plugins to handle loading in content
  * from Canvas.  It is essentially the main component.
  */
-
-
 export default function CanvasContentTray(props) {
   // should the tray be rendered open?
-  const [isOpen, setIsOpen] = useState(false); // has the tray fully opened. we use this to defer rendering the content
+  const [isOpen, setIsOpen] = useState(false);
+  // has the tray fully opened. we use this to defer rendering the content
   // until the tray is open.
-
-  const [hasOpened, setHasOpened] = useState(false); // should we close the tray after the user clicks on something in it?
-
+  const [hasOpened, setHasOpened] = useState(false);
+  // should we close the tray after the user clicks on something in it?
   const [hidingTrayOnAction, setHidingTrayOnAction] = useState(true);
   const trayRef = useRef(null);
   const scrollingAreaRef = useRef(null);
-  const closeButtonRef = useRef(null);
+  const [closeButtonRef, setCloseButtonRef] = useState(null);
   const [filterSettings, setFilterSettings] = useFilterSettings();
   const [isEditTray, setIsEditTray] = useState(false);
   const [link, setLink] = useState(null);
@@ -100,30 +95,34 @@ export default function CanvasContentTray(props) {
     mountNode,
     onTrayClosing,
     storeProps
-  } = { ...props
+  } = {
+    ...props
   };
   const handleDismissTray = useCallback(() => {
     // return focus to the RCE if focus was on this tray
     if (trayRef.current && trayRef.current.contains(document.activeElement)) {
       bridge.focusActiveEditor(false);
     }
-
     onTrayClosing && onTrayClosing(CanvasContentTray.globalOpenCount); // tell RCEWrapper we're closing if we're open
-
     setIsOpen(false);
   }, [bridge, onTrayClosing]);
+
+  // this shouldn't be necessary, but INSTUI isn't focusing the close button
+  // like it should.
+  useEffect(() => {
+    if (isOpen && closeButtonRef) {
+      closeButtonRef.focus();
+    }
+  }, [closeButtonRef, isOpen]);
   useEffect(() => {
     const controller = {
       showTrayForPlugin(plugin) {
-        var _closeButtonRef$curre;
-
         // increment a counter that's used as the key when rendering
         // this gets us a new instance everytime, which is necessary
         // to get the queries run so we have up to date data.
         ++CanvasContentTray.globalOpenCount;
         setFilterSettings(FILTER_SETTINGS_BY_PLUGIN[plugin]);
         setIsOpen(true);
-
         if (plugin === 'course_link_edit') {
           setIsEditTray(true);
           const {
@@ -144,21 +143,18 @@ export default function CanvasContentTray(props) {
         } else {
           setIsEditTray(false);
         }
-
-        (_closeButtonRef$curre = closeButtonRef.current) === null || _closeButtonRef$curre === void 0 ? void 0 : _closeButtonRef$curre.focus();
       },
-
       hideTray(forceClose) {
         if (forceClose || hidingTrayOnAction) {
           handleDismissTray();
         }
       }
-
     };
     bridge.attachController(controller, editor.id);
     return () => {
       bridge.detachController(editor.id);
-    }; // it's OK the setFilterSettings is not a dependency
+    };
+    // it's OK the setFilterSettings is not a dependency
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [editor.id, bridge, handleDismissTray, hidingTrayOnAction]);
   useEffect(() => {
@@ -168,19 +164,16 @@ export default function CanvasContentTray(props) {
   }, [hasOpened]);
   useEffect(() => {
     var _trayRef$current;
-
     if (!hasOpened) return;
     let c = document.querySelector('[role="main"]');
     let target_w = 0;
     if (!c) return;
     const margin = window.getComputedStyle(c).direction === 'ltr' ? document.body.getBoundingClientRect().right - c.getBoundingClientRect().right : c.getBoundingClientRect().left;
     target_w = c.offsetWidth - ((_trayRef$current = trayRef.current) === null || _trayRef$current === void 0 ? void 0 : _trayRef$current.offsetWidth) + margin;
-
     if (target_w >= 320 && target_w < c.offsetWidth) {
       c.style.boxSizing = 'border-box';
       c.style.width = `${target_w}px`;
     }
-
     setHidingTrayOnAction(target_w < 320);
     return () => {
       c = document.querySelector('[role="main"]');
@@ -188,16 +181,13 @@ export default function CanvasContentTray(props) {
       c.style.width = '';
     };
   }, [hasOpened]);
-
   function handleOpenTray() {
     bridge.focusEditor(editor);
     setHasOpened(true);
   }
-
   function handleExitTray() {
     onTrayClosing && onTrayClosing(true); // tell RCEWrapper we're closing
   }
-
   function handleCloseTray() {
     // clear the store's saved search string so the tray doesn't
     // reopen with a previous tray instance's search results
@@ -205,10 +195,10 @@ export default function CanvasContentTray(props) {
     setHasOpened(false);
     onTrayClosing && onTrayClosing(false); // tell RCEWrapper we're closed
   }
-
   function handleReplaceButton() {
     handleDismissTray();
-    const newLink = { ...link,
+    const newLink = {
+      ...link,
       forceRename: true,
       text: linkText
     };
@@ -219,7 +209,6 @@ export default function CanvasContentTray(props) {
       srOnly: true
     });
   }
-
   function renderFooter() {
     return /*#__PURE__*/React.createElement(Flex.Item, {
       background: "secondary",
@@ -236,11 +225,10 @@ export default function CanvasContentTray(props) {
       "data-testid": "replace-link-button"
     }, formatMessage('Replace')));
   }
-
   function handleFilterChange(newFilter, onChangeContext, onChangeSearchString, onChangeSortBy) {
-    const newFilterSettings = { ...newFilter
+    const newFilterSettings = {
+      ...newFilter
     };
-
     if (newFilterSettings.sortValue) {
       newFilterSettings.sortDir = newFilterSettings.sortValue === 'alphabetical' ? 'asc' : 'desc';
       onChangeSortBy({
@@ -248,48 +236,48 @@ export default function CanvasContentTray(props) {
         dir: newFilterSettings.sortDir
       });
     }
-
     if ('searchString' in newFilterSettings && filterSettings.searchString !== newFilterSettings.searchString) {
       onChangeSearchString(newFilterSettings.searchString);
     }
-
     setFilterSettings(newFilterSettings);
-
     if (newFilterSettings.contentType) {
       let contextType, contextId;
-
       switch (newFilterSettings.contentType) {
         case 'user_files':
           contextType = 'user';
           contextId = props.containingContext.userId;
           break;
-
         case 'group_files':
           contextType = 'group';
           contextId = props.containingContext.contextId;
           break;
-
         case 'course_files':
           contextType = props.contextType;
           contextId = props.containingContext.contextId;
           break;
-
         case 'links':
           contextType = props.containingContext.contextType;
           contextId = props.containingContext.contextId;
       }
-
       onChangeContext({
         contextType,
         contextId
       });
     }
   }
-
   function getHeader() {
     return isEditTray ? formatMessage('Edit Course Link') : formatMessage('Add');
   }
-
+  function renderLinkDisplay() {
+    return isEditTray && /*#__PURE__*/React.createElement(LinkDisplay, {
+      linkText: linkText,
+      placeholderText: (link === null || link === void 0 ? void 0 : link.title) || placeholderText,
+      linkFileName: (link === null || link === void 0 ? void 0 : link.title) || '',
+      published: (link === null || link === void 0 ? void 0 : link.published) || false,
+      handleTextChange: setLinkText,
+      linkType: link === null || link === void 0 ? void 0 : link.type
+    });
+  }
   return /*#__PURE__*/React.createElement(Tray, {
     "data-mce-component": true,
     "data-testid": "CanvasContentTray",
@@ -306,7 +294,7 @@ export default function CanvasContentTray(props) {
     onExit: handleExitTray,
     onOpen: handleOpenTray,
     contentRef: el => trayRef.current = el
-  }, isOpen && hasOpened ? /*#__PURE__*/React.createElement(Flex, {
+  }, /*#__PURE__*/React.createElement(Flex, {
     direction: "column",
     as: "div",
     height: getTrayHeight(),
@@ -327,15 +315,8 @@ export default function CanvasContentTray(props) {
     onClick: handleDismissTray,
     "data-testid": "CloseButton_ContentTray",
     screenReaderLabel: formatMessage('Close'),
-    elementRef: el => closeButtonRef.current = el
-  })), isEditTray && /*#__PURE__*/React.createElement(LinkDisplay, {
-    linkText: linkText,
-    placeholderText: (link === null || link === void 0 ? void 0 : link.title) || placeholderText,
-    linkFileName: (link === null || link === void 0 ? void 0 : link.title) || '',
-    published: (link === null || link === void 0 ? void 0 : link.published) || false,
-    handleTextChange: setLinkText,
-    linkType: link === null || link === void 0 ? void 0 : link.type
-  }), /*#__PURE__*/React.createElement(Filter, Object.assign({}, filterSettings, {
+    elementRef: el => setCloseButtonRef(el)
+  })), renderLinkDisplay(), /*#__PURE__*/React.createElement(Filter, Object.assign({}, filterSettings, {
     mountNode: props.mountNode,
     userContextType: props.contextType,
     containingContextType: props.containingContext.contextType,
@@ -344,7 +325,7 @@ export default function CanvasContentTray(props) {
     },
     isContentLoading: isLoading(storeProps),
     use_rce_icon_maker: props.use_rce_icon_maker
-  }))), /*#__PURE__*/React.createElement(Flex.Item, {
+  }))), isOpen && hasOpened ? /*#__PURE__*/React.createElement(Flex.Item, {
     shouldGrow: true,
     shouldShrink: true,
     margin: "xx-small xxx-small 0",
@@ -372,17 +353,16 @@ export default function CanvasContentTray(props) {
     editing: isEditTray,
     onEditClick: setLink,
     selectedLink: link
-  }, storeProps)))), isEditTray && renderFooter()))) : null);
+  }, storeProps)))), isEditTray && renderFooter())) : null));
 }
 CanvasContentTray.globalOpenCount = 0;
-
 function requiredWithoutSource(props, propName, componentName) {
   if (props.source == null && props[propName] == null) {
     throw new Error(`The prop \`${propName}\` is marked as required in \`${componentName}\`, but its value is \`${props[propName]}\`.`);
   }
-} // Changes made here may need to be reflected in the trayProps type in CanvasContentPanel
-
+}
 
+// Changes made here may need to be reflected in the trayProps type in CanvasContentPanel
 const trayPropsMap = {
   canUploadFiles: bool.isRequired,
   contextId: string.isRequired,
@@ -414,10 +394,10 @@ CanvasContentTray.propTypes = {
   // called with true when the tray starts closing, false once closed
   onEditClick: func,
   ...trayPropsMap
-}; // the way we define trayProps, eslint doesn't recognize the following as props
+};
 
+// the way we define trayProps, eslint doesn't recognize the following as props
 /* eslint-disable react/default-props-match-prop-types */
-
 CanvasContentTray.defaultProps = {
   canUploadFiles: false,
   filesTabDisabled: false,

package/es/rce/plugins/shared/CheckerboardStyling.js

@@ -15,11 +15,11 @@
  * You should have received a copy of the GNU Affero General Public License along
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
+
 const checkerboardStyle = squareSize => {
   return {
     backgroundImage: `url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" width="400" height="400" fill-opacity=".15"><rect x="200" width="200" height="200"/><rect y="200" width="200" height="200"/></svg>')`,
     backgroundSize: `${squareSize}px ${squareSize}px`
   };
 };
-
 export default checkerboardStyle;

package/es/rce/plugins/shared/ColorInput.js

@@ -15,6 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License along
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
+
 import React, { useEffect, useState } from 'react';
 import { View } from '@instructure/ui-view';
 import { Flex } from '@instructure/ui-flex';
@@ -85,7 +86,6 @@ const NAMED_COLORS = [{
 }, null];
 export const ColorInput = _ref => {
   var _NAMED_COLORS$find;
-
   let {
     color,
     label,
@@ -101,27 +101,25 @@ export const ColorInput = _ref => {
   const colorName = (_NAMED_COLORS$find = NAMED_COLORS.find(c => (c === null || c === void 0 ? void 0 : c.color) === color)) === null || _NAMED_COLORS$find === void 0 ? void 0 : _NAMED_COLORS$find.name;
   useEffect(() => {
     setInputValue(color);
-  }, [color]); // fire onChange in case value is valid
+  }, [color]);
 
+  // fire onChange in case value is valid
   const handleColorChange = hex => {
     if (isValidHex(hex)) {
       onChange(hex);
     }
-
     if (!hex || !hex.length) {
       onChange(null);
     }
-
     setInputValue(hex);
-  }; // reset the input value on blur if invalid
-
+  };
 
+  // reset the input value on blur if invalid
   const handleInputBlur = () => {
     if (!inputValue || inputValue.length > 0 && !isValidHex(inputValue)) {
       setInputValue(color);
     }
   };
-
   const colorPreviews = NAMED_COLORS.map(c => /*#__PURE__*/React.createElement(ColorPreview, {
     key: `${name}-${c === null || c === void 0 ? void 0 : c.color}`,
     color: c === null || c === void 0 ? void 0 : c.color,
@@ -132,7 +130,6 @@ export const ColorInput = _ref => {
       setIsOpen(false);
     }
   }));
-
   function renderPopover() {
     const pickerLabel = colorName ? formatMessage('Color Picker ({colorName} selected)', {
       colorName
@@ -167,7 +164,6 @@ export const ColorInput = _ref => {
       "data-testid": `${name}-popover`
     }, requireColor ? colorPreviews.slice(0, -1) : colorPreviews));
   }
-
   return /*#__PURE__*/React.createElement(View, {
     as: "div"
   }, /*#__PURE__*/React.createElement(TextInput, {
@@ -190,7 +186,6 @@ export const ColorInput = _ref => {
     interaction: readonly ? 'readonly' : undefined
   }));
 };
-
 function ColorPreview(_ref2) {
   let {
     color,
@@ -216,17 +211,13 @@ function ColorPreview(_ref2) {
     testId: `colorPreview-${color || 'none'}`
   }));
 }
-
 function isValidHex(color) {
   if (!color) return false;
-
   switch (color.length) {
     case 4:
       return /^#[0-9A-F]{3}$/i.test(color);
-
     case 7:
       return /^#[0-9A-F]{6}$/i.test(color);
-
     default:
       return false;
   }

package/es/rce/plugins/shared/ConditionalTooltip.js

@@ -15,6 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License along
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
+
 import React from 'react';
 import { bool, element, oneOfType, arrayOf } from 'prop-types';
 import { Tooltip } from '@instructure/ui-tooltip';