@instructure/ui-view 11.7.3-snapshot-7 → 11.7.3-snapshot-26

package/es/View/v2/index.js

@@ -1,6 +1,4 @@
-import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
-const _excluded = ["children", "textAlign", "background", "display", "withVisualDebug", "width", "height", "minWidth", "minHeight", "maxWidth", "maxHeight", "overflowX", "overflowY", "stacking", "shadow", "position", "focusPosition", "focusColor", "shouldAnimateFocus", "borderColor", "className", "overscrollBehavior", "styles", "makeStyles"];
-var _dec, _dec2, _class, _View;
+var _dec, _dec2, _class;
 /*
  * The MIT License (MIT)
  *
@@ -40,42 +38,73 @@ category: components
 ---
 @module View
 **/
-let View = (_dec = textDirectionContextConsumer(), _dec2 = withStyle(generateStyle), _dec(_class = _dec2(_class = (_View = class View extends Component {
+let View = (_dec = textDirectionContextConsumer(), _dec2 = withStyle(generateStyle), _dec(_class = _dec2(_class = class View extends Component {
+  static displayName = "View";
+  static componentId = 'View';
+  static allowedProps = allowedProps;
+  static defaultProps = {
+    display: 'auto',
+    overflowX: 'visible',
+    overflowY: 'visible',
+    withVisualDebug: false,
+    borderColor: 'primary',
+    position: 'static',
+    focusPosition: 'offset',
+    focusColor: 'info',
+    shouldAnimateFocus: true,
+    overscrollBehavior: 'auto'
+  };
+
+  // TODO: Remove this code once all components are using passthroughProps in place
+  // of omitProps and have removed this function
+
+  // omitViewProps needs to be called on the composed View component so that the
+  // View.allowedProps in the method matches the View.allowedProps that will be called in
+  // the consumers. Otherwise the discrepancy could cause unexpected props being
+  // allowed through.
+
+  // Removes View's own props from the given object. Automatically excludes the
+  // following props: 'theme', 'children', 'className', 'style', 'styles',
+  // 'makeStyles', 'themeOverride'
+  // @param props the object to process
+  // @param Component The component whose props are processed.
+  // Only needed for debug logging in non-production builds.
+  static omitViewProps = (props, Component) => {
+    // We don't want the theming and styling props to pass
+    // (these are added and handled by the `@withStyle` decorator)
+    const propsToOmit = [...View.allowedProps, 'styles', 'makeStyles', 'themeOverride'];
+    if (typeof process !== 'undefined' && (process?.env?.GITHUB_PULL_REQUEST_PREVIEW === 'true' || process?.env?.NODE_ENV !== 'production')) {
+      Object.keys(pickProps(props, propsToOmit)).forEach(prop => {
+        error(false, `[${Component.name}] prop '${prop}' is not allowed.`);
+      });
+    }
+    return omitProps(props, propsToOmit);
+  };
+  spanMarginVerified;
   get _element() {
     return this.ref;
   }
   constructor(props) {
     super(props);
-    this.spanMarginVerified = void 0;
-    this.ref = null;
-    this.handleElementRef = el => {
-      if (typeof this.props.elementRef === 'function') {
-        this.props.elementRef(el);
-      }
-      this.ref = el;
-    };
     this.spanMarginVerified = false;
   }
   componentDidMount() {
-    var _this$props$makeStyle, _this$props;
-    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
+    this.props.makeStyles?.();
   }
   componentDidUpdate() {
-    var _this$props$makeStyle2, _this$props2, _process, _process$env;
-    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2);
+    this.props.makeStyles?.();
 
     // Not calling getCSSStyleDeclaration can save hundreds of ms in tests and production
-    if (typeof process !== 'undefined' && ((_process = process) === null || _process === void 0 ? void 0 : (_process$env = _process.env) === null || _process$env === void 0 ? void 0 : _process$env.NODE_ENV) === 'development' && !this.spanMarginVerified) {
+    if (typeof process !== 'undefined' && process?.env?.NODE_ENV === 'development' && !this.spanMarginVerified) {
       // We have to verify margins in the first 'componentDidUpdate',
       // because that is when all styles are calculated,
       // but we only want to check once, using a flag
       this.spanMarginVerified = true;
       error(!function verifySpanMargin(element, margin) {
-        var _getCSSStyleDeclarati;
         if (!element) {
           return;
         }
-        const display = (_getCSSStyleDeclarati = getCSSStyleDeclaration(element)) === null || _getCSSStyleDeclarati === void 0 ? void 0 : _getCSSStyleDeclarati.display;
+        const display = getCSSStyleDeclaration(element)?.display;
         if (display !== 'inline') {
           return;
         }
@@ -95,64 +124,50 @@ let View = (_dec = textDirectionContextConsumer(), _dec2 = withStyle(generateSty
       }(this.ref, this.props.margin), `[View] display style is set to 'inline' and will allow for horizontal margins only.`);
     }
   }
+  ref = null;
+  handleElementRef = el => {
+    if (typeof this.props.elementRef === 'function') {
+      this.props.elementRef(el);
+    }
+    this.ref = el;
+  };
   render() {
-    const _this$props3 = this.props,
-      children = _this$props3.children,
-      textAlign = _this$props3.textAlign,
-      background = _this$props3.background,
-      display = _this$props3.display,
-      withVisualDebug = _this$props3.withVisualDebug,
-      width = _this$props3.width,
-      height = _this$props3.height,
-      minWidth = _this$props3.minWidth,
-      minHeight = _this$props3.minHeight,
-      maxWidth = _this$props3.maxWidth,
-      maxHeight = _this$props3.maxHeight,
-      overflowX = _this$props3.overflowX,
-      overflowY = _this$props3.overflowY,
-      stacking = _this$props3.stacking,
-      shadow = _this$props3.shadow,
-      position = _this$props3.position,
-      focusPosition = _this$props3.focusPosition,
-      focusColor = _this$props3.focusColor,
-      shouldAnimateFocus = _this$props3.shouldAnimateFocus,
-      borderColor = _this$props3.borderColor,
-      className = _this$props3.className,
-      overscrollBehavior = _this$props3.overscrollBehavior,
-      styles = _this$props3.styles,
-      makeStyles = _this$props3.makeStyles,
-      props = _objectWithoutProperties(_this$props3, _excluded);
+    const {
+      children,
+      textAlign,
+      background,
+      display,
+      withVisualDebug,
+      width,
+      height,
+      minWidth,
+      minHeight,
+      maxWidth,
+      maxHeight,
+      overflowX,
+      overflowY,
+      stacking,
+      shadow,
+      position,
+      focusPosition,
+      focusColor,
+      shouldAnimateFocus,
+      borderColor,
+      className,
+      overscrollBehavior,
+      styles,
+      makeStyles,
+      ...props
+    } = this.props;
     const ElementType = getElementType(View, this.props);
     return _jsx(ElementType, {
       ...passthroughProps(props),
       className: className,
-      css: [styles === null || styles === void 0 ? void 0 : styles.view, styles === null || styles === void 0 ? void 0 : styles.inlineStyles],
+      css: [styles?.view, styles?.inlineStyles],
       ref: this.handleElementRef,
       children: children
     });
   }
-}, _View.displayName = "View", _View.componentId = 'View', _View.allowedProps = allowedProps, _View.defaultProps = {
-  display: 'auto',
-  overflowX: 'visible',
-  overflowY: 'visible',
-  withVisualDebug: false,
-  borderColor: 'primary',
-  position: 'static',
-  focusPosition: 'offset',
-  focusColor: 'info',
-  shouldAnimateFocus: true,
-  overscrollBehavior: 'auto'
-}, _View.omitViewProps = (props, Component) => {
-  var _process2, _process2$env, _process3, _process3$env;
-  // We don't want the theming and styling props to pass
-  // (these are added and handled by the `@withStyle` decorator)
-  const propsToOmit = [..._View.allowedProps, 'styles', 'makeStyles', 'themeOverride'];
-  if (typeof process !== 'undefined' && (((_process2 = process) === null || _process2 === void 0 ? void 0 : (_process2$env = _process2.env) === null || _process2$env === void 0 ? void 0 : _process2$env.GITHUB_PULL_REQUEST_PREVIEW) === 'true' || ((_process3 = process) === null || _process3 === void 0 ? void 0 : (_process3$env = _process3.env) === null || _process3$env === void 0 ? void 0 : _process3$env.NODE_ENV) !== 'production')) {
-    Object.keys(pickProps(props, propsToOmit)).forEach(prop => {
-      error(false, `[${Component.name}] prop '${prop}' is not allowed.`);
-    });
-  }
-  return omitProps(props, propsToOmit);
-}, _View)) || _class) || _class);
+}) || _class) || _class);
 export default View;
 export { View };

package/es/View/v2/styles.js

@@ -146,7 +146,9 @@ const getStyleProps = ({
   return whitelisted;
 };
 const withBorder = props => {
-  const borderWidth = props.borderWidth;
+  const {
+    borderWidth
+  } = props;
   return borderWidth && borderWidth !== '0' && borderWidth !== 'none';
 };
 
@@ -157,32 +159,34 @@ const withBorder = props => {
  * @return {Object} The final style object, which will be used in the component
  */
 const generateStyle = (componentTheme, props, sharedTokens) => {
-  const borderRadius = props.borderRadius,
-    borderWidth = props.borderWidth,
-    margin = props.margin,
-    padding = props.padding,
-    position = props.position,
-    display = props.display,
-    textAlign = props.textAlign,
-    borderColor = props.borderColor,
-    background = props.background,
-    stacking = props.stacking,
-    shadow = props.shadow,
-    overflowY = props.overflowY,
-    overflowX = props.overflowX,
-    overscrollBehavior = props.overscrollBehavior,
-    insetBlockEnd = props.insetBlockEnd,
-    insetBlockStart = props.insetBlockStart,
-    insetInlineEnd = props.insetInlineEnd,
-    insetInlineStart = props.insetInlineStart,
-    width = props.width,
-    height = props.height,
-    minWidth = props.minWidth,
-    minHeight = props.minHeight,
-    maxWidth = props.maxWidth,
-    maxHeight = props.maxHeight,
-    withVisualDebug = props.withVisualDebug,
-    dir = props.dir;
+  const {
+    borderRadius,
+    borderWidth,
+    margin,
+    padding,
+    position,
+    display,
+    textAlign,
+    borderColor,
+    background,
+    stacking,
+    shadow,
+    overflowY,
+    overflowX,
+    overscrollBehavior,
+    insetBlockEnd,
+    insetBlockStart,
+    insetInlineEnd,
+    insetInlineStart,
+    width,
+    height,
+    minWidth,
+    minHeight,
+    maxWidth,
+    maxHeight,
+    withVisualDebug,
+    dir
+  } = props;
   const borderStyle = getBorderStyle({
     sharedTokens,
     borderRadius,
@@ -360,11 +364,13 @@ const generateStyle = (componentTheme, props, sharedTokens) => {
     },
     none: {}
   };
-  const focusColor = props.focusColor,
-    focusPosition = props.focusPosition,
-    shouldAnimateFocus = props.shouldAnimateFocus,
-    withFocusOutline = props.withFocusOutline,
-    focusWithin = props.focusWithin;
+  const {
+    focusColor,
+    focusPosition,
+    shouldAnimateFocus,
+    withFocusOutline,
+    focusWithin
+  } = props;
   const focusOutline = calcFocusOutlineStyles(sharedTokens.focusOutline, {
     focusColor,
     focusPosition,

package/lib/ContextView/v1/index.js

@@ -13,7 +13,7 @@ var _styles = _interopRequireDefault(require("./styles"));
 var _theme = _interopRequireDefault(require("./theme"));
 var _props = require("./props");
 var _jsxRuntime = require("@emotion/react/jsx-runtime");
-var _dec, _class, _ContextView;
+var _dec, _class;
 /*
  * The MIT License (MIT)
  *
@@ -42,49 +42,62 @@ var _dec, _class, _ContextView;
 category: components
 ---
 **/
-let ContextView = exports.ContextView = (_dec = (0, _emotion.withStyleLegacy)(_styles.default, _theme.default), _dec(_class = (_ContextView = class ContextView extends _react.Component {
-  constructor(...args) {
-    super(...args);
-    this.ref = null;
-    this.handleRef = el => {
-      const elementRef = this.props.elementRef;
-      this.ref = el;
-      if (typeof elementRef === 'function') {
-        elementRef(el);
-      }
-    };
-  }
+let ContextView = exports.ContextView = (_dec = (0, _emotion.withStyleLegacy)(_styles.default, _theme.default), _dec(_class = class ContextView extends _react.Component {
+  static displayName = "ContextView";
+  static componentId = 'ContextView';
+  static allowedProps = _props.allowedProps;
+  static defaultProps = {
+    as: 'span',
+    elementRef: () => {},
+    debug: false,
+    width: 'auto',
+    height: 'auto',
+    children: null,
+    textAlign: 'start',
+    background: 'default',
+    shadow: 'resting',
+    placement: 'center end'
+  };
   componentDidMount() {
-    var _this$props$makeStyle, _this$props;
-    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
+    this.props.makeStyles?.();
   }
   componentDidUpdate() {
-    var _this$props$makeStyle2, _this$props2;
-    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2);
+    this.props.makeStyles?.();
   }
+  ref = null;
+  handleRef = el => {
+    const {
+      elementRef
+    } = this.props;
+    this.ref = el;
+    if (typeof elementRef === 'function') {
+      elementRef(el);
+    }
+  };
   render() {
-    const _this$props3 = this.props,
-      as = _this$props3.as,
-      background = _this$props3.background,
-      children = _this$props3.children,
-      debug = _this$props3.debug,
-      height = _this$props3.height,
-      width = _this$props3.width,
-      maxHeight = _this$props3.maxHeight,
-      maxWidth = _this$props3.maxWidth,
-      minHeight = _this$props3.minHeight,
-      minWidth = _this$props3.minWidth,
-      margin = _this$props3.margin,
-      padding = _this$props3.padding,
-      shadow = _this$props3.shadow,
-      stacking = _this$props3.stacking,
-      style = _this$props3.style,
-      textAlign = _this$props3.textAlign,
-      styles = _this$props3.styles,
-      borderColor = _this$props3.borderColor;
+    const {
+      as,
+      background,
+      children,
+      debug,
+      height,
+      width,
+      maxHeight,
+      maxWidth,
+      minHeight,
+      minWidth,
+      margin,
+      padding,
+      shadow,
+      stacking,
+      style,
+      textAlign,
+      styles,
+      borderColor
+    } = this.props;
     return (0, _jsxRuntime.jsx)(_v.View, {
       ...(0, _omitProps.omitProps)(this.props, ContextView.allowedProps),
-      css: styles === null || styles === void 0 ? void 0 : styles.contextView,
+      css: styles?.contextView,
       style: style,
       borderWidth: "none",
       display: "inline-block",
@@ -94,7 +107,7 @@ let ContextView = exports.ContextView = (_dec = (0, _emotion.withStyleLegacy)(_s
       margin: margin,
       stacking: stacking,
       children: (0, _jsxRuntime.jsxs)(_v.View, {
-        css: styles === null || styles === void 0 ? void 0 : styles.contextView__content,
+        css: styles?.contextView__content,
         display: "block",
         borderRadius: "medium",
         borderWidth: "small",
@@ -111,21 +124,10 @@ let ContextView = exports.ContextView = (_dec = (0, _emotion.withStyleLegacy)(_s
         shadow: shadow,
         textAlign: textAlign,
         children: [(0, _jsxRuntime.jsx)("span", {
-          css: styles === null || styles === void 0 ? void 0 : styles.contextView__arrow
+          css: styles?.contextView__arrow
         }), children]
       })
     });
   }
-}, _ContextView.displayName = "ContextView", _ContextView.componentId = 'ContextView', _ContextView.allowedProps = _props.allowedProps, _ContextView.defaultProps = {
-  as: 'span',
-  elementRef: () => {},
-  debug: false,
-  width: 'auto',
-  height: 'auto',
-  children: null,
-  textAlign: 'start',
-  background: 'default',
-  shadow: 'resting',
-  placement: 'center end'
-}, _ContextView)) || _class);
+}) || _class);
 var _default = exports.default = ContextView;