@instructure/ui-table 8.8.1-snapshot.8 → 8.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-table",
-  "version": "8.8.1-snapshot.8+7b83164f4",
+  "version": "8.9.0",
   "description": "A styled HTML table component",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,24 +24,24 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-color-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-themes": "8.8.1-snapshot.8+7b83164f4"
+    "@instructure/ui-babel-preset": "8.9.0",
+    "@instructure/ui-color-utils": "8.9.0",
+    "@instructure/ui-test-utils": "8.9.0",
+    "@instructure/ui-themes": "8.9.0"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/console": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/emotion": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/shared-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-a11y-content": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-icons": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-prop-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-simple-select": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-testable": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-view": "8.8.1-snapshot.8+7b83164f4",
+    "@instructure/console": "8.9.0",
+    "@instructure/emotion": "8.9.0",
+    "@instructure/shared-types": "8.9.0",
+    "@instructure/ui-a11y-content": "8.9.0",
+    "@instructure/ui-icons": "8.9.0",
+    "@instructure/ui-prop-types": "8.9.0",
+    "@instructure/ui-react-utils": "8.9.0",
+    "@instructure/ui-simple-select": "8.9.0",
+    "@instructure/ui-testable": "8.9.0",
+    "@instructure/ui-utils": "8.9.0",
+    "@instructure/ui-view": "8.9.0",
     "prop-types": "^15"
   },
   "peerDependencies": {
@@ -50,6 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "7b83164f4c5872f3a217e010563f59bf584ae4fc"
+  "sideEffects": false
 }

package/src/Table/Body/index.tsx

@@ -24,21 +24,20 @@
 
 /** @jsx jsx */
 import { Component, Children, ReactElement } from 'react'
-import PropTypes from 'prop-types'
 
 import {
   matchComponentTypes,
   safeCloneElement,
   omitProps
 } from '@instructure/ui-react-utils'
-import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types'
 import { View } from '@instructure/ui-view'
 import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
 import { Row } from '../Row'
