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

package/lib/Tray/v2/styles.js

@@ -0,0 +1,137 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+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.
+ */
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} params the props and passed through data of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (componentTheme, params) => {
+  const border = params.border,
+    shadow = params.shadow,
+    size = params.size,
+    placement = params.placement;
+  const borderStyle = {
+    borderWidth: 0,
+    borderColor: componentTheme.borderColor,
+    borderStyle: 'solid'
+  };
+  const shadowStyle = shadow ? {
+    boxShadow: (0, _uiThemes.boxShadowObjectsToCSSString)(componentTheme.boxShadow)
+  } : {};
+  const contentStyle = placement === 'start' || placement === 'end' || placement === 'center' ? {
+    label: 'tray__content',
+    minHeight: '100vh'
+  } : {};
+  const placementStyles = {
+    top: {
+      insetInlineStart: 0,
+      insetInlineEnd: 0,
+      top: 0
+    },
+    bottom: {
+      insetInlineStart: 0,
+      insetInlineEnd: 0,
+      bottom: 0
+    },
+    start: {
+      top: 0,
+      bottom: 0,
+      insetInlineStart: 0,
+      insetInlineEnd: 'auto'
+    },
+    end: {
+      top: 0,
+      bottom: 0,
+      insetInlineEnd: 0,
+      insetInlineStart: 'auto'
+    },
+    center: {
+      left: 0,
+      right: 0,
+      top: 0,
+      bottom: 0
+    }
+  };
+  const borderPlacementStyle = border ? {
+    start: {
+      borderInlineEndWidth: componentTheme.borderWidth
+    },
+    end: {
+      borderInlineStartWidth: componentTheme.borderWidth
+    },
+    top: {
+      borderBottomWidth: componentTheme.borderWidth
+    },
+    bottom: {
+      borderTopWidth: componentTheme.borderWidth
+    },
+    center: {}
+  } : {};
+  const sizeVariants = {
+    'x-small': componentTheme.widthXs,
+    small: componentTheme.widthSm,
+    regular: componentTheme.widthMd,
+    medium: componentTheme.widthLg,
+    large: componentTheme.widthXl
+  };
+  const sizeStyle = placement === 'start' || placement === 'end' ? {
+    width: sizeVariants[size]
+  } : {};
+  return {
+    tray: {
+      label: 'tray',
+      padding: componentTheme.padding,
+      backgroundColor: componentTheme.backgroundColor,
+      position: 'fixed',
+      overflowY: 'auto',
+      overflowX: 'hidden',
+      boxSizing: 'border-box',
+      zIndex: componentTheme.zIndex,
+      maxWidth: '100vw',
+      maxHeight: '100vh',
+      ...shadowStyle,
+      ...placementStyles[placement],
+      ...(border && borderStyle),
+      ...(border && borderPlacementStyle[placement]),
+      ...sizeStyle
+    },
+    content: {
+      label: 'tray__content',
+      ...contentStyle
+    }
+  };
+};
+var _default = exports.default = generateStyle;

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

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "Tray", {
   enumerable: true,
   get: function () {
-    return _Tray.Tray;
+    return _v.Tray;
   }
 });
-var _Tray = require("./Tray");
+var _v = require("../Tray/v1");

package/lib/exports/b.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-tray",
-  "version": "11.6.0",
+  "version": "11.6.1-snapshot-129",
   "description": "Tray component for secondary/menu content",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -15,25 +15,25 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.27.6",
