@atlaskit/dynamic-table 14.8.4 → 14.8.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/dynamic-table
 
+## 14.8.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.8.4
 
 ### Patch Changes

package/dist/cjs/components/stateless.js

@@ -54,7 +54,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/dynamic-table";
-var packageVersion = "14.8.4";
+var packageVersion = "14.8.5";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dynamic-table",
-	"version": "14.8.4",
+	"version": "14.8.5",
 	"sideEffects": false
 }

package/dist/es2019/components/stateless.js

@@ -14,7 +14,7 @@ import ManagedPagination from './managed-pagination';
 import RankableTableBody from './rankable/body';
 import TableHead from './table-head';
 const packageName = "@atlaskit/dynamic-table";
-const packageVersion = "14.8.4";
+const packageVersion = "14.8.5";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dynamic-table",
-	"version": "14.8.4",
+	"version": "14.8.5",
 	"sideEffects": false
 }

package/dist/esm/components/stateless.js

@@ -25,7 +25,7 @@ import ManagedPagination from './managed-pagination';
 import RankableTableBody from './rankable/body';
 import TableHead from './table-head';
 var packageName = "@atlaskit/dynamic-table";
-var packageVersion = "14.8.4";
+var packageVersion = "14.8.5";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dynamic-table",
-	"version": "14.8.4",
+	"version": "14.8.5",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/dynamic-table",
-  "version": "14.8.4",
+  "version": "14.8.5",
   "description": "A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -13,14 +13,6 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "dist/types-ts4.0/*",
-        "dist/types-ts4.0/index.d.ts"
-      ]
-    }
-  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
@@ -37,9 +29,9 @@
     "@atlaskit/analytics-next": "^8.0.0",
     "@atlaskit/ds-lib": "^2.1.0",
     "@atlaskit/pagination": "^14.2.0",
-    "@atlaskit/spinner": "^15.0.0",
+    "@atlaskit/spinner": "^15.2.0",
     "@atlaskit/theme": "^12.2.0",
-    "@atlaskit/tokens": "^0.10.0",
+    "@atlaskit/tokens": "^0.11.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "react-beautiful-dnd": "^12.1.1"
@@ -50,7 +42,7 @@
   },
   "devDependencies": {
     "@atlaskit/avatar": "^21.1.0",
-    "@atlaskit/button": "^16.3.0",
+    "@atlaskit/button": "^16.4.0",
     "@atlaskit/docs": "*",
     "@atlaskit/dropdown-menu": "^11.5.0",
     "@atlaskit/ssr": "*",

package/report.api.md

@@ -1,10 +1,14 @@
-## API Report File for "@atlaskit/dynamic-table".
+## API Report File for "@atlaskit/dynamic-table"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
-````ts
+```ts
 import noop from '@atlaskit/ds-lib/noop';
 import { default as React_2 } from 'react';
 import { Ref } from 'react';
@@ -12,33 +16,9 @@ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 import { WithContextProps } from '@atlaskit/analytics-next';
 
-/**
- * __Dynamic Table__
- *
- * A table displays rows of data with built-in pagination, sorting, and re-ordering functionality.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- *
- * @example
- * ```jsx
- * import DynamicTable from '@atlaskit/dynamic-table';
- *
- * export default function TableUncontrolled() {
- *  return (
- *   <DynamicTable
- *    head={head}
- *    rows={rows}
- *    rowsPerPage={10}
- *    defaultPage={1}
- *    loadingSpinnerSize="large"
- *    isLoading={false}
- *   />
- *  );
- * }
- * ```
- */
-declare class DynamicTable extends React_2.Component<StatefulProps, State> {
+// @public
+class DynamicTable extends React_2.Component<StatefulProps, State> {
+  // (undocumented)
   static defaultProps: {
     defaultPage: number;
     isLoading: boolean;
@@ -48,28 +28,36 @@ declare class DynamicTable extends React_2.Component<StatefulProps, State> {
     onSort: typeof noop;
     rowsPerPage: number;
   };
-  state: {
-    page: number | undefined;
-    sortKey: string | undefined;
-    sortOrder: SortOrderType | undefined;
-    rows: RowType[] | undefined;
-  };
-  UNSAFE_componentWillReceiveProps(newProps: StatefulProps): void;
+  // (undocumented)
+  onRankEnd: (params: RankEnd) => void;
+  // (undocumented)
+  onRankEndIfExists: (params: RankEnd) => void;
+  // (undocumented)
   onSetPage: (
     page: number,
     analyticsEvent?: UIAnalyticsEvent | undefined,
   ) => void;
+  // (undocumented)
   onSort: (
     { key, item, sortOrder }: any,
     analyticsEvent?: UIAnalyticsEvent | undefined,
   ) => void;
-  onRankEndIfExists: (params: RankEnd) => void;
-  onRankEnd: (params: RankEnd) => void;
+  // (undocumented)
   render(): JSX.Element;
+  // (undocumented)
+  state: {
+    page: number | undefined;
+    sortKey: string | undefined;
+    sortOrder: SortOrderType | undefined;
+    rows: RowType[] | undefined;
+  };
+  // (undocumented)
+  UNSAFE_componentWillReceiveProps(newProps: StatefulProps): void;
 }
 export default DynamicTable;
 
-export declare const DynamicTableStateless: React_2.ForwardRefExoticComponent<
+// @public (undocumented)
+export const DynamicTableStateless: React_2.ForwardRefExoticComponent<
   Pick<
     Pick<
       Omit<StatelessProps, keyof WithAnalyticsEventsProps>,
@@ -89,8 +77,8 @@ export declare const DynamicTableStateless: React_2.ForwardRefExoticComponent<
       Partial<
         Pick<
           Omit<StatelessProps, keyof WithAnalyticsEventsProps>,
-          | 'isFixedSize'
           | 'page'
+          | 'isFixedSize'
           | 'rowsPerPage'
           | 'isLoading'
           | 'isRankingDisabled'
@@ -130,9 +118,9 @@ export declare const DynamicTableStateless: React_2.ForwardRefExoticComponent<
     | 'head'
     | 'label'
     | 'key'
+    | 'page'
     | 'isFixedSize'
     | 'rows'
-    | 'page'
     | 'rowsPerPage'
     | 'sortKey'
     | 'sortOrder'
@@ -155,361 +143,149 @@ export declare const DynamicTableStateless: React_2.ForwardRefExoticComponent<
     React_2.RefAttributes<any>
 >;
 
-declare interface HeadCellType extends RowCellType {
-  /**
-   * Whether the column the cell sits above is sortable.
-   */
+// @public (undocumented)
+interface HeadCellType extends RowCellType {
   isSortable?: boolean;
-  /**
-   * The width of the cell as a percentage.
-   */
-  width?: number;
-  /**
-   * Whether the text in the cell will truncate or not if constrained.
-   */
   shouldTruncate?: boolean;
+  width?: number;
 }
 
-declare interface HeadType {
+// @public (undocumented)
+interface HeadType {
+  // (undocumented)
   cells: Array<HeadCellType>;
 }
 
-declare 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.
-   */
+// @public (undocumented)
+interface I18nShape {
   label: string;
+  next: string;
+  prev: string;
 }
 
-declare type LoadingSpinnerSizeType = 'small' | 'large';
+// @public (undocumented)
+type LoadingSpinnerSizeType = 'small' | 'large';
 
-declare interface RankEnd {
+// @public (undocumented)
+interface RankEnd {
+  // (undocumented)
+  destination?: RankEndLocation;
+  // (undocumented)
   sourceIndex: number;
+  // (undocumented)
   sourceKey: string;
-  destination?: RankEndLocation;
 }
 
-declare interface RankEndLocation {
-  index: number;
+// @public (undocumented)
+interface RankEndLocation {
+  // (undocumented)
   afterKey?: string;
+  // (undocumented)
   beforeKey?: string;
+  // (undocumented)
+  index: number;
 }
 
-declare interface RankStart {
+// @public (undocumented)
+interface RankStart {
+  // (undocumented)
   index: number;
+  // (undocumented)
   key: string;
 }
 
-declare 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.
-   */
+// @public (undocumented)
+interface RowCellType {
   colSpan?: number;
-  /**
-   * The content of the cell.
-   */
   content?: React_2.ReactNode | string;
-  /**
-   * Hook for automated testing.
-   */
+  key?: string | number;
   testId?: string;
 }
 
-declare interface RowType extends React_2.ComponentPropsWithoutRef<'tr'> {
+// @public (undocumented)
+interface RowType extends React_2.ComponentPropsWithoutRef<'tr'> {
+  // (undocumented)
   cells: Array<RowCellType>;
+  isHighlighted?: boolean;
+  // (undocumented)
   key?: string;
-  /**
-   * A mouse handler to support interaction of a row.
-   */
   onClick?: React_2.MouseEventHandler;
-  /**
-   * A key event handler to support interaction of a row.
-   */
   onKeyPress?: React_2.KeyboardEventHandler;
-  /**
-   * Highlights the row. Should be used to draw attention to a row; not to indicate selection.
-   */
-  isHighlighted?: boolean;
-  /**
-   * Hook for automated testing.
-   */
-  testId?: string;
+  // (undocumented)
   ref?: Ref<HTMLTableRowElement>;
+  testId?: string;
 }
 
-/**
- * Enum style type to determine whether sort results are ascending or descending.
- */
-declare type SortOrderType = 'ASC' | 'DESC';
+// @public
+type SortOrderType = 'ASC' | 'DESC';
 
-declare interface State {
+// @public (undocumented)
+interface State {
+  // (undocumented)
   page?: number;
+  // (undocumented)
+  rows?: RowType[];
+  // (undocumented)
   sortKey?: string;
+  // (undocumented)
   sortOrder?: SortOrderType;
-  rows?: RowType[];
 }
 
-declare interface StatefulProps extends WithAnalyticsEventsProps {
-  /**
-   * Caption for the table styled as a heading.
-   */
+// @public (undocumented)
+interface StatefulProps extends WithAnalyticsEventsProps {
   caption?: React_2.ReactNode;
-  /**
-   * Cells to be placed in the head of the table.
-   * Each element in the head creates a new column.
-   */
-  head?: HeadType;
-  /**
-   * Rows to be placed in the table.
-   * Each row contains cells which should map to the ones defined in the head.
-   * Rows accept standard HTML <tr> props in addition to those listed below.
-   * Ensure each cell has a unique `key` per column - this is used for both React's reconciliation of lists and column sorting.
-   */
-  rows?: Array<RowType>;
-  /**
-   * Shown when the table has no content.
-   */
-  emptyView?: React_2.ReactElement<any>;
-  /**
-   * Configuration of the loading spinner shown when `isLoading` is true.
-   * Defaults to `"large"` when a page has more than two rows, else `"small"`.
-   */
-  loadingSpinnerSize?: LoadingSpinnerSizeType;
-  /**
-   * Displays a loading spinner overlaid on top of the current page.
-   */
-  isLoading?: boolean;
-  /**
-   * Displays columns as their initial width regardless of the content that loads in.
-   */
-  isFixedSize?: boolean;
-  /**
-   * Controls how many rows should be displayed per page. If set, also turns on pagination, if there is more than one page to show.
-   */
-  rowsPerPage?: number;
-  /**
-   * Callback fired when the table page has changed,
-   * useful when wanting to control dynamic table.
-   */
-  onSetPage?: (page: number, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
-  /**
-   * Callback fired when a column heading has been sorted,
-   * useful when wanting to control dynamic table.
-   */
-  onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
-  /**
-   * Callback fired when the rows displayed on a page have changed.
-   */
-  onPageRowsUpdate?: (pageRows: Array<RowType>) => void;
-  /**
-   * Page the table should show.
-   * Useful when wanting to control dynamic table.
-   */
-  page?: number;
-  /**
-   * Default page dynamic table should show when initially rendering.
-   */
   defaultPage?: number;
-  /**
-   * Column key that the rows should be sorted by.
-   * Corresponds to the `key`'s defined in the `head` prop.
-   * Useful when wanting to control dynamic table.
-   */
-  sortKey?: string;
-  /**
-   * Default column sort key that the rows should be sorted by.
-   * Corresponds to the `key`'s defined in the `head` prop.
-   */
   defaultSortKey?: string;
-  /**
-   * Column sort order.
-   * Useful when wanting to control dynamic table.
-   */
-  sortOrder?: SortOrderType;
-  /**
-   * Default column sort order used when initially rendering.
-   * Defaults to `"ASC"`.
-   */
   defaultSortOrder?: SortOrderType;
-  /**
-   * Enables drag & drop sorting of table rows.
-   */
+  emptyView?: React_2.ReactElement<any>;
+  head?: HeadType;
+  highlightedRowIndex?: number | number[];
+  isFixedSize?: boolean;
+  isLoading?: boolean;
   isRankable?: boolean;
-  /**
-   * Disables being able to drop rows on the table.
-   * Drag will still function.
-   */
   isRankingDisabled?: boolean;
-  /**
-   * Callback fired when a drag of a row has started.
-   */
-  onRankStart?: (rankStart: RankStart) => void;
-  /**
-   * Callback fired when a drop of a row has completed.
-   */
+  label?: string;
+  loadingSpinnerSize?: LoadingSpinnerSizeType;
+  onPageRowsUpdate?: (pageRows: Array<RowType>) => void;
   onRankEnd?: (rankEnd: RankEnd) => void;
-  /**
-   * Labels for the previous and next buttons used in pagination.
-   * Defaults to `"previous"` and `"next"`.
-   */
+  onRankStart?: (rankStart: RankStart) => void;
+  onSetPage?: (page: number, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
+  onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
+  page?: number;
   paginationi18n?: I18nShape;
-  /**
-   * Will highlight a row(s) of the table.
-   */
-  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.
-   *  - `{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}--pagination` - The table pagination.
-   */
+  rows?: Array<RowType>;
+  rowsPerPage?: number;
+  sortKey?: string;
+  sortOrder?: SortOrderType;
   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;
 }
 
-declare interface StatelessProps extends WithAnalyticsEventsProps {
-  /**
-   * Caption for the table styled as a heading.
-   */
+// @public (undocumented)
+interface StatelessProps extends WithAnalyticsEventsProps {
   caption?: React_2.ReactNode;
-  /**
-   * Cells to be placed in the head of the table.
-   * Each element in the head creates a new column.
-   */
-  head?: HeadType;
-  /**
-   * Rows to be placed in the table.
-   * Each row contains cells which should map to the ones defined in the head.
-   *
-   * Ensure each cell has a unique `key` per column - this is used for both Reacts reconcilation of lists and column sorting.
-   */
-  rows?: Array<RowType>;
-  /**
-   * Shown when the table has no content.
-   */
   emptyView?: React_2.ReactElement<any>;
-  /**
-   * Configuration of the loading spinner shown when `isLoading` is true.
-   * Defaults to `"large"` when a page has more than two rows, else `"small"`.
-   */
-  loadingSpinnerSize?: LoadingSpinnerSizeType;
-  /**
-   * Displays a loading spinner overlaid on top of the current page.
-   */
-  isLoading?: boolean;
-  /**
-   * Displays columns as their initial width regardless of the content that loads in.
-   */
+  head?: HeadType;
+  highlightedRowIndex?: number | number[];
   isFixedSize?: boolean;
-  /**
-   * Controls how many rows should be displayed per page.
-   */
-  rowsPerPage?: number;
-  /**
-   * Total number of rows, in case of paginated data.
-   */
-  totalRows?: number;
-  /**
-   * Callback fired when the table page has changed,
-   * useful when wanting to control the pagination of the table.
-   */
+  isLoading?: boolean;
+  isRankable?: boolean;
+  isRankingDisabled?: boolean;
+  label?: string;
+  loadingSpinnerSize?: LoadingSpinnerSizeType;
+  onPageRowsUpdate?: (pageRows: Array<RowType>) => void;
+  onRankEnd?: (rankEnd: RankEnd, uiAnalyticsEvent?: UIAnalyticsEvent) => void;
+  onRankStart?: (rankStart: RankStart) => void;
   onSetPage?: (page: number, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
-  /**
-   * Callback fired when a column heading has been sorted,
-   * useful when wanting to control the sort order of the table.
-   */
   onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
-  /**
-   * Callback fired when the rows displayed on a page have changed.
-   */
-  onPageRowsUpdate?: (pageRows: Array<RowType>) => void;
-  /**
-   * Page the table should show. Set by default to 1, so never undefined.
-   */
   page?: number;
-  /**
-   * Column key that the rows should be sorted by.
-   * Corresponds to the `key`'s defined in the `head` prop.
-   */
+  paginationi18n?: I18nShape;
+  rows?: Array<RowType>;
+  rowsPerPage?: number;
   sortKey?: string;
-  /**
-   * Column sort order.
-   */
   sortOrder?: SortOrderType;
-  /**
-   * Enables drag & drop sorting of table rows.
-   */
-  isRankable?: boolean;
-  /**
-   * Disables being able to drop rows on the table.
-   * Drag will still function.
-   */
-  isRankingDisabled?: boolean;
-  /**
-   * Callback fired when a drag of a row has started.
-   */
-  onRankStart?: (rankStart: RankStart) => void;
-  /**
-   * Callback fired when a drop of a row has completed.
-   */
-  onRankEnd?: (rankEnd: RankEnd, uiAnalyticsEvent?: UIAnalyticsEvent) => void;
-  /**
-   * Labels for the pagination wrapper, previous and next buttons used in pagination.
-   * Defaults to `"pagination"`, `"previous"` and `"next"`.
-   */
-  paginationi18n?: I18nShape;
-  /**
-   * 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.
-   *  - `{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}--pagination` - The table pagination.
-   */
   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;
+  totalRows?: number;
 }
 
-export {};
-````
+// (No @packageDocumentation comment for this package)
+```