@atlaskit/table-tree 9.10.5 → 9.11.1

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

@@ -3,8 +3,22 @@ type WithChildren<T> = T & {
     children?: T[] | null;
 };
 export interface RowsProps<T> {
+    /**
+     * 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.
+     */
     items?: WithChildren<T>[];
+    /**
+     * Render function for child rows. Render props will contain an item from the
+     * `items` prop above.
+     */
     render: (args: WithChildren<T>) => React.ReactNode;
+    /**
+     * This is an accessible name for the loading state's spinner.
+     * The default text is "Loading".
+     */
     loadingLabel?: string;
 }
 export default class Rows<T> extends Component<RowsProps<T>> {

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

@@ -1,5 +1,68 @@
-import { Component } from 'react';
+import { Component, type ElementType, type ReactNode } from 'react';
 import { type ColumnWidth } from './internal/context';
+import type Item from './internal/item';
+declare class Content extends Object {
+}
+/**
+ * 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.
+ */
+export type TableTreeProps = {
+    /**
+     * The contents of the table.
+     * Use this when composing `Cell`, `Header`, `Headers`, `Row`, and `Rows` components.
+     * For basic usage, it's simpler to specify table contents with the `items` prop instead.
+     */
+    children?: ReactNode;
+    /**
+     * Each column component is used to render the cells in that column.
+     * A cell's `content` value, specified in the data passed to `items`, is provided as props.
+     */
+    columns?: ElementType<Content>[];
+    /**
+     * The widths of the columns in the table.
+     */
+    columnWidths?: (string | number)[];
+    /**
+     * The header text of the columns of the table.
+     */
+    headers?: string[];
+    /**
+    Use this to set whether a row with children should expand when clicked anywhere within the row. If `false` or unset, a row with children will only expand when the chevron is clicked.
+
+    If your cells contain interactive elements, always set this to `false` to avoid unexpected expanding or collapsing.
+
+    If you aren’t using the `items` prop, `shouldExpandOnClick` should be used on the row component instead.
+   */
+    shouldExpandOnClick?: boolean;
+    /**
+    The data used to render the table. If you’re creating a basic table, use this prop instead of composing cell, header, headers, row, and rows components.
+
+    In addition to the `items` props, any other data can be added, and it will
+    be provided as props when rendering each cell.
+   */
+    items?: Item[] | null;
+    /**
+     * The value used to extend the expand or collapse button label in cases where `row` has child rows.
+     * It should be a string when we pass data via the `items` property, the value should be one of the `columns` names.
+     * It should be a number when we pass data via the `rows` component as children in the table tree.
+     */
+    mainColumnForExpandCollapseLabel?: string | number;
+    /**
+     * This is an `aria-label` attribute. Use the label to describe the table for assistive technologies.
+     * Usage of either this, or the `labelId` attribute is strongly recommended.
+     */
+    label?: string;
+    /**
+     * This is an `aria-labelledby` attribute. Pass an ID for the element which should define an accessible name for the table.
+     * Usage of either this, or the `label` attribute is strongly recommended.
+     */
+    referencedLabel?: string;
+};
 interface State {
     columnWidths: ColumnWidth[];
 }

package/dist/types/index.d.ts

@@ -5,6 +5,9 @@ export { default as Cell } from './components/cell';
 export { default as Rows } from './components/rows';
 export { default as Row } from './components/row';
 export { default as TableTreeDataHelper } from './utils/table-tree-data-helper';
+export type { TableTreeProps } from './components/table-tree';
+export type { HeaderProps } from './components/header';
+export type { RowsProps } from './components/rows';
+export type { RowProps } from './components/row';
 export type { CellWithColumnWidthProps } from './components/internal/with-column-width';
 export type { CellProps } from './components/cell';
-export type { RowsProps } from './components/rows';

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

@@ -1,3 +1,17 @@
 /// <reference types="react" />
+/**
+ * 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.
+ */
+export type HeaderProps = {
+    /**
+     * Width of the header item. Takes a string, or a number representing the width in pixels.
+     */
+    width?: string | number;
+};
 declare const Header: (props: any) => JSX.Element;
 export default Header;

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

@@ -1,7 +1,7 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
 import { Component } from 'react';
 import { jsx } from '@emotion/react';
 export default class Headers extends Component<any> {

package/dist/types-ts4.5/components/internal/common-cell.d.ts

@@ -1,7 +1,7 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
 import type { FC, HTMLAttributes, ReactNode } from 'react';
 interface CommonCellProps {
     indent?: string;

package/dist/types-ts4.5/components/internal/item.d.ts

@@ -1,7 +1,7 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
 import { Component } from 'react';
 import { jsx } from '@emotion/react';
 export default class Item extends Component<any> {

package/dist/types-ts4.5/components/internal/overflow-container.d.ts

@@ -1,7 +1,7 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
 import type { FC, HTMLAttributes, ReactNode } from 'react';
 interface OverflowContainerProps {
     isSingleLine?: boolean;

package/dist/types-ts4.5/components/internal/styled.d.ts

@@ -1,7 +1,7 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
 import type { FC, HTMLAttributes, ReactNode } from 'react';
 export declare const indentBase: "var(--ds-space-300)";
 /**

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

@@ -1,9 +1,92 @@
 /**
  * @jsxRuntime classic
+ * @jsx jsx
  */
-/** @jsx jsx */
-import React, { Component } from 'react';
+import React, { Component, type ReactNode } from 'react';
 import { jsx } from '@emotion/react';
+import type Item from './internal/item';
+/**
+ * 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.
+ */
+export 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;
+    /**
+    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.
+   */
+    items?: Item[] | null;
+    /**
+     * Controls the expanded state of the row.
+     */
+    isExpanded?: ReactNode;
+    /**
+     * Sets the default expanded state of the row.
+     */
+    isDefaultExpanded?: ReactNode;
+    /**
+     * This is the accessible name for the expand chevron button, used to tell assistive technology what the button is for.
+     */
+    expandLabel?: string;
+    /**
+     * This is the accessible name for the collapse chevron button, used to tell assistive technology what the button is for.
+     */
+    collapseLabel?: string;
+    /**
+     * Callback called when the row collapses.
+     */
+    onCollapse?: (data: Item) => void;
+    /**
+     * Callback called when the row expands.
+     */
+    onExpand?: (data: Item) => void;
+    /**
+     * Children to render under the row.
+     * This is normally set by the parent item component, and doesn't need to be configured.
+     */
+    renderChildren?: () => React.ReactNode;
+    /**
+    Use this to set whether a row with children should expand when clicked anywhere within the row. If `false` or unset, a row with children will only expand when the chevron is clicked.
+
+    If your cells contain interactive elements, always set this to `false` to avoid unexpected expanding or collapsing.
+   */
+    shouldExpandOnClick?: boolean;
+    /**
+     * Data to render. Passed down by `item` and passed into `onExpand` and `onCollapse` callbacks.
+     * This is normally set by the parent `item` component, and doesn't need to be configured.
+     */
+    data?: Item;
+    /**
+     * The depth used for rendering an indent.
+     * This is normally set by parent `item` component, and doesn't need to be configured.
+     */
+    depth?: number;
+    /**
+    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 the table tree. The value should be one of the property `columns` names in the table tree.
+
+    Should be a number  when we pass data via the `Rows` component as children in the table tree.
+   */
+    mainColumnForExpandCollapseLabel?: string | number;
+};
 declare class RowComponent extends Component<any, any> {
     state: {
         isExpanded: any;

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

@@ -3,8 +3,22 @@ type WithChildren<T> = T & {
     children?: T[] | null;
 };
 export interface RowsProps<T> {
+    /**
+     * 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.
+     */
     items?: WithChildren<T>[];
+    /**
+     * Render function for child rows. Render props will contain an item from the
+     * `items` prop above.
+     */
     render: (args: WithChildren<T>) => React.ReactNode;
+    /**
+     * This is an accessible name for the loading state's spinner.
+     * The default text is "Loading".
+     */
     loadingLabel?: string;
 }
 export default class Rows<T> extends Component<RowsProps<T>> {

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

@@ -1,5 +1,68 @@
-import { Component } from 'react';
+import { Component, type ElementType, type ReactNode } from 'react';
 import { type ColumnWidth } from './internal/context';
+import type Item from './internal/item';
+declare class Content extends Object {
+}
+/**
+ * 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.
+ */
+export type TableTreeProps = {
+    /**
+     * The contents of the table.
+     * Use this when composing `Cell`, `Header`, `Headers`, `Row`, and `Rows` components.
+     * For basic usage, it's simpler to specify table contents with the `items` prop instead.
+     */
+    children?: ReactNode;
+    /**
+     * Each column component is used to render the cells in that column.
+     * A cell's `content` value, specified in the data passed to `items`, is provided as props.
+     */
+    columns?: ElementType<Content>[];
+    /**
+     * The widths of the columns in the table.
+     */
+    columnWidths?: (string | number)[];
+    /**
+     * The header text of the columns of the table.
+     */
+    headers?: string[];
+    /**
+    Use this to set whether a row with children should expand when clicked anywhere within the row. If `false` or unset, a row with children will only expand when the chevron is clicked.
+
+    If your cells contain interactive elements, always set this to `false` to avoid unexpected expanding or collapsing.
+
+    If you aren’t using the `items` prop, `shouldExpandOnClick` should be used on the row component instead.
+   */
+    shouldExpandOnClick?: boolean;
+    /**
+    The data used to render the table. If you’re creating a basic table, use this prop instead of composing cell, header, headers, row, and rows components.
+
+    In addition to the `items` props, any other data can be added, and it will
+    be provided as props when rendering each cell.
+   */
+    items?: Item[] | null;
+    /**
+     * The value used to extend the expand or collapse button label in cases where `row` has child rows.
+     * It should be a string when we pass data via the `items` property, the value should be one of the `columns` names.
+     * It should be a number when we pass data via the `rows` component as children in the table tree.
+     */
+    mainColumnForExpandCollapseLabel?: string | number;
+    /**
+     * This is an `aria-label` attribute. Use the label to describe the table for assistive technologies.
+     * Usage of either this, or the `labelId` attribute is strongly recommended.
+     */
+    label?: string;
+    /**
+     * This is an `aria-labelledby` attribute. Pass an ID for the element which should define an accessible name for the table.
+     * Usage of either this, or the `label` attribute is strongly recommended.
+     */
+    referencedLabel?: string;
+};
 interface State {
     columnWidths: ColumnWidth[];
 }

package/dist/types-ts4.5/index.d.ts

@@ -5,6 +5,9 @@ export { default as Cell } from './components/cell';
 export { default as Rows } from './components/rows';
 export { default as Row } from './components/row';
 export { default as TableTreeDataHelper } from './utils/table-tree-data-helper';
+export type { TableTreeProps } from './components/table-tree';
+export type { HeaderProps } from './components/header';
+export type { RowsProps } from './components/rows';
+export type { RowProps } from './components/row';
 export type { CellWithColumnWidthProps } from './components/internal/with-column-width';
 export type { CellProps } from './components/cell';
-export type { RowsProps } from './components/rows';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/table-tree",
-	"version": "9.10.5",
+	"version": "9.11.1",
 	"description": "A table tree is an expandable table for showing nested hierarchies of information.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -27,12 +27,12 @@
 		"runReact18": true
 	},
 	"dependencies": {
-		"@atlaskit/analytics-next": "^9.3.0",
-		"@atlaskit/button": "^19.0.0",
-		"@atlaskit/icon": "^22.6.0",
+		"@atlaskit/analytics-next": "^10.0.0",
+		"@atlaskit/button": "^19.1.0",
+		"@atlaskit/icon": "^22.10.0",
 		"@atlaskit/spinner": "^16.2.0",
 		"@atlaskit/theme": "^12.11.0",
-		"@atlaskit/tokens": "^1.56.0",
+		"@atlaskit/tokens": "^1.57.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
 		"lodash": "^4.17.21"

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

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

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

@@ -1,20 +0,0 @@
-/**
- * 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

@@ -1,99 +0,0 @@
-import { type ReactNode } from 'react';
-
-import { type 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 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;
-	/**
-	 * This is the accessible name for the expand chevron button, used to tell assistive technology what the button is for.
-	 */
-	expandLabel?: string;
-	/**
-	 * This is the accessible name for the collapse chevron button, used to tell assistive technology what the button is for.
-	 */
-	collapseLabel?: string;
-	/**
-	 * Callback called when the row collapses.
-	 */
-	onCollapse?: (data: Item) => void;
-	/**
-	 * Callback called when the row expands.
-	 */
-	onExpand?: (data: Item) => void;
-	/**
-	 * Children to render under the row.
-	 * This is normally set by the parent item component, and doesn't need to be configured.
-	 */
-	renderChildren?: () => React.ReactNode;
-	/**
-    Use this to set whether a row with children should expand when clicked anywhere within the row. If `false` or unset, a row with children will only expand when the chevron is clicked.
-
-    If your cells contain interactive elements, always set this to `false` to avoid unexpected expanding or collapsing.
-   */
-	shouldExpandOnClick?: boolean;
-	/**
-	 * Data to render. Passed down by `item` and passed into `onExpand` and `onCollapse` callbacks.
-	 * This is normally set by the parent `item` component, and doesn't need to be configured.
-	 */
-	// eslint-disable-next-line @repo/internal/react/consistent-props-definitions
-	data?: Item;
-	/**
-	 * The depth used for rendering an indent.
-	 * This is normally set by parent `item` component, and doesn't need to be configured.
-	 */
-	depth?: number;
-	/**
-    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 the table tree. The value should be one of the property `columns` names in the table tree.
-
-    Should be a number  when we pass data via the `Rows` component as children in the table tree.
-   */
-	mainColumnForExpandCollapseLabel?: string | number;
-};
-
-const TableRow = function (props: RowProps) {
-	return null;
-};
-
-TableRow.defaultProps = {
-	isDefaultExpanded: false,
-};
-
-export default TableRow;

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

@@ -1,40 +0,0 @@
-import { type 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 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;
-	/* eslint-enable jsdoc/require-asterisk-prefix, jsdoc/check-alignment */
-	/**
-	 * This is an accessible name for the loading state's spinner.
-	 * The default text is "Loading".
-	 */
-	loadingLabel?: string | 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

@@ -1,76 +0,0 @@
-import { type ElementType, type ReactNode } from 'react';
-
-class Content extends Object {}
-
-export type Item = {
-	id: string;
-	hasChildren: boolean;
-	children?: Item[];
-};
-
-/**
- * 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 TableTreeProps = {
-	/**
-	 * The contents of the table.
-	 * Use this when composing `Cell`, `Header`, `Headers`, `Row`, and `Rows` components.
-	 * For basic usage, it's simpler to specify table contents with the `items` prop instead.
-	 */
-	children?: ReactNode;
-	/**
-	 * Each column component is used to render the cells in that column.
-	 * A cell's `content` value, specified in the data passed to `items`, is provided as props.
-	 */
-	columns?: ElementType<Content>[];
-	/**
-	 * The widths of the columns in the table.
-	 */
-	columnWidths?: (string | number)[];
-	/**
-	 * The header text of the columns of the table.
-	 */
-	headers?: string[];
-	/* eslint-disable jsdoc/require-asterisk-prefix, jsdoc/check-alignment */
-	/**
-    Use this to set whether a row with children should expand when clicked anywhere within the row. If `false` or unset, a row with children will only expand when the chevron is clicked.
-
-    If your cells contain interactive elements, always set this to `false` to avoid unexpected expanding or collapsing.
-
-    If you aren’t using the `items` prop, `shouldExpandOnClick` should be used on the row component instead.
-   */
-	shouldExpandOnClick?: boolean;
-	/**
-    The data used to render the table. If you’re creating a basic table, use this prop instead of composing cell, header, headers, row, and rows components.
-
-    In addition to the `items` 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;
-	/**
-	 * The value used to extend the expand or collapse button label in cases where `row` has child rows.
-	 * It should be a string when we pass data via the `items` property, the value should be one of the `columns` names.
-	 * It should be a number when we pass data via the `rows` component as children in the table tree.
-	 */
-	mainColumnForExpandCollapseLabel?: string | number;
-	/**
-	 * This is an `aria-label` attribute. Use the label to describe the table for assistive technologies.
-	 * Usage of either this, or the `labelId` attribute is strongly recommended.
-	 */
-	label?: string;
-	/**
-	 * This is an `aria-labelledby` attribute. Pass an ID for the element which should define an accessible name for the table.
-	 * Usage of either this, or the `label` attribute is strongly recommended.
-	 */
-	referencedLabel?: string;
-};
-
-export default function (props: TableTreeProps) {
-	return null;
-}