-    "@instructure/console": "11.6.0",
-    "@instructure/ui-dialog": "11.6.0",
-    "@instructure/emotion": "11.6.0",
-    "@instructure/ui-i18n": "11.6.0",
-    "@instructure/shared-types": "11.6.0",
-    "@instructure/ui-motion": "11.6.0",
-    "@instructure/ui-overlays": "11.6.0",
-    "@instructure/ui-portal": "11.6.0",
-    "@instructure/ui-utils": "11.6.0",
-    "@instructure/ui-react-utils": "11.6.0",
-    "@instructure/ui-position": "11.6.0"
+    "@instructure/emotion": "11.6.1-snapshot-129",
+    "@instructure/console": "11.6.1-snapshot-129",
+    "@instructure/shared-types": "11.6.1-snapshot-129",
+    "@instructure/ui-dialog": "11.6.1-snapshot-129",
+    "@instructure/ui-i18n": "11.6.1-snapshot-129",
+    "@instructure/ui-motion": "11.6.1-snapshot-129",
+    "@instructure/ui-overlays": "11.6.1-snapshot-129",
+    "@instructure/ui-portal": "11.6.1-snapshot-129",
+    "@instructure/ui-position": "11.6.1-snapshot-129",
+    "@instructure/ui-react-utils": "11.6.1-snapshot-129",
+    "@instructure/ui-utils": "11.6.1-snapshot-129"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "15.0.7",
     "@testing-library/user-event": "^14.6.1",
     "vitest": "^3.2.2",
