@instructure/ui-view 11.6.0 → 11.6.1-snapshot-129

package/lib/View/v2/styles.js

@@ -0,0 +1,426 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _uiI18n = require("@instructure/ui-i18n");
+var _emotion = require("@instructure/emotion");
+var _pickProps = require("@instructure/ui-react-utils/lib/pickProps.js");
+var _uiThemes = require("@instructure/ui-themes");
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const processBorderRadiusValue = (value, sharedTokens) => {
+  if (!value) return '';
+
+  // Split by spaces to handle CSS shorthand (1-4 values)
+  const values = value.split(' ');
+  const processedValues = values.map(v => {
+    // Handle special cases
+    if (v === 'auto' || v === '0') return v;
+    if (v === 'none') return '0';
+    if (v === 'circle') return '100%';
+    if (v === 'pill') return '999em';
+
+    // Handle SharedTokens values
+    if (v === 'small') return sharedTokens.legacy.radiusSmall; // 2px in Canvas
+    if (v === 'medium') return sharedTokens.legacy.radiusMedium; // 4px in Canvas
+    if (v === 'large') return sharedTokens.legacy.radiusLarge; // 8px in Canvas
+
+    // Pass through CSS values (1rem, 12px, etc.)
+    return v;
+  });
+  return processedValues.join(' ');
+};
+const processBorderWidthValue = (value, sharedTokens) => {
+  if (!value) return '';
+
+  // Split by spaces to handle CSS shorthand (1-4 values)
+  const values = value.split(' ');
+  const processedValues = values.map(v => {
+    // Handle special cases
+    if (v === 'auto' || v === '0') return v;
+    if (v === 'none') return '0';
+
+    // Handle SharedTokens values
+    if (v === 'small') return sharedTokens.strokeWidth.sm;
+    if (v === 'medium') return sharedTokens.strokeWidth.md;
+    if (v === 'large') return sharedTokens.strokeWidth.lg;
+
+    // Pass through CSS values (1rem, 2px, etc.)
+    return v;
+  });
+  return processedValues.join(' ');
+};
+const getBorderStyle = ({
+  borderRadius,
+  borderWidth,
+  dir,
+  sharedTokens
+}) => {
+  const isRtlDirection = dir === _uiI18n.DIRECTION.rtl;
+  return {
+    borderRadius: processBorderRadiusValue(isRtlDirection ? (0, _emotion.mirrorShorthandCorners)(borderRadius) : borderRadius, sharedTokens),
+    borderWidth: processBorderWidthValue(isRtlDirection ? (0, _emotion.mirrorShorthandEdges)(borderWidth) : borderWidth, sharedTokens)
+  };
+};
+const getSpacingStyle = ({
+  margin,
+  padding,
+  dir,
+  sharedTokens
+}) => {
+  const isRtlDirection = dir === _uiI18n.DIRECTION.rtl;
+  return {
+    // TODO handle the merging on tokens inside the util
+    margin: (0, _emotion.calcSpacingFromShorthand)(isRtlDirection ? (0, _emotion.mirrorShorthandEdges)(margin) : margin, {
+      ...sharedTokens.spacing,
+      ...sharedTokens.legacy.spacing
+    }),
+    padding: (0, _emotion.calcSpacingFromShorthand)(isRtlDirection ? (0, _emotion.mirrorShorthandEdges)(padding) : padding, {
+      ...sharedTokens.spacing,
+      ...sharedTokens.legacy.spacing
+    })
+  };
+};
+const getOffsetStyle = ({
+  insetBlockStart,
+  insetBlockEnd,
+  insetInlineStart,
+  insetInlineEnd,
+  dir
+}) => {
+  const isRtlDirection = dir === _uiI18n.DIRECTION.rtl;
+  const blockStart = {
+    top: insetBlockStart,
+    insetBlockStart
+  };
+  const blockEnd = {
+    bottom: insetBlockEnd,
+    insetBlockEnd
+  };
+  const horizontalOffsets = {
+    left: isRtlDirection ? insetInlineEnd : insetInlineStart,
+    right: isRtlDirection ? insetInlineStart : insetInlineEnd
+  };
+  return {
+    ...blockStart,
+    ...blockEnd,
+    ...horizontalOffsets
+  };
+};
+const getStyleProps = ({
+  cursor,
+  style
+}) => {
+  const whitelisted = (0, _pickProps.pickProps)(style || {}, {}, [
+  // Position/calculateElementPosition:
+  'top', 'left', 'position', 'display', 'transform', 'overflow', 'minWidth', 'minHeight',
+  // Img:
+  'filter',
+  // Flex.Item:
+  'flexBasis',
+  // Avatar:
+  'backgroundImage',
+  // Popover:
+  'pointerEvents']);
+  if (cursor) {
+    whitelisted.cursor = cursor;
+  }
+  return whitelisted;
+};
+const withBorder = props => {
+  const borderWidth = props.borderWidth;
+  return borderWidth && borderWidth !== '0' && borderWidth !== 'none';
+};
+
+/**
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @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 borderStyle = getBorderStyle({
+    sharedTokens,
+    borderRadius,
+    borderWidth,
+    dir
+  });
+  const spacingStyle = getSpacingStyle({
+    margin,
+    padding,
+    sharedTokens,
+    dir
+  });
+  const offsetStyle = getOffsetStyle({
+    dir,
+    insetBlockEnd,
+    insetBlockStart,
+    insetInlineEnd,
+    insetInlineStart
+  });
+  const displayVariants = {
+    inline: {
+      label: 'view--inline',
+      display: 'inline'
+    },
+    block: {
+      label: 'view--block',
+      display: 'block'
+    },
+    'inline-block': {
+      label: 'view--inlineBlock',
+      display: 'inline-block',
+      verticalAlign: 'middle'
+    },
+    flex: {
+      label: 'view--flex',
+      display: 'flex'
+    },
+    'inline-flex': {
+      label: 'view--inlineFlex',
+      display: 'inline-flex',
+      verticalAlign: 'middle'
+    },
+    contents: {
+      label: 'view--contents',
+      display: 'contents'
+    },
+    inherit: {
+      label: 'view--inherit',
+      display: 'inherit'
+    },
+    initial: {
+      label: 'view--initial',
+      display: 'initial'
+    },
+    revert: {
+      label: 'view--revert',
+      display: 'revert'
+    },
+    'revert-layer': {
+      label: 'view--revertLayer',
+      display: 'revert-layer'
+    },
+    unset: {
+      label: 'view--unset',
+      display: 'unset'
+    },
+    auto: {}
+  };
+  const textAlignVariants = {
+    start: {
+      textAlign: 'start'
+    },
+    center: {
+      textAlign: 'center'
+    },
+    end: {
+      textAlign: 'end'
+    }
+  };
+  const borderColorVariants = {
+    transparent: {
+      borderColor: componentTheme.borderColorTransparent
+    },
+    primary: {
+      borderColor: componentTheme.borderColorPrimary
+    },
+    secondary: {
+      borderColor: componentTheme.borderColorSecondary
+    },
+    brand: {
+      borderColor: componentTheme.borderColorBrand
+    },
+    info: {
+      borderColor: componentTheme.borderColorInfo
+    },
+    success: {
+      borderColor: componentTheme.borderColorSuccess
+    },
+    warning: {
+      borderColor: componentTheme.borderColorWarning
+    },
+    alert: {
+      borderColor: componentTheme.borderColorAlert
+    },
+    danger: {
+      borderColor: componentTheme.borderColorDanger
+    }
+  };
+  const backgroundColorVariants = {
+    transparent: {
+      color: componentTheme.color,
+      background: 'none'
+    },
+    primary: {
+      color: componentTheme.color,
+      background: componentTheme.backgroundPrimary
+    },
+    secondary: {
+      color: componentTheme.color,
+      background: componentTheme.backgroundSecondary
+    },
+    ['primary-inverse']: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundPrimaryInverse
+    },
+    brand: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundBrand
+    },
+    info: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundInfo
+    },
+    alert: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundAlert
+    },
+    success: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundSuccess
+    },
+    danger: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundDanger
+    },
+    warning: {
+      color: componentTheme.colorPrimaryInverse,
+      background: componentTheme.backgroundWarning
+    }
+  };
+  const stackingVariants = {
+    topmost: {
+      zIndex: componentTheme.stackingTopmost
+    },
+    above: {
+      zIndex: componentTheme.stackingAbove
+    },
+    resting: {},
+    below: {
+      zIndex: componentTheme.stackingBelow
+    },
+    deepest: {
+      zIndex: componentTheme.stackingDeepest
+    }
+  };
+  const shadowVariants = {
+    topmost: {
+      boxShadow: (0, _uiThemes.boxShadowObjectsToCSSString)(sharedTokens.boxShadow.elevation4)
+    },
+    resting: {
+      boxShadow: (0, _uiThemes.boxShadowObjectsToCSSString)(sharedTokens.boxShadow.elevation1)
+    },
+    above: {
+      boxShadow: (0, _uiThemes.boxShadowObjectsToCSSString)(sharedTokens.boxShadow.elevation2)
+    },
+    none: {}
+  };
+  const focusColor = props.focusColor,
+    focusPosition = props.focusPosition,
+    shouldAnimateFocus = props.shouldAnimateFocus,
+    withFocusOutline = props.withFocusOutline,
+    focusWithin = props.focusWithin;
+  const focusOutline = (0, _emotion.calcFocusOutlineStyles)(sharedTokens.focusOutline, {
+    focusColor,
+    focusPosition,
+    shouldAnimateFocus,
+    focusWithin,
+    withFocusOutline
+  });
+  return {
+    view: {
+      label: 'view',
+      boxSizing: 'border-box',
+      fontFamily: componentTheme.fontFamily,
+      maxWidth: '100%',
+      overflow: 'visible',
+      ...displayVariants[display],
+      ...(background && backgroundColorVariants[background]),
+      ...(stacking && stackingVariants[stacking]),
+      ...(shadow && shadowVariants[shadow]),
+      ...(textAlign && textAlignVariants[textAlign]),
+      overflowX: overflowX && overflowX !== 'visible' ? overflowX : '',
+      overflowY: overflowY && overflowY !== 'visible' ? overflowY : '',
+      position: position !== 'static' ? position : '',
+      overscrollBehavior: overscrollBehavior ? overscrollBehavior : 'auto',
+      ...(withVisualDebug ? {
+        boxShadow: `0 0 0 1px ${componentTheme.debugOutlineColor}`
+      } : {}),
+      ...(withBorder(props) ? {
+        borderStyle: componentTheme.borderStyle,
+        ...(borderColorVariants[borderColor] || {
+          borderColor: borderColor
+        })
+      } : {}),
+      ...borderStyle
+    },
+    inlineStyles: {
+      //every '&' symbol will add another class to the rule, so it will be stronger
+      //making an accidental override less likely
+      '&&&&&&&&&&': {
+        ...offsetStyle,
+        ...focusOutline,
+        width,
+        height,
+        minWidth,
+        minHeight,
+        maxWidth,
+        maxHeight,
+        ...getStyleProps(props),
+        ...spacingStyle
+      }
+    }
+  };
+};
+var _default = exports.default = generateStyle;

package/lib/{index.js → exports/a.js}

@@ -6,14 +6,14 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "ContextView", {
   enumerable: true,
   get: function () {
-    return _ContextView.ContextView;
+    return _v.ContextView;
   }
 });
 Object.defineProperty(exports, "View", {
   enumerable: true,
   get: function () {
-    return _View.View;
+    return _v2.View;
   }
 });
-var _ContextView = require("./ContextView");
-var _View = require("./View");
+var _v = require("../ContextView/v1");
+var _v2 = require("../View/v1");

package/lib/exports/b.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ContextView", {
+  enumerable: true,
+  get: function () {
+    return _v.ContextView;
+  }
+});
+Object.defineProperty(exports, "View", {
+  enumerable: true,
+  get: function () {
+    return _v2.View;
+  }
+});
+var _v = require("../ContextView/v2");
+var _v2 = require("../View/v2");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-view",
-  "version": "11.6.0",
+  "version": "11.6.1-snapshot-129",
   "description": "A component for basic styles including spacing, sizing, borders, display, positioning, and focus states.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -15,22 +15,22 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.27.6",
-    "@instructure/console": "11.6.0",
-    "@instructure/emotion": "11.6.0",
-    "@instructure/shared-types": "11.6.0",
-    "@instructure/ui-dom-utils": "11.6.0",
-    "@instructure/ui-color-utils": "11.6.0",
-    "@instructure/ui-position": "11.6.0",
-    "@instructure/ui-i18n": "11.6.0",
-    "@instructure/ui-react-utils": "11.6.0"
+    "@instructure/console": "11.6.1-snapshot-129",
+    "@instructure/emotion": "11.6.1-snapshot-129",
+    "@instructure/shared-types": "11.6.1-snapshot-129",
+    "@instructure/ui-color-utils": "11.6.1-snapshot-129",
+    "@instructure/ui-dom-utils": "11.6.1-snapshot-129",
+    "@instructure/ui-i18n": "11.6.1-snapshot-129",
+    "@instructure/ui-react-utils": "11.6.1-snapshot-129",
+    "@instructure/ui-position": "11.6.1-snapshot-129"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "15.0.7",
     "vitest": "^3.2.2",
-    "@instructure/ui-babel-preset": "11.6.0",
-    "@instructure/ui-axe-check": "11.6.0",
-    "@instructure/ui-themes": "11.6.0"
+    "@instructure/ui-axe-check": "11.6.1-snapshot-129",
+    "@instructure/ui-babel-preset": "11.6.1-snapshot-129",
+    "@instructure/ui-themes": "11.6.1-snapshot-129"
   },
   "peerDependencies": {
     "react": ">=18 <=19"
@@ -40,17 +40,39 @@
   },
   "sideEffects": false,
   "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "import": "./es/index.js",
-      "require": "./lib/index.js",
-      "default": "./es/index.js"
-    },
     "./lib/*": "./lib/*",
     "./es/*": "./es/*",
     "./types/*": "./types/*",
     "./package.json": "./package.json",
-    "./src/*": "./src/*"
+    "./src/*": "./src/*",
+    ".": {
+      "src": "./src/exports/a.ts",
+      "types": "./types/exports/a.d.ts",
+      "import": "./es/exports/a.js",
+      "require": "./lib/exports/a.js",
+      "default": "./es/exports/a.js"
+    },
+    "./v11_6": {
+      "src": "./src/exports/a.ts",
+      "types": "./types/exports/a.d.ts",
+      "import": "./es/exports/a.js",
+      "require": "./lib/exports/a.js",
+      "default": "./es/exports/a.js"
+    },
+    "./v11_7": {
+      "src": "./src/exports/b.ts",
+      "types": "./types/exports/b.d.ts",
+      "import": "./es/exports/b.js",
+      "require": "./lib/exports/b.js",
+      "default": "./es/exports/b.js"
+    },
+    "./latest": {
+      "src": "./src/exports/b.ts",
+      "types": "./types/exports/b.d.ts",
+      "import": "./es/exports/b.js",
+      "require": "./lib/exports/b.js",
+      "default": "./es/exports/b.js"
+    }
   },
   "scripts": {
     "lint": "ui-scripts lint",

package/src/ContextView/{index.tsx → v1/index.tsx}

@@ -24,10 +24,10 @@
 
 import { Component } from 'react'
 
-import { withStyle } from '@instructure/emotion'
+import { withStyleLegacy as withStyle } from '@instructure/emotion'
 import { omitProps } from '@instructure/ui-react-utils'
 
-import { View } from '../View'
+import { View } from '../../View/v1'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'

package/src/ContextView/v2/README.md

@@ -0,0 +1,53 @@
+---
+describes: ContextView
+---
+
+`<ContextView/>` is a container that can be rendered inline in the document flow (vs as a [Popover](Popover)) but with an arrow pointing to something. See [RangeInput](RangeInput) for an example of how ContextView can be used to display contextual information in conjunction with another component. It is used internally in [Popover](Popover).
+
+- Defaults to no padding around its content. To add padding, use the `padding` prop.
+
+- Use the `textAlign` prop to change the alignment of the text inside `<ContextView />`.
+
+- In use cases where `<ContextView/>` is not absolutely positioned, use the `margin` prop to set margin around the component.
+
+```js
+---
+type: example
+---
+<div>
+  <ContextView
+    padding="small"
+    margin="large"
+    placement="end top"
+    shadow="resting"
+  >
+    <Heading level="h3">Hello World</Heading>
+  </ContextView>
+  <ContextView
+    margin="0 large 0 0"
+    padding="small"
+    placement="top"
+  >
+    <Heading level="h3">Hello World</Heading>
+    <Text size="small">Some informational text that is helpful</Text>
+  </ContextView>
+  <ContextView
+    margin="0 large 0 0"
+    padding="small"
+    textAlign="end"
+    placement="start"
+  >
+    <Heading level="h3">Hello World</Heading>
+    <Text size="small">This ContextView is end-text-aligned</Text>
+  </ContextView>
+  <ContextView
+    placement="end bottom"
+    padding="medium"
+    background="inverse"
+    width="30rem"
+    margin="x-large 0 0"
+  >
+      This ContextView uses the inverse background and medium padding. Its width prop is set to `30rem`, which causes long strings like this to wrap. It also has top margin to separate it from the ContextViews above it.
+  </ContextView>
+</div>
+```