-import { TableBodyProps } from './types'
+import type { TableBodyProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -50,37 +49,20 @@ id: Table.Body
 class Body extends Component<TableBodyProps> {
   static readonly componentId = 'Table.Body'
 
-  /* eslint-disable react/require-default-props */
-  static propTypes = {
-    /**
-     * `Table.Row`
-     */
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    children: ChildrenPropTypes.oneOf([Row]),
-    hover: PropTypes.bool,
-    isStacked: PropTypes.bool,
-    headers: PropTypes.arrayOf(
-      PropTypes.oneOfType([PropTypes.node, PropTypes.func])
-    )
-  }
-  /* eslint-enable react/require-default-props */
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     children: null
   }
 
   componentDidMount() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   // @ts-expect-error ts-migrate(6133) FIXME: 'prevProps' is declared but its value is never rea... Remove this comment to see the full error message
   componentDidUpdate(prevProps, prevState, snapshot) {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   render() {
@@ -90,7 +72,7 @@ class Body extends Component<TableBodyProps> {
       <View
         {...View.omitViewProps(omitProps(this.props, Body.propTypes), Body)}
         as={isStacked ? 'div' : 'tbody'}
-        css={styles.body}
+        css={styles?.body}
         role={isStacked ? 'rowgroup' : undefined}
       >
         {Children.map(children, (child) =>

package/src/Table/{Row/types.ts → Body/props.ts}

@@ -21,11 +21,47 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+import React from 'react'
+import PropTypes from 'prop-types'
 
-export type TableRowProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
+import { Children as ChildrenPropTypes } from '@instructure/ui-prop-types'
+
+import { Row } from '../Row'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type TableBodyOwnProps = {
   hover?: boolean
   isStacked?: boolean
   headers?: (React.ReactNode | ((...args: any[]) => any))[]
+  children?: React.ReactNode
+}
+
+type PropKeys = keyof TableBodyOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TableBodyProps = TableBodyOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * `Table.Row`
+   */
+  children: ChildrenPropTypes.oneOf([Row]),
+  hover: PropTypes.bool,
+  isStacked: PropTypes.bool,
+  headers: PropTypes.arrayOf(
+    PropTypes.oneOfType([PropTypes.node, PropTypes.func])
+  )
 }
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'hover',
+  'isStacked',
+  'headers'
+]
+
+export type { TableBodyProps }
+export { propTypes, allowedProps }

package/src/Table/Cell/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { omitProps, callRenderProp } from '@instructure/ui-react-utils'
 import { View } from '@instructure/ui-view'
@@ -33,7 +32,8 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { TableCellProps } from './types'
+import type { TableCellProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -45,21 +45,8 @@ id: Table.Cell
 class Cell extends Component<TableCellProps> {
   static readonly componentId = 'Table.Cell'
 
-  /* eslint-disable react/require-default-props */
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    isStacked: PropTypes.bool,
-    header: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * Control the text alignment in cell
-     */
-    textAlign: PropTypes.oneOf(['start', 'center', 'end'])
-  }
-  /* eslint-enable react/require-default-props */
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     textAlign: 'start',
@@ -67,14 +54,11 @@ class Cell extends Component<TableCellProps> {
   }
 
   componentDidMount() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
-  // @ts-expect-error ts-migrate(6133) FIXME: 'prevProps' is declared but its value is never rea... Remove this comment to see the full error message
-  componentDidUpdate(prevProps, prevState, snapshot) {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+  componentDidUpdate() {
+    this.props.makeStyles?.()
   }
 
   render() {
@@ -84,7 +68,7 @@ class Cell extends Component<TableCellProps> {
       <View
         {...View.omitViewProps(omitProps(this.props, Cell.propTypes), Cell)}
         as={isStacked ? 'div' : 'td'}
-        css={styles.cell}
+        css={styles?.cell}
         role={isStacked ? 'cell' : undefined}
       >
         {header && callRenderProp(header)}

package/src/Table/Cell/props.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 PropTypes from 'prop-types'
+
+import type { WithStyleProps } from '@instructure/emotion'
+import type { PropValidators } from '@instructure/shared-types'
+
+type TableCellOwnProps = {
+  isStacked?: boolean
+  header?: React.ReactNode | ((...args: any[]) => any)
+  textAlign?: 'start' | 'center' | 'end'
+  children?: React.ReactNode | ((...args: any[]) => React.ReactNode)
+}
+
+type PropKeys = keyof TableCellOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TableCellProps = TableCellOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  isStacked: PropTypes.bool,
+  header: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  /**
+   * Control the text alignment in cell
+   */
+  textAlign: PropTypes.oneOf(['start', 'center', 'end'])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'isStacked',
+  'header',
+  'textAlign'
+]
+
+export type { TableCellProps }
+export { propTypes, allowedProps }

package/src/Table/Cell/styles.ts

@@ -23,7 +23,7 @@
  */
 
 import { TableCellTheme } from '@instructure/shared-types'
-import { TableCellProps } from './types'
+import { TableCellProps } from './props'
 
 /**
  * ---

package/src/Table/ColHeader/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import { omitProps, callRenderProp } from '@instructure/ui-react-utils'
 import {
@@ -36,7 +35,8 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { TableColHeaderProps } from './types'
+import type { TableColHeaderProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -48,64 +48,22 @@ id: Table.ColHeader
 class ColHeader extends Component<TableColHeaderProps> {
   static readonly componentId = 'Table.ColHeader'
 
-  /* eslint-disable react/require-default-props */
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * A unique id for this column. The `id` is also used as option in combobox,
-     * when sortable table is in stacked layout,
-     * and no `stackedSortByLabel` is provided.
-     */
-    id: PropTypes.string.isRequired,
-    /**
-     * A custom string to display as option text in the combobox (instead of
-     * using the `id` prop), when sortable table is in stacked layout.
-     */
-    stackedSortByLabel: PropTypes.string,
-    children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-    /**
-     * Control the width of column.
-     */
-    width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-    /**
-     * Control the text alignment in column header
-     */
-    textAlign: PropTypes.oneOf(['start', 'center', 'end']),
-    /**
-     * The string of sorting direction
-     */
-    sortDirection: PropTypes.oneOf(['none', 'ascending', 'descending']),
-    /**
-     * Callback fired when column header is clicked. Parameters: `(event, { id })`
-     */
-    onRequestSort: PropTypes.func,
-    /**
-     * The column header scope attribute. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th#attr-scope
-     */
-    scope: PropTypes.oneOf(['row', 'col', 'rowgroup', 'colgroup', 'auto'])
-  }
-  /* eslint-enable react/require-default-props */
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
     textAlign: 'start',
     sortDirection: 'none',
-    stackedSortByLabel: undefined,
     children: null,
     scope: 'col'
   }
 
   componentDidMount() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
-  // @ts-expect-error ts-migrate(6133) FIXME: 'prevProps' is declared but its value is never rea... Remove this comment to see the full error message
-  componentDidUpdate(prevProps, prevState, snapshot) {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+  componentDidUpdate() {
+    this.props.makeStyles?.()
   }
 
   // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'event' implicitly has an 'any' type.
@@ -147,7 +105,7 @@ class ColHeader extends Component<TableColHeaderProps> {
     return (
       <th
         {...omitProps(this.props, ColHeader.propTypes)}
-        css={styles.colHeader}
+        css={styles?.colHeader}
         style={{
           width
         }}
@@ -155,7 +113,7 @@ class ColHeader extends Component<TableColHeaderProps> {
         aria-sort={sortDirection}
       >
         {onRequestSort && (
-          <button onClick={this.handleClick} css={styles.button}>
+          <button onClick={this.handleClick} css={styles?.button}>
             <div>
               {callRenderProp(children)}
               {this.renderSortArrow()}

package/src/Table/ColHeader/props.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 PropTypes from 'prop-types'
+
+import type { PropValidators } from '@instructure/shared-types'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type TableColHeaderOwnProps = {
+  id: string
+  stackedSortByLabel?: string
+  width?: string | number
+  textAlign?: 'start' | 'center' | 'end'
+  sortDirection?: 'none' | 'ascending' | 'descending'
+  onRequestSort?: (...args: any[]) => any
+  scope?: 'row' | 'col' | 'rowgroup' | 'colgroup' | 'auto'
+  children?: React.ReactNode | ((...args: any[]) => React.ReactNode)
+}
+
+type PropKeys = keyof TableColHeaderOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TableColHeaderProps = TableColHeaderOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * A unique id for this column. The `id` is also used as option in combobox,
+   * when sortable table is in stacked layout,
+   * and no `stackedSortByLabel` is provided.
+   */
+  id: PropTypes.string.isRequired,
+  /**
+   * A custom string to display as option text in the combobox (instead of
+   * using the `id` prop), when sortable table is in stacked layout.
+   */
+  stackedSortByLabel: PropTypes.string,
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  /**
+   * Control the width of column.
+   */
+  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * Control the text alignment in column header
+   */
+  textAlign: PropTypes.oneOf(['start', 'center', 'end']),
+  /**
+   * The string of sorting direction
+   */
+  sortDirection: PropTypes.oneOf(['none', 'ascending', 'descending']),
+  /**
+   * Callback fired when column header is clicked. Parameters: `(event, { id })`
+   */
+  onRequestSort: PropTypes.func,
+  /**
+   * The column header scope attribute. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th#attr-scope
+   */
+  scope: PropTypes.oneOf(['row', 'col', 'rowgroup', 'colgroup', 'auto'])
+}
+
+const allowedProps: AllowedPropKeys = [
+  'id',
+  'stackedSortByLabel',
+  'children',
+  'width',
+  'textAlign',
+  'sortDirection',
+  'onRequestSort',
+  'scope'
+]
+
+export type { TableColHeaderProps }
+export { propTypes, allowedProps }