@atlaskit/table-tree 9.4.2 → 9.6.0

package/dist/types-ts4.5/components/internal/with-column-width.d.ts

@@ -1,64 +1,6 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 export interface CellWithColumnWidthProps {
-    width?: number | string;
+    width?: string | number;
     columnIndex?: number;
 }
-export default function withColumnWidth<T extends object>(Cell: React.ComponentType<T>): {
-    new (props: Readonly<T & CellWithColumnWidthProps>): {
-        UNSAFE_componentWillMount(): void;
-        setColumnWidth(width?: number | string): void;
-        UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<T & CellWithColumnWidthProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callBack?: (() => void) | undefined): void;
-        readonly props: Readonly<T & CellWithColumnWidthProps> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<{}>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<T & CellWithColumnWidthProps>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<T & CellWithColumnWidthProps>, prevState: Readonly<{}>, snapshot?: any): void;
-        componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): void;
-    };
-    new (props: T & CellWithColumnWidthProps, context?: any): {
-        UNSAFE_componentWillMount(): void;
-        setColumnWidth(width?: number | string): void;
-        UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-        render(): JSX.Element;
-        context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<T & CellWithColumnWidthProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
-        forceUpdate(callBack?: (() => void) | undefined): void;
-        readonly props: Readonly<T & CellWithColumnWidthProps> & Readonly<{
-            children?: React.ReactNode;
-        }>;
-        state: Readonly<{}>;
-        refs: {
-            [key: string]: React.ReactInstance;
-        };
-        componentDidMount?(): void;
-        shouldComponentUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): boolean;
-        componentWillUnmount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<T & CellWithColumnWidthProps>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<T & CellWithColumnWidthProps>, prevState: Readonly<{}>, snapshot?: any): void;
-        componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<T & CellWithColumnWidthProps>, nextState: Readonly<{}>, nextContext: any): void;
-    };
-    contextTypes: {
-        tableTree: PropTypes.Validator<object>;
-    };
-    contextType?: React.Context<any> | undefined;
-};
+export default function withColumnWidth<T extends object>(Cell: React.ComponentType<T>): (props: T & CellWithColumnWidthProps) => JSX.Element;

package/dist/types-ts4.5/components/row.d.ts

