@instructure/ui-drawer-layout 11.6.0 → 11.6.1-snapshot-129

package/src/DrawerLayout/v2/props.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 React from 'react'
+import type { TextDirectionContextConsumerProps } from '@instructure/ui-i18n'
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type { WithDeterministicIdProps } from '@instructure/ui-react-utils'
+
+type DrawerLayoutOwnProps = {
+  /**
+   * Exactly one of each of the following child types: `DrawerLayout.Content`, `DrawerLayout.Tray`
+   */
+  children?: React.ReactNode // TODO: oneOfEach([DrawerContent, DrawerTray])
+
+  /**
+   * Min width for the `<DrawerLayout.Content />`
+   */
+  minWidth?: string
+
+  /**
+   * Function called when the `<DrawerLayout.Content />` is resized and hits the `minWidth` breakpoint
+   * Called with a boolean value, `true` if the tray is now overlaying the content or `false` if
+   * it is side by side
+   */
+  onOverlayTrayChange?: (shouldOverlayTray: boolean) => void
+} & TextDirectionContextConsumerProps
+
+type PropKeys = keyof DrawerLayoutOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type DrawerLayoutProps = DrawerLayoutOwnProps &
+  WithStyleProps<null, DrawerLayoutStyle> &
+  WithDeterministicIdProps
+
+type DrawerLayoutStyle = ComponentStyle<'drawerLayout'>
+
+type DrawerLayoutState = {
+  shouldOverlayTray: boolean
+  trayWidth: number
+  contentWidth: number
+}
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'minWidth',
+  'onOverlayTrayChange',
+  'dir'
+]
+
+export type { DrawerLayoutProps, DrawerLayoutState, DrawerLayoutStyle }
+export { allowedProps }

package/src/DrawerLayout/v2/styles.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 type { DrawerLayoutStyle } from './props'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * 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
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (): DrawerLayoutStyle => {
+  return {
+    drawerLayout: {
+      label: 'drawerLayout',
+      position: 'relative',
+      height: '100%'
+    }
+  }
+}
+
+export default generateStyle

package/src/{index.ts → exports/a.ts}

@@ -22,8 +22,8 @@
  * SOFTWARE.
  */
 
-export { DrawerLayout, DrawerContent, DrawerTray } from './DrawerLayout'
+export { DrawerLayout, DrawerContent, DrawerTray } from '../DrawerLayout/v1'
 
-export type { DrawerLayoutProps } from './DrawerLayout/props'
-export type { DrawerLayoutContentProps } from './DrawerLayout/DrawerContent/props'
-export type { DrawerLayoutTrayProps } from './DrawerLayout/DrawerTray/props'
+export type { DrawerLayoutProps } from '../DrawerLayout/v1/props'
+export type { DrawerLayoutContentProps } from '../DrawerLayout/v1/DrawerContent/props'
+export type { DrawerLayoutTrayProps } from '../DrawerLayout/v1/DrawerTray/props'

package/src/exports/b.ts

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+export { DrawerLayout, DrawerContent, DrawerTray } from '../DrawerLayout/v2'
+
+export type { DrawerLayoutProps } from '../DrawerLayout/v2/props'
+export type { DrawerLayoutContentProps } from '../DrawerLayout/v2/DrawerContent/props'
+export type { DrawerLayoutTrayProps } from '../DrawerLayout/v2/DrawerTray/props'