-    "@instructure/ui-themes": "11.6.0",
-    "@instructure/ui-babel-preset": "11.6.0"
+    "@instructure/ui-babel-preset": "11.6.1-snapshot-129",
+    "@instructure/ui-themes": "11.6.1-snapshot-129"
   },
   "peerDependencies": {
     "react": ">=18 <=19"
@@ -43,17 +43,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/Tray/{index.tsx → v1/index.tsx}

@@ -33,12 +33,12 @@ import type { PortalNode } from '@instructure/ui-portal'
 import { mirrorHorizontalPlacement } from '@instructure/ui-position'
 import { Transition } from '@instructure/ui-motion'
 import type { TransitionType } from '@instructure/ui-motion'
-import { withStyle } from '@instructure/emotion'
+import { withStyleLegacy as withStyle } from '@instructure/emotion'
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
 import { allowedProps } from './props'
 import type { TrayProps, TrayState } from './props'
-import { Mask } from '@instructure/ui-overlays'
+import { Mask } from '@instructure/ui-overlays/v11_6'
 
 /**
 ---

package/src/Tray/v2/README.md

@@ -0,0 +1,100 @@
+---
+describes: Tray
+---
+
+The Tray is an actionable container that is triggered by click and does not need to be connected to the element that triggered it. The Tray is on the same hierarchy as the Popover but contains more content. The Tray slides out from the top/bottom/start/end of the viewport.
+
+> Note that the `size` property only applies when the Tray is positioned at `start` or `end` and defines the width of the Tray.
+
+```js
+---
+type: example
+---
+const FPO = lorem.paragraph()
+
+const Example = () => {
+  const [open, setOpen] = useState(false)
+
+  const hideTray = () => {
+    setOpen(false)
+  }
+
+  const renderCloseButton = () => (
+    <Flex>
+      <Flex.Item>
+        <CloseButton
+          placement="end"
+          offset="small"
+          screenReaderLabel="Close"
+          onClick={hideTray}
+        />
+      </Flex.Item>
+      <Flex.Item shouldGrow shouldShrink>
+        <Heading>Hello</Heading>
+      </Flex.Item>
+    </Flex>
+  )
+
+  return (
+    <div style={{ padding: '0 0 16rem 0', margin: '0 auto' }}>
+      <Button onClick={() => setOpen(true)}>Show the Tray</Button>
+      <Tray
+        label="Tray Example"
+        open={open}
+        onDismiss={() => setOpen(false)}
+        size="small"
+        placement="start"
+      >
+        <View as="div" padding="medium">
+          {renderCloseButton()}
+          <Text as="p" lineHeight="double">
+            {FPO}
+          </Text>
+        </View>
+      </Tray>
+    </div>
+  )
+}
+
+render(<Example />)
+```
+
+### Guidelines
+
+```js
+---
+type: embed
+---
+<Guidelines>
+  <Figure recommendation="yes" title="Do">
+    <Figure.Item>Configure Tray to enter from the end on desktop, bottom on mobile/tablet</Figure.Item>
+    <Figure.Item>Use when it is useful to still see information contained on the page or not lose context of the page that triggered the Tray</Figure.Item>
+    <Figure.Item>Use 2 tabs max if using TabList in small size</Figure.Item>
+    <Figure.Item>Use 5 tabs max if using TabList in medium/large size</Figure.Item>
+    <Figure.Item>Prefer Tray to close when user clicks outside of the Tray</Figure.Item>
+    <Figure.Item>Keep the close 'x' directly following the Tray title, no matter what side the Tray slides from</Figure.Item>
+  </Figure>
+  <Figure recommendation="no" title="Don't">
+    <Figure.Item>Use TabList in the x-small size</Figure.Item>
+    <Figure.Item>Use for Sub Nav or <Link href="/#DrawerLayout">Drawer Layout</Link></Figure.Item>
+    <Figure.Item>Use with an <Link href="/#Overlay">Overlay</Link></Figure.Item>
+    <Figure.Item>Use a Tray on top of a <Link href="/#Modal">Modal</Link></Figure.Item>
+    <Figure.Item>Use for <Link href="#Alert">Alerts</Link> or Confirmation Dialogs</Figure.Item>
+    <Figure.Item>Allow Tray to push the content of the page</Figure.Item>
+  </Figure>
+</Guidelines>
+```
+
+```js
+---
+type: embed
+---
+<Guidelines>
+  <Figure recommendation="a11y" title="Accessibility">
+    <Figure.Item>Keyboard focus must be set in the tray when it appears; usually on the first interactive element</Figure.Item>
+    <Figure.Item>Trays must contain keyboard focus until they’re closed. This is to ensure that keyboard or screen reader users won't mistakenly interact with background content that is meant to be hidden or inaccessible</Figure.Item>
+    <Figure.Item>When a user closes a tray, focus must return to a logical place within the page. This is usually the element that triggered opening the tray</Figure.Item>
+    <Figure.Item>We recommend that trays begin with a heading (typically H2). However, when configuring the component, the button to close the Tray should precede the heading. This ensures screen readers announce the Tray's content in a logical order.</Figure.Item>
+  </Figure>
+</Guidelines>
+```

package/src/Tray/v2/index.tsx

@@ -0,0 +1,249 @@
+/*
+ * 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.
+ */
+
+import { Component, createRef } from 'react'
+
+import { Dialog } from '@instructure/ui-dialog'
+import { omitProps } from '@instructure/ui-react-utils'
+import { createChainedFunction } from '@instructure/ui-utils'
+import { textDirectionContextConsumer } from '@instructure/ui-i18n'
+import { Portal } from '@instructure/ui-portal'
+import type { PortalNode } from '@instructure/ui-portal'
+import { mirrorHorizontalPlacement } from '@instructure/ui-position'
+import { Transition } from '@instructure/ui-motion'
+import type { TransitionType } from '@instructure/ui-motion'
+import { withStyle } from '@instructure/emotion'
+import generateStyle from './styles'
+import { allowedProps } from './props'
+import type { TrayProps, TrayState } from './props'
+import { Mask } from '@instructure/ui-overlays/latest'
+
+/**
+---
+category: components
+---
+**/
+@withStyle(generateStyle)
+@textDirectionContextConsumer()
+class Tray extends Component<TrayProps> {
+  static readonly componentId = 'Tray'
+
+  static allowedProps = allowedProps
+
+  static defaultProps = {
+    defaultFocusElement: null,
+    open: false,
+    insertAt: 'bottom',
+    shouldCloseOnDocumentClick: false,
+    shouldContainFocus: true,
+    shouldReturnFocus: true,
+    size: 'small',
+    placement: 'start',
+    transitionOnMount: true,
+    transitionEnter: true,
+    transitionExit: true,
+    shadow: true,
+    border: false,
+    enableMask: false
+  }
+  ref: Element | null = null
+  dialogRef = createRef<Dialog>()
+
+  state: TrayState
+
+  constructor(props: TrayProps) {
+    super(props)
+    this.state = {
+      transitioning: false,
+      open: props.open ?? false
+    }
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.()
+  }
+
+  componentDidUpdate(prevProps: TrayProps, _prevState: TrayState) {
+    if (this.props.open !== prevProps.open) {
+      if (!this.props.open) {
+        // calling Dialog.close() to remove focusregion immediately when transition starts
+        // so if a new Tray is opened (during transition) the new focusregion won't get treated as a child of this one
+        this.dialogRef.current?.close()
+      }
+
+      this.setState({ transitioning: true, open: this.props.open })
+    }
+    this.props.makeStyles?.()
+  }
+
+  get placement() {
+    const { placement, dir } = this.props
+    const isRtl = dir === textDirectionContextConsumer.DIRECTION.rtl
+    return isRtl ? mirrorHorizontalPlacement(placement!, ' ') : placement
+  }
+
+  get direction() {
+    switch (this.placement) {
+      case 'top':
+        return 'up'
+      case 'bottom':
+        return 'down'
+      case 'end':
+        return 'right'
+      default:
+        // start
+        return 'left'
+    }
+  }
+
+  get transition(): TransitionType {
+    return `slide-${this.direction}`
+  }
+
+  handleTransitionComplete = (_type?: TransitionType) => {
+    this.setState({ transitioning: false })
+  }
+
+  get DOMNode() {
+    // The DOMNode property is needed for Portal type components
+    return this.ref
+  }
+
+  set DOMNode(el) {
+    this.ref = el ? el : null
+  }
+
+  handlePortalOpen = (DOMNode: PortalNode) => {
+    if (DOMNode) {
+      this.DOMNode = DOMNode
+    }
+  }
+
+  render() {
+    const {
+      label,
+      children,
+      size,
+      placement,
+      open,
+      defaultFocusElement,
+      contentRef,
+      shouldContainFocus,
+      shouldReturnFocus,
+      shouldCloseOnDocumentClick,
+      onOpen,
+      onClose,
+      onDismiss,
+      mountNode,
+      insertAt,
+      liveRegion,
+      onEnter,
+      onEntering,
+      onEntered,
+      onExit,
+      onExiting,
+      onExited,
+      onTransition,
+      transitionOnMount,
+      transitionEnter,
+      transitionExit,
+      border,
+      shadow,
+      role,
+      enableMask,
+      ...props
+    } = this.props
+
+    const portalIsOpen = this.state.open || this.state.transitioning
+
+    const content = (
+      <Transition
+        in={open}
+        type={this.transition}
+        onTransition={onTransition}
+        onEnter={onEnter}
+        onEntering={onEntering}
+        onEntered={createChainedFunction(
+          this.handleTransitionComplete,
+          onEntered,
+          onOpen
+        )}
+        onExit={onExit}
+        onExiting={onExiting}
+        onExited={createChainedFunction(
+          this.handleTransitionComplete,
+          onExited,
+          onClose
+        )}
+        transitionOnMount={transitionOnMount}
+        transitionEnter={transitionEnter}
+        transitionExit={transitionExit}
+      >
+        <span
+          {...omitProps(props, Tray.allowedProps)}
+          css={this.props.styles?.tray}
+          ref={contentRef}
+        >
+          <Dialog
+            ref={this.dialogRef}
+            as="div"
+            label={label}
+            defaultFocusElement={defaultFocusElement}
+            open
+            shouldContainFocus={shouldContainFocus}
+            shouldReturnFocus={shouldReturnFocus}
+            shouldCloseOnDocumentClick={shouldCloseOnDocumentClick}
+            shouldCloseOnEscape
+            liveRegion={liveRegion}
+            onDismiss={onDismiss}
+            role={role}
+          >
+            <div css={this.props.styles?.content}>{children}</div>
+          </Dialog>
+        </span>
+      </Transition>
+    )
+
+    return (
+      <Portal
+        open={portalIsOpen}
+        onOpen={this.handlePortalOpen}
+        insertAt={insertAt}
+        mountNode={mountNode}
+        data-cid="Tray"
+      >
+        {enableMask ? (
+          <Mask placement={'center'} fullscreen={true}>
+            {content}
+          </Mask>
+        ) : (
+          content
+        )}
+      </Portal>
+    )
+  }
+}
+
+export default Tray
+export { Tray }