@@ -14,6 +14,7 @@ declare class Row extends Component<any, any> {
     onClickHandler: (e: React.MouseEvent) => void;
     onExpandToggle: () => void;
     isExpanded(): any;
+    getExtendedLabel: (cellContent: any, cellIndex: number, mainColumnForExpandCollapseLabel: string | number) => any;
     renderCell(cell: any, cellIndex: number): React.FunctionComponentElement<{
         key: number;
         columnIndex: number;

package/dist/types-ts4.5/components/table-tree.d.ts

@@ -1,23 +1,23 @@
-import { Component } from 'react';
-import PropTypes from 'prop-types';
+import React, { Component } from 'react';
+type ColumnWidth = string | number;
 interface State {
-    columnWidths: number[];
+    columnWidths: ColumnWidth[];
 }
+type TableTreeContext = {
+    setColumnWidth: (columnIndex: number, width: ColumnWidth) => void;
+    getColumnWidth: (columnIndex: number) => ColumnWidth | null;
+};
+/**
+ *
+ * Context provider which maintains the column widths and access methods for use in descendent table cells
+ * Enables composed table-tree implementations to e.g. set width on header cells only
+ */
+export declare const TableTreeContext: React.Context<TableTreeContext>;
 export default class TableTree extends Component<any, State> {
-    static childContextTypes: {
-        tableTree: PropTypes.Validator<object>;
-    };
     state: State;
     componentDidMount(): void;
-    setColumnWidth: (columnIndex: number, width: number) => void;
-    getColumnWidth: (columnIndex: any) => number | null;
-    getChildContext(): {
-        tableTree: {
-            columnWidths: number[];
-            setColumnWidth: (columnIndex: number, width: number) => void;
-            getColumnWidth: (columnIndex: any) => number | null;
-        };
-    };
+    setColumnWidth: (columnIndex: number, width: ColumnWidth) => void;
+    getColumnWidth: (columnIndex: any) => ColumnWidth | null;
     render(): JSX.Element;
 }
 export {};

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

@@ -79,6 +79,15 @@ type RowProps = {
    * Normally set by parent Item component and does not need to be configured.
    */
   depth?: number;
+  // eslint-disable-next-line jsdoc/require-asterisk-prefix, jsdoc/check-alignment
+  /**
+    Adds detail to the expand and collapse row button's aria label by appending the value from the given column. If you don't set this prop, the aria label will read out "Expand `itemId` row".
+
+    Should be a string when we pass data via `items` property in `<TableTree />`, value should be one of the property `columns` names in `<TableTree />`.
+
+    Should be a number  when we pass data via `<Rows />` component as children in `<TableTree />`.
+   */
+  mainColumnForExpandCollapseLabel?: string | number;
 };
 
 const TableRow = function (props: RowProps) {

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

@@ -54,6 +54,13 @@ type TableTreeProps = {
    */
   // eslint-disable-next-line @repo/internal/react/consistent-props-definitions
   items?: Item[] | null;
+  /**
+   * The value used to extend the expand or collapse button label in cases where `Row` has child rows.
+   *
+   * Should be a string when we pass data via `items` property, value should be one of the `columns` names.
+   * Should be a number when we pass data via `<Rows />` component as children in `<TableTree />`.
+   */
+  mainColumnForExpandCollapseLabel?: string | number;
 };
 
 export default function (props: TableTreeProps) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/table-tree",
-  "version": "9.4.2",
+  "version": "9.6.0",
   "description": "A table tree is an expandable table for showing nested hierarchies of information.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
   "homepage": "https://atlassian.design/components/table-tree/",
   "atlassian": {
     "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Table tree",
       "category": "Components"
@@ -36,15 +36,14 @@
   },
   "dependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
-    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/button": "^16.8.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.10.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
-    "lodash": "^4.17.21",
-    "prop-types": "^15.5.10"
+    "lodash": "^4.17.21"
   },
   "peerDependencies": {
     "react": "^16.8.0"
@@ -52,9 +51,9 @@
   "devDependencies": {
     "@atlaskit/docs": "*",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/empty-state": "^7.5.0",
+    "@atlaskit/empty-state": "^7.6.0",
     "@atlaskit/section-message": "^6.4.0",
-    "@atlaskit/select": "^16.2.0",
+    "@atlaskit/select": "^16.5.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/report.api.md

@@ -18,145 +18,18 @@
 /// <reference types="react" />
 
 import { Component } from 'react';
-import { Context } from 'react';
-import { ErrorInfo } from 'react';
 import { jsx } from '@emotion/react';
-import PropTypes from 'prop-types';
 import { default as React_2 } from 'react';
-import { ReactInstance } from 'react';
 import { ReactNode } from 'react';
-import { Validator } from 'prop-types';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 import { WithContextProps } from '@atlaskit/analytics-next';
 
 // @public (undocumented)
-export const Cell: {
-  new (props: Readonly<CellProps & CellWithColumnWidthProps>): {
-    UNSAFE_componentWillMount(): void;
-    setColumnWidth(width?: number | string | undefined): void;
-    UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-    render(): JSX.Element;
-    context: any;
-    setState<K extends never>(
-      state:
-        | ((
-            prevState: Readonly<{}>,
-            props: Readonly<CellProps & CellWithColumnWidthProps>,
-          ) => Pick<{}, K> | null | {})
-        | Pick<{}, K>
-        | null
-        | {},
-      callback?: (() => void) | undefined,
-    ): void;
-    forceUpdate(callBack?: (() => void) | undefined): void;
-    readonly props: Readonly<CellProps & CellWithColumnWidthProps> &
-      Readonly<{
-        children?: React_2.ReactNode;
-      }>;
-    state: Readonly<{}>;
-    refs: {
-      [key: string]: React_2.ReactInstance;
-    };
-    componentDidMount?(): void;
-    shouldComponentUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): boolean;
-    componentWillUnmount?(): void;
-    componentDidCatch?(error: Error, errorInfo: React_2.ErrorInfo): void;
-    getSnapshotBeforeUpdate?(
-      prevProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      prevState: Readonly<{}>,
-    ): any;
-    componentDidUpdate?(
-      prevProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      prevState: Readonly<{}>,
-      snapshot?: any,
-    ): void;
-    componentWillMount?(): void;
-    componentWillReceiveProps?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextContext: any,
-    ): void;
-    componentWillUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-  };
-  new (props: CellProps & CellWithColumnWidthProps, context?: any): {
-    UNSAFE_componentWillMount(): void;
-    setColumnWidth(width?: number | string | undefined): void;
-    UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-    render(): JSX.Element;
-    context: any;
-    setState<K extends never>(
-      state:
-        | ((
-            prevState: Readonly<{}>,
-            props: Readonly<CellProps & CellWithColumnWidthProps>,
-          ) => Pick<{}, K> | null | {})
-        | Pick<{}, K>
-        | null
-        | {},
-      callback?: (() => void) | undefined,
-    ): void;
-    forceUpdate(callBack?: (() => void) | undefined): void;
-    readonly props: Readonly<CellProps & CellWithColumnWidthProps> &
-      Readonly<{
-        children?: React_2.ReactNode;
-      }>;
-    state: Readonly<{}>;
-    refs: {
-      [key: string]: React_2.ReactInstance;
-    };
-    componentDidMount?(): void;
-    shouldComponentUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): boolean;
-    componentWillUnmount?(): void;
-    componentDidCatch?(error: Error, errorInfo: React_2.ErrorInfo): void;
-    getSnapshotBeforeUpdate?(
-      prevProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      prevState: Readonly<{}>,
-    ): any;
-    componentDidUpdate?(
-      prevProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      prevState: Readonly<{}>,
-      snapshot?: any,
-    ): void;
-    componentWillMount?(): void;
-    componentWillReceiveProps?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextContext: any,
-    ): void;
-    componentWillUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillUpdate?(
-      nextProps: Readonly<CellProps & CellWithColumnWidthProps>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-  };
-  contextTypes: {
-    tableTree: Validator<object>;
-  };
-  contextType?: React_2.Context<any> | undefined;
-};
+export const Cell: (props: CellProps & CellWithColumnWidthProps) => JSX.Element;
 
 // @public (undocumented)
 export interface CellProps {
+  children?: ReactNode;
   className?: string;
   indentLevel?: number;
   singleLine?: boolean;
@@ -172,130 +45,10 @@ export interface CellWithColumnWidthProps {
 }
 
 // @public (undocumented)
-export const Header: {
-  new (props: Readonly<any>): {
-    UNSAFE_componentWillMount(): void;
-    setColumnWidth(width?: number | string | undefined): void;
-    UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-    render(): JSX.Element;
-    context: any;
-    setState<K extends never>(
-      state:
-        | ((
-            prevState: Readonly<{}>,
-            props: Readonly<any>,
-          ) => Pick<{}, K> | null | {})
-        | Pick<{}, K>
-        | null
-        | {},
-      callback?: (() => void) | undefined,
-    ): void;
-    forceUpdate(callBack?: (() => void) | undefined): void;
-    readonly props: Readonly<any> &
-      Readonly<{
-        children?: ReactNode;
-      }>;
-    state: Readonly<{}>;
-    refs: {
-      [key: string]: ReactInstance;
-    };
-    componentDidMount?(): void;
-    shouldComponentUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): boolean;
-    componentWillUnmount?(): void;
-    componentDidCatch?(error: Error, errorInfo: ErrorInfo): void;
-    getSnapshotBeforeUpdate?(
-      prevProps: Readonly<any>,
-      prevState: Readonly<{}>,
-    ): any;
-    componentDidUpdate?(
-      prevProps: Readonly<any>,
-      prevState: Readonly<{}>,
-      snapshot?: any,
-    ): void;
-    componentWillMount?(): void;
-    componentWillReceiveProps?(
-      nextProps: Readonly<any>,
-      nextContext: any,
-    ): void;
-    componentWillUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-  };
-  new (props: any, context?: any): {
-    UNSAFE_componentWillMount(): void;
-    setColumnWidth(width?: number | string | undefined): void;
-    UNSAFE_componentWillReceiveProps(nextProps: CellWithColumnWidthProps): void;
-    render(): JSX.Element;
-    context: any;
-    setState<K extends never>(
-      state:
-        | ((
-            prevState: Readonly<{}>,
-            props: Readonly<any>,
-          ) => Pick<{}, K> | null | {})
-        | Pick<{}, K>
-        | null
-        | {},
-      callback?: (() => void) | undefined,
-    ): void;
-    forceUpdate(callBack?: (() => void) | undefined): void;
-    readonly props: Readonly<any> &
-      Readonly<{
-        children?: ReactNode;
-      }>;
-    state: Readonly<{}>;
-    refs: {
-      [key: string]: ReactInstance;
-    };
-    componentDidMount?(): void;
-    shouldComponentUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): boolean;
-    componentWillUnmount?(): void;
-    componentDidCatch?(error: Error, errorInfo: ErrorInfo): void;
-    getSnapshotBeforeUpdate?(
-      prevProps: Readonly<any>,
-      prevState: Readonly<{}>,
-    ): any;
-    componentDidUpdate?(
-      prevProps: Readonly<any>,
-      prevState: Readonly<{}>,
-      snapshot?: any,
-    ): void;
-    componentWillMount?(): void;
-    componentWillReceiveProps?(
-      nextProps: Readonly<any>,
-      nextContext: any,
-    ): void;
-    componentWillUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillUpdate?(
-      nextProps: Readonly<any>,
-      nextState: Readonly<{}>,
-      nextContext: any,
-    ): void;
-  };
-  contextTypes: {
-    tableTree: Validator<object>;
-  };
-  contextType?: Context<any> | undefined;
-};
+type ColumnWidth = number | string;
+
+// @public (undocumented)
+export const Header: (props: any) => JSX.Element;
 
 // @public (undocumented)
 class Headers_2 extends Component<any> {
@@ -332,31 +85,19 @@ export interface RowsProps<T> {
 // @public (undocumented)
 interface State {
   // (undocumented)
-  columnWidths: number[];
+  columnWidths: ColumnWidth[];
 }
 
 // @public (undocumented)
 class TableTree extends Component<any, State> {
-  // (undocumented)
-  static childContextTypes: {
-    tableTree: PropTypes.Validator<object>;
-  };
   // (undocumented)
   componentDidMount(): void;
   // (undocumented)
-  getChildContext(): {
-    tableTree: {
-      columnWidths: number[];
-      setColumnWidth: (columnIndex: number, width: number) => void;
-      getColumnWidth: (columnIndex: any) => null | number;
-    };
-  };
-  // (undocumented)
-  getColumnWidth: (columnIndex: any) => null | number;
+  getColumnWidth: (columnIndex: any) => ColumnWidth | null;
   // (undocumented)
   render(): JSX.Element;
   // (undocumented)
-  setColumnWidth: (columnIndex: number, width: number) => void;
+  setColumnWidth: (columnIndex: number, width: ColumnWidth) => void;
   // (undocumented)
   state: State;
 }

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,109 @@
+## API Report File for "@atlaskit/table-tree"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import { Component } from 'react';
+import { jsx } from '@emotion/react';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import { WithContextProps } from '@atlaskit/analytics-next';
+
+// @public (undocumented)
+export const Cell: (props: CellProps & CellWithColumnWidthProps) => JSX.Element;
+
+// @public (undocumented)
+export interface CellProps {
+    children?: ReactNode;
+    className?: string;
+    indentLevel?: number;
+    singleLine?: boolean;
+    width?: number | string;
+}
+
+// @public (undocumented)
+export interface CellWithColumnWidthProps {
+    // (undocumented)
+    columnIndex?: number;
+    // (undocumented)
+    width?: number | string;
+}
+
+// @public (undocumented)
+type ColumnWidth = number | string;
+
+// @public (undocumented)
+export const Header: (props: any) => JSX.Element;
+
+// @public (undocumented)
+class Headers_2 extends Component<any> {
+    // (undocumented)
+    render(): jsx.JSX.Element;
+}
+export { Headers_2 as Headers }
+
+// @public (undocumented)
+export const Row: React_2.ForwardRefExoticComponent<Pick<Pick<Omit<any, keyof WithAnalyticsEventsProps>, number | string | symbol> & React_2.RefAttributes<any> & WithContextProps, number | string | symbol> & React_2.RefAttributes<any>>;
+
+// @public (undocumented)
+export class Rows<T> extends Component<RowsProps<T>> {
+    // (undocumented)
+    render(): JSX.Element;
+}
+
+// @public (undocumented)
+export interface RowsProps<T> {
+    // (undocumented)
+    items?: WithChildren<T>[];
+    // (undocumented)
+    render: (args: WithChildren<T>) => React_2.ReactNode;
+}
+
+// @public (undocumented)
+interface State {
+    // (undocumented)
+    columnWidths: ColumnWidth[];
+}
+
+// @public (undocumented)
+class TableTree extends Component<any, State> {
+    // (undocumented)
+    componentDidMount(): void;
+    // (undocumented)
+    getColumnWidth: (columnIndex: any) => ColumnWidth | null;
+    // (undocumented)
+    render(): JSX.Element;
+    // (undocumented)
+    setColumnWidth: (columnIndex: number, width: ColumnWidth) => void;
+    // (undocumented)
+    state: State;
+}
+export default TableTree;
+
+// @public
+export class TableTreeDataHelper<T extends any = any> {
+    constructor({ key }?: {
+        key?: keyof T | undefined;
+    });
+    // (undocumented)
+    appendItems(items: T[], allItems?: T[], parentItem?: T | null): T[];
+    // (undocumented)
+    key: keyof T;
+    // (undocumented)
+    keysCache: any;
+    // (undocumented)
+    updateItems(items: T[], allItems?: T[], parentItem?: T | null): T[];
+}
+
+// @public (undocumented)
+type WithChildren<T> = T & {
+    children?: T[] | null;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```