@atlaskit/table-tree 9.1.8 → 9.1.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/table-tree
 
+## 9.1.9
+
+### Patch Changes
+
+- [`efa50ac72ba`](https://bitbucket.org/atlassian/atlassian-frontend/commits/efa50ac72ba) - Adjusts jsdoc strings to improve prop documentation
+
 ## 9.1.8
 
 ### Patch Changes

package/dist/cjs/components/row.js

@@ -44,7 +44,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 var packageName = "@atlaskit/table-tree";
-var packageVersion = "9.1.8";
+var packageVersion = "9.1.9";
 
 var Row = /*#__PURE__*/function (_Component) {
   (0, _inherits2.default)(Row, _Component);

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/table-tree",
-	"version": "9.1.8",
+	"version": "9.1.9",
 	"sideEffects": false
 }

package/dist/es2019/components/row.js

@@ -8,7 +8,7 @@ import toItemId from '../utils/to-item-id';
 import Chevron from './internal/chevron';
 import { TreeRowContainer } from './internal/styled';
 const packageName = "@atlaskit/table-tree";
-const packageVersion = "9.1.8";
+const packageVersion = "9.1.9";
 
 class Row extends Component {
   constructor(...args) {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/table-tree",
-	"version": "9.1.8",
+	"version": "9.1.9",
 	"sideEffects": false
 }

package/dist/esm/components/row.js

@@ -18,7 +18,7 @@ import toItemId from '../utils/to-item-id';
 import Chevron from './internal/chevron';
 import { TreeRowContainer } from './internal/styled';
 var packageName = "@atlaskit/table-tree";
-var packageVersion = "9.1.8";
+var packageVersion = "9.1.9";
 
 var Row = /*#__PURE__*/function (_Component) {
   _inherits(Row, _Component);

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/table-tree",
-	"version": "9.1.8",
+	"version": "9.1.9",
 	"sideEffects": false
 }

package/dist/types/components/cell.d.ts

@@ -1,8 +1,20 @@
 import React from 'react';
 export interface CellProps {
+    /**
+     * Whether the cell contents should wrap or display on a single line and be concatenated.
+     */
     singleLine?: boolean;
+    /**
+     * Indent level for the cell. Each indent level adds 25px to the left padding.
+     */
     indentLevel?: number;
+    /**
+     * Width of the header item. Takes a string or a number representing the width in pixels.
+     */
     width?: number | string;
+    /**
+     * Class name to apply to cell.
+     */
     className?: string;
 }
 declare const _default: {

package/extract-react-types/table-tree-cell.tsx

@@ -0,0 +1,7 @@
+import { CellProps } from '../src/components/cell';
+
+const TableRows = function (props: CellProps) {
+  return null;
+};
+
+export default TableRows;

package/extract-react-types/table-tree-header.tsx

@@ -0,0 +1,20 @@
+/**
+ * This is hard-coded here because our actual <Header /> has no typings
+ * for its props.
+ *
+ * Adding types for real *might* break things so will need a little care.
+ *
+ * Defining it here for now lets us provide *something* without much headache.
+ */
+type HeaderProps = {
+  /**
+   * Width of the header item. Takes a string, or a number representing the width in pixels.
+   */
+  width?: string | number;
+};
+
+const TableHeader = function (props: HeaderProps) {
+  return null;
+};
+
+export default TableHeader;

package/extract-react-types/table-tree-row.tsx

@@ -0,0 +1,85 @@
+import { ReactNode } from 'react';
+
+import { Item } from './table-tree';
+
+/**
+ * This is hard-coded here because our actual <TableTree /> has no typings
+ * for its props.
+ *
+ * Adding types for real *might* break things so will need a little care.
+ *
+ * Defining it here for now lets us provide *something* without much headache.
+ */
+type RowProps = {
+  /**
+   * Whether the row has children
+   */
+  hasChildren?: boolean;
+  /**
+   * Children contained in the row. Should be one or more Cell components.
+   */
+  children?: React.ReactNode;
+  /**
+   * ID for the row item
+   */
+  itemId?: string;
+  // eslint-disable-next-line jsdoc/require-asterisk-prefix, jsdoc/check-alignment
+  /**
+    The data used to render the row and descendants. Pass down from `children` render prop.
+
+    In addition to these props, any other data can be added to the object, and it will
+    be provided as props when rendering each cell.
+   */
+  // eslint-disable-next-line @repo/internal/react/consistent-props-definitions
+  items?: Item[] | null;
+  /**
+   * Controls the expanded state of the row.
+   */
+  isExpanded?: ReactNode;
+  /**
+   * Sets the default expanded state of the row.
+   */
+  isDefaultExpanded?: ReactNode;
+  /**
+   * `aria-label` attached to the expand chevron button
+   */
+  expandLabel?: string;
+  /**
+   * `aria-label` attached to the collapse chevron button
+   */
+  collapseLabel?: string;
+  /**
+   * Callback called when row collapses.
+   */
+  onCollapse?: (data: Item) => void;
+  /**
+   * Callback called when row expands.
+   */
+  onExpand?: (data: Item) => void;
+  /**
+   * Children to render under row.
+   * Normally set by parent Item component and does not need to be configured.
+   */
+  renderChildren?: () => React.ReactNode;
+  /**
+   * Data to render. Passed down by Item and passed into onExpand and onCollapse callbacks.
+   * Normally set by parent Item component and does not need to be configured.
+   */
+  // eslint-disable-next-line @repo/internal/react/consistent-props-definitions
+  data?: Item;
+  /**
+   * Depth used for rendering indent.
+   * Normally set by parent Item component and does not need to be configured.
+   */
+  depth?: number;
+};
+
+const TableRow = function (props: RowProps) {
+  return null;
+};
+
+TableRow.defaultProps = {
+  isDefaultExpanded: false,
+};
+
+export default TableRow;

package/extract-react-types/table-tree-rows.tsx

@@ -0,0 +1,34 @@
+import { Item } from './table-tree';
+
+/**
+ * This is hard-coded here because our actual <Rows /> has no typings
+ * for its props.
+ *
+ * Adding types for real *might* break things so will need a little care.
+ *
+ * Defining it here for now lets us provide *something* without much headache.
+ */
+type RowsProps = {
+  // eslint-disable-next-line jsdoc/require-asterisk-prefix, jsdoc/check-alignment
+  /**
+    The data used to render the set of rows. Will be passed down via the `children` render prop.
+
+    In addition to these props, any other data can be added to the object, and it will
+    be provided as props when rendering each cell.
+   */
+  // eslint-disable-next-line @repo/internal/react/consistent-props-definitions
+  items?: Item[] | null;
+  /**
+   * Render function for child rows. Render props will contain an item from the
+   * `items` prop above.
+   */
+  render?: (item: Item) => React.ReactNode;
+};
+
+const TableRows = function (props: RowsProps) {
+  return null;
+};
+
+TableRows.defaultProps = {};
+
+export default TableRows;

package/extract-react-types/table-tree.tsx

@@ -2,9 +2,8 @@ import { ElementType, ReactNode } from 'react';
 
 class Content extends Object {}
 
-type Item = {
+export type Item = {
   id: string;
-  content: Content;
   hasChildren: boolean;
   children?: Item[];
 };
@@ -37,10 +36,12 @@ type TableTreeProps = {
    * The header text of the respective columns of the table.
    */
   headers?: string[];
+  // eslint-disable-next-line jsdoc/require-asterisk-prefix, jsdoc/check-alignment
   /**
-   * The data used to render the table.
-   * The type of `content` can be whatever you would like, and its value will be
-   * provided as props when rendering each cell.
+    The data used to render the table.
+
+    In addition to these props, any other data can be added, and it will
+    be provided as props when rendering each cell.
    */
   // eslint-disable-next-line @repo/internal/react/consistent-props-definitions
   items?: Item[] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/table-tree",
-  "version": "9.1.8",
+  "version": "9.1.9",
   "description": "A table tree is an expandable table for showing nested hierarchies of information.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"