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

package/src/Table/v2/props.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 {
+  Spacing,
+  ComponentStyle,
+  WithStyleProps
+} from '@instructure/emotion'
+import type { OtherHTMLAttributes } from '@instructure/shared-types'
+
+type RowChild = React.ReactElement<{ children: React.ReactElement }>
+
+type TableOwnProps = {
+  /**
+   * Provide a screen reader friendly description. Anything passed to this
+   * prop will be wrapped by `<ScreenReaderContent>` when it is rendered.
+   */
+  caption: React.ReactNode
+  /**
+   * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+   * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+   * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+   */
+  margin?: Spacing
+  /**
+   * Provide a reference to the underlying html element
+   */
+  elementRef?: (element: Element | null) => void
+  /**
+   * Highlight each row on hover
+   */
+  hover?: boolean
+  /**
+   * `auto` lets the browser determine table column widths based on cell content,
+   * while `fixed` forces columns of equal width (sets the
+   * [tableLayout](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)
+   * CSS prop to `fixed`).
+   *
+   * `stacked` renders table in one column to be more readable on narrow screens
+   */
+  layout?: 'auto' | 'fixed' | 'stacked'
+  /**
+   * Sets the CSS prop `min-width` on the table.
+   * Same as {@link React.CSSProperties.minWidth}
+   */
+  minWidth?: React.CSSProperties['minWidth']
+  /**
+   * `Table.Head` or `Table.Body`
+   */
+  children?: React.ReactNode
+}
+
+type PropKeys = keyof TableOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TableProps = TableOwnProps &
+  WithStyleProps<null, TableStyle> &
+  OtherHTMLAttributes<TableOwnProps>
+
+type TableStyle = ComponentStyle<'table'>
+const allowedProps: AllowedPropKeys = [
+  'caption',
+  'children',
+  'margin',
+  'elementRef',
+  'hover',
+  'layout'
+]
+
+export type {
+  TableProps,
+  TableStyle,
+  // children
+  RowChild
+}
+export { allowedProps }

package/src/Table/v2/styles.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 { TableProps, TableStyle } from './props'
+import type { NewComponentTypes, SharedTokens } from '@instructure/ui-themes'
+
+/**
+ * ---
+ * 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} sharedTokens Shared token object
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (
+  componentTheme: NewComponentTypes['Table'],
+  props: TableProps,
+  _sharedTokens: SharedTokens
+): TableStyle => {
+  const { layout } = props
+
+  return {
+    table: {
+      label: 'table',
+      fontSize: componentTheme.fontSize,
+      fontFamily: componentTheme.fontFamily,
+      fontWeight: componentTheme.fontWeight,
+      color: componentTheme.color,
+      background: componentTheme.background,
+      display: 'table',
+      width: '100%',
+      borderCollapse: 'collapse',
+      borderSpacing: 0,
+      ...(layout === 'fixed' && { tableLayout: 'fixed' }),
+      caption: { textAlign: 'start' }
+    }
+  }
+}
+
+export default generateStyle

package/src/exports/a.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 { Table } from '../Table/v1'
+export { TableContext } from '../Table/v1/TableContext'
+export { Body as TableBody } from '../Table/v1/Body'
+export { Cell as TableCell } from '../Table/v1/Cell'
+export { ColHeader as TableColHeader } from '../Table/v1/ColHeader'
+export { Head as TableHead } from '../Table/v1/Head'
+export { Row as TableRow } from '../Table/v1/Row'
+export { RowHeader as TableRowHeader } from '../Table/v1/RowHeader'
+
+export type { TableProps } from '../Table/v1/props'
+export type { TableBodyProps } from '../Table/v1/Body/props'
+export type { TableCellProps } from '../Table/v1/Cell/props'
+export type { TableColHeaderProps } from '../Table/v1/ColHeader/props'
+export type { TableHeadProps } from '../Table/v1/Head/props'
+export type { TableRowProps } from '../Table/v1/Row/props'
+export type { TableRowHeaderProps } from '../Table/v1/RowHeader/props'

package/src/exports/b.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 { Table } from '../Table/v2'
+export { TableContext } from '../Table/v2/TableContext'
+export { Body as TableBody } from '../Table/v2/Body'
+export { Cell as TableCell } from '../Table/v2/Cell'
+export { ColHeader as TableColHeader } from '../Table/v2/ColHeader'
+export { Head as TableHead } from '../Table/v2/Head'
+export { Row as TableRow } from '../Table/v2/Row'
+export { RowHeader as TableRowHeader } from '../Table/v2/RowHeader'
+
+export type { TableProps } from '../Table/v2/props'
+export type { TableBodyProps } from '../Table/v2/Body/props'
+export type { TableCellProps } from '../Table/v2/Cell/props'
+export type { TableColHeaderProps } from '../Table/v2/ColHeader/props'
+export type { TableHeadProps } from '../Table/v2/Head/props'
+export type { TableRowProps } from '../Table/v2/Row/props'
+export type { TableRowHeaderProps } from '../Table/v2/RowHeader/props'