@atlaskit/dynamic-table 14.3.1 → 14.4.2

package/dist/types/types.d.ts

@@ -1,14 +1,36 @@
-import React, { RefObject } from 'react';
+import React, { Ref } from 'react';
 import { UIAnalyticsEvent, WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import type { Size as SizeType } from '@atlaskit/spinner';
 export interface RowCellType {
+    /**
+     * Key to resolve sorting this cell in its column.
+     */
     key?: string | number;
+    /**
+     * The number of columns a cell should span. Defaults to 1, and maxes out at the total column width of the table.
+     */
     colSpan?: number;
+    /**
+     * The content of the cell.
+     */
     content?: React.ReactNode | string;
+    /**
+     * Hook for automated testing.
+     */
     testId?: string;
 }
 export interface I18nShape {
+    /**
+     * Accessible label applied to the previous page button in the pagination component.
+     */
     prev: string;
+    /**
+     * Accessible label applied to the next page button in the pagination component.
+     */
     next: string;
+    /**
+     * Accessible label applied to the current page button in the pagination component.
+     */
     label: string;
 }
 export interface StatelessProps extends WithAnalyticsEventsProps {
@@ -49,16 +71,18 @@ export interface StatelessProps extends WithAnalyticsEventsProps {
      * Controls how many rows should be displayed per page.
      */
     rowsPerPage?: number;
-    /** Total number of rows, in case of paginated data. Optional */
+    /**
+     * Total number of rows, in case of paginated data.
+     */
     totalRows?: number;
     /**
      * Callback fired when the table page has changed,
-     * useful when wanting to control dynamic table.
+     * useful when wanting to control the pagination of the table.
      */
     onSetPage?: (page: number, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
     /**
      * Callback fired when a column heading has been sorted,
-     * useful when wanting to control dynamic table.
+     * useful when wanting to control the sort order of the table.
      */
     onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
     /**
@@ -101,31 +125,29 @@ export interface StatelessProps extends WithAnalyticsEventsProps {
      */
     paginationi18n?: I18nShape;
     /**
-     * Will highlight a row(s) of the table.
+     * Will highlight a row(s) of the table. Should be used to draw attention to a row; not to indicate selection.
      */
     highlightedRowIndex?: number | number[];
     /**
-     A `testId` prop is provided for specified elements,
-     which is a unique string that appears as a data attribute
-     `data-testid` in the rendered code,
-     serving as a hook for automated tests.
-  
-     The value of `testId` is used to prefix `testId` props in given elements.
+      A `testId` prop is provided for specified elements,
+      which is a unique string that appears as a data attribute
+      `data-testid` in the rendered code, serving as a hook for automated tests.
   
-     * `${testId}--table` - Table.
-     * `${testId}--head` - Table header.
-     * `${testId}--head--{content of the cell}` - Table header cell can be identified by their content.
-     * `${testId}--row--{index - content of the first cell}` - Table row.
-     * `${testId}--body` - Table body.
-     * `${testId}--body--{content of the cell}` - Table body cell can be identified by their content.
-     * `${testId}--loadingSpinner` - The spinner overlaid when loading.
-     **/
+      The value of `testId` is used to prefix `testId` props in given elements.
+      + `${testId}--table` - Table.
+      + `${testId}--head` - Table header.
+      + `${testId}--head--{content of the cell}` - Table header cell can be identified by their content.
+      + `${testId}--row--{index - content of the first cell}` - Table row.
+      + `${testId}--body` - Table body.
+      + `${testId}--body--{content of the cell}` - Table body cell can be identified by their content.
+      + `${testId}--loadingSpinner` - The spinner overlaid when loading.
+     */
     testId?: string;
     /**
      * Used to provide a better description of the table for users with assistive technologies.
      * Rather than a screen reader speaking "Entering table", passing in an label
      * allows a custom message like "Entering Sample Numerical Data table".
-     **/
+     */
     label?: string;
 }
 export interface StatefulProps extends WithAnalyticsEventsProps {
@@ -238,43 +260,60 @@ export interface StatefulProps extends WithAnalyticsEventsProps {
      */
     highlightedRowIndex?: number | number[];
     /**
-     A `testId` prop is provided for specified elements,
-     which is a unique string that appears as a data attribute
-     `data-testid` in the rendered code,
-     serving as a hook for automated tests.
+      A `testId` prop is provided for specified elements,
+      which is a unique string that appears as a data attribute
+      `data-testid` in the rendered code, serving as a hook for automated tests.
   
-     The value of `testId` is used to prefix `testId` props in given elements.
-  
-     * `${testId}--table` - Table.
-     * `${testId}--head` - Table header.
-     * `${testId}--head--{content of the cell}` - Table header cell can be identified by their content.
-     * `${testId}--row--{index - content of the first cell}` - Table row.
-     * `${testId}--body` - Table body.
-     * `${testId}--body--{content of the cell}` - Table body cell can be identified by their content.
-     * `${testId}--loadingSpinner` - The spinner overlaid when loading.
-     **/
+      The value of `testId` is used to prefix `testId` props in given elements.
+      + `${testId}--table` - Table.
+      + `${testId}--head` - Table header.
+      + `${testId}--head--{content of the cell}` - Table header cell can be identified by their content.
+      + `${testId}--row--{index - content of the first cell}` - Table row.
+      + `${testId}--body` - Table body.
+      + `${testId}--body--{content of the cell}` - Table body cell can be identified by their content.
+      + `${testId}--loadingSpinner` - The spinner overlaid when loading.
+     */
     testId?: string;
     /**
      * Used to provide a better description of the table for users with assistive technologies.
      * Rather than a screen reader speaking "Entering table", passing in an label
      * allows a custom message like "Entering Sample Numerical Data table".
-     **/
+     */
     label?: string;
 }
 export interface RowType extends React.ComponentPropsWithoutRef<'tr'> {
     cells: Array<RowCellType>;
     key?: string;
+    /**
+     * A mouse handler to support interaction of a row.
+     */
     onClick?: React.MouseEventHandler;
+    /**
+     * A key event handler to support interaction of a row.
+     */
     onKeyPress?: React.KeyboardEventHandler;
+    /**
+     * Hook for automated testing.
+     */
     testId?: string;
-    innerRef?: RefObject<HTMLElement>;
+    ref?: Ref<HTMLTableRowElement>;
 }
+/**
+ * Enum style type to determine whether sort results are ascending or descending.
+ */
 export declare type SortOrderType = 'ASC' | 'DESC';
-export declare type SpinnerSizeType = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+/**
+ * Determines the size of the table loading spinner.
+ * This matches the underlying `Size` type in `@atlaskit/spinner`
+ */
+export declare type SpinnerSizeType = SizeType;
 export declare type LoadingSpinnerSizeType = 'small' | 'large';
 export interface HeadCellType extends RowCellType {
+    /** Whether the column the cell sits above is sortable. */
     isSortable?: boolean;
+    /** The pixel width of the cell. */
     width?: number;
+    /** Whether the text in the cell will truncate or not if constrained. */
     shouldTruncate?: boolean;
 }
 export interface RankEndLocation {

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@atlaskit/dynamic-table",
-  "version": "14.3.1",
-  "description": "A table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
+  "version": "14.4.2",
+  "description": "A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "homepage": "https://atlassian.design/components/dynamic-table/",
   "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -20,42 +21,48 @@
     "inPublicMirror": true,
     "releaseModel": "scheduled",
     "website": {
-      "name": "Dynamic Table"
+      "name": "Dynamic table"
     }
   },
   "dependencies": {
     "@atlaskit/analytics-next": "^8.0.0",
     "@atlaskit/pagination": "^14.0.0",
     "@atlaskit/spinner": "^15.0.0",
-    "@atlaskit/theme": "^11.3.0",
+    "@atlaskit/theme": "^12.0.0",
+    "@atlaskit/tokens": "^0.3.0",
     "@babel/runtime": "^7.0.0",
+    "@emotion/core": "^10.0.9",
     "react-beautiful-dnd": "^12.1.1"
   },
   "peerDependencies": {
     "react": "^16.8.0",
-    "react-dom": "^16.8.0",
-    "styled-components": "^3.2.6"
+    "react-dom": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/avatar": "^20.0.0",
+    "@atlaskit/avatar": "^20.5.0",
     "@atlaskit/build-utils": "*",
-    "@atlaskit/button": "^15.1.0",
+    "@atlaskit/button": "^16.0.0",
     "@atlaskit/docs": "*",
     "@atlaskit/dropdown-menu": "^10.1.0",
     "@atlaskit/ssr": "*",
-    "@atlaskit/toggle": "^12.2.0",
+    "@atlaskit/toggle": "^12.3.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
+    "@emotion/styled": "^10.0.7",
     "@testing-library/react": "^8.0.1",
     "enzyme": "^3.10.0",
     "react-dom": "^16.8.0",
+    "styled-components": "^3.2.6",
     "typescript": "3.9.6",
     "uuid": "^3.1.0"
   },
   "techstack": {
     "@atlassian/frontend": {
       "import-structure": "atlassian-conventions"
+    },
+    "@repo/internal": {
+      "theming": "tokens"
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"