@atlaskit/dynamic-table 14.4.0 → 14.4.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/dynamic-table
 
+## 14.4.1
+
+### Patch Changes
+
+- [`1601e51ab32`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1601e51ab32) - Fixes for internal types.
+
 ## 14.4.0
 
 ### Minor Changes

package/README.md

@@ -10,4 +10,4 @@ yarn add @atlaskit/dynamic-table
 
 ## Usage
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/core/dynamic-table).
+Detailed docs and example usage can be found [here](https://atlassian.design/components/dynamic-table/usage).

package/dist/cjs/components/Stateful.js

@@ -31,6 +31,32 @@ 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; } }
 
+/**
+ * __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}
+ *   />
+ *  );
+ * }
+ * ```
+ */
 var DynamicTable = /*#__PURE__*/function (_React$Component) {
   (0, _inherits2.default)(DynamicTable, _React$Component);
 

package/dist/cjs/components/Stateless.js

@@ -41,7 +41,7 @@ var _LoadingContainer = _interopRequireDefault(require("./LoadingContainer"));
 
 var _LoadingContainerAdvanced = _interopRequireDefault(require("./LoadingContainerAdvanced"));
 
-var _managedPagination = _interopRequireDefault(require("./managedPagination"));
+var _managedPagination = _interopRequireDefault(require("./managed-pagination"));
 
 var _Body2 = _interopRequireDefault(require("./rankable/Body"));
 
@@ -52,7 +52,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.4.0";
+var packageVersion = "14.4.1";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/cjs/internal/constants.js

@@ -3,18 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LOADING_CONTENTS_OPACITY = exports.XLARGE = exports.LARGE = exports.MEDIUM = exports.SMALL = exports.DESC = exports.ASC = void 0;
+exports.LOADING_CONTENTS_OPACITY = exports.LARGE = exports.SMALL = exports.DESC = exports.ASC = void 0;
 var ASC = 'ASC';
 exports.ASC = ASC;
 var DESC = 'DESC';
 exports.DESC = DESC;
 var SMALL = 'small';
 exports.SMALL = SMALL;
-var MEDIUM = 'medium';
-exports.MEDIUM = MEDIUM;
 var LARGE = 'large';
 exports.LARGE = LARGE;
-var XLARGE = 'xlarge';
-exports.XLARGE = XLARGE;
 var LOADING_CONTENTS_OPACITY = 0.22;
 exports.LOADING_CONTENTS_OPACITY = LOADING_CONTENTS_OPACITY;

package/dist/cjs/version.json

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

package/dist/es2019/components/Stateful.js

@@ -2,6 +2,33 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import React from 'react';
 import { reorderRows } from '../internal/helpers';
 import DynamicTableStateless from './Stateless';
+
+/**
+ * __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}
+ *   />
+ *  );
+ * }
+ * ```
+ */
 export default class DynamicTable extends React.Component {
   constructor(...args) {
     super(...args);

package/dist/es2019/components/Stateless.js

@@ -9,11 +9,11 @@ import { EmptyViewContainer, EmptyViewWithFixedHeight } from '../styled/EmptyBod
 import Body from './Body';
 import LoadingContainer from './LoadingContainer';
 import LoadingContainerAdvanced from './LoadingContainerAdvanced';
-import ManagedPagination from './managedPagination';
+import ManagedPagination from './managed-pagination';
 import RankableTableBody from './rankable/Body';
 import TableHead from './TableHead';
 const packageName = "@atlaskit/dynamic-table";
-const packageVersion = "14.4.0";
+const packageVersion = "14.4.1";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/es2019/internal/constants.js

@@ -1,7 +1,5 @@
 export const ASC = 'ASC';
 export const DESC = 'DESC';
 export const SMALL = 'small';
-export const MEDIUM = 'medium';
 export const LARGE = 'large';
-export const XLARGE = 'xlarge';
 export const LOADING_CONTENTS_OPACITY = 0.22;

package/dist/es2019/version.json

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

package/dist/esm/components/Stateful.js

@@ -14,6 +14,32 @@ import React from 'react';
 import { reorderRows } from '../internal/helpers';
 import DynamicTableStateless from './Stateless';
 
+/**
+ * __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}
+ *   />
+ *  );
+ * }
+ * ```
+ */
 var DynamicTable = /*#__PURE__*/function (_React$Component) {
   _inherits(DynamicTable, _React$Component);
 

package/dist/esm/components/Stateless.js

@@ -20,11 +20,11 @@ import { EmptyViewContainer, EmptyViewWithFixedHeight } from '../styled/EmptyBod
 import Body from './Body';
 import LoadingContainer from './LoadingContainer';
 import LoadingContainerAdvanced from './LoadingContainerAdvanced';
-import ManagedPagination from './managedPagination';
+import ManagedPagination from './managed-pagination';
 import RankableTableBody from './rankable/Body';
 import TableHead from './TableHead';
 var packageName = "@atlaskit/dynamic-table";
-var packageVersion = "14.4.0";
+var packageVersion = "14.4.1";
 
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {

package/dist/esm/internal/constants.js

@@ -1,7 +1,5 @@
 export var ASC = 'ASC';
 export var DESC = 'DESC';
 export var SMALL = 'small';
-export var MEDIUM = 'medium';
 export var LARGE = 'large';
-export var XLARGE = 'xlarge';
 export var LOADING_CONTENTS_OPACITY = 0.22;

package/dist/esm/version.json

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

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

@@ -1,13 +1,13 @@
 import React from 'react';
-import { SpinnerSizeType } from '../types';
-interface Props {
+import type { SpinnerSizeType } from '../types';
+interface LoadingContainerProps {
     children: React.ReactNode;
     isLoading?: boolean;
     spinnerSize?: SpinnerSizeType;
     contentsOpacity: number;
     testId?: string;
 }
-export default class LoadingContainer extends React.Component<Props, {}> {
+export default class LoadingContainer extends React.Component<LoadingContainerProps> {
     static defaultProps: {
         isLoading: boolean;
         spinnerSize: string;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SpinnerSizeType } from '../types';
+import type { SpinnerSizeType } from '../types';
 export interface Props {
     children: React.ReactElement<any>;
     isLoading?: boolean;

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

@@ -7,6 +7,32 @@ interface State {
     sortOrder?: SortOrderType;
     rows?: RowType[];
 }
+/**
+ * __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}
+ *   />
+ *  );
+ * }
+ * ```
+ */
 export default class DynamicTable extends React.Component<StatefulProps, State> {
     static defaultProps: {
         defaultPage: number;

package/dist/types/components/{managedPagination.d.ts → managed-pagination.d.ts}

@@ -1,16 +1,13 @@
 import React from 'react';
 import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
-interface Props {
+import type { I18nShape } from '../types';
+interface ManagedPaginationProps {
     value?: number;
     onChange: (newValue: any, analyticsEvent?: UIAnalyticsEvent) => void;
     total: number;
-    i18n?: {
-        next: string;
-        prev: string;
-        label: string;
-    };
+    i18n?: I18nShape;
 }
-export default class ManagedPagination extends React.Component<Props> {
+export default class ManagedPagination extends React.Component<ManagedPaginationProps> {
     onChange: (_event: any, newValue: any, analyticsEvent?: UIAnalyticsEvent | undefined) => void;
     render(): JSX.Element;
 }

package/dist/types/internal/constants.d.ts

@@ -1,7 +1,5 @@
 export declare const ASC = "ASC";
 export declare const DESC = "DESC";
 export declare const SMALL = "small";
-export declare const MEDIUM = "medium";
 export declare const LARGE = "large";
-export declare const XLARGE = "xlarge";
 export declare const LOADING_CONTENTS_OPACITY = 0.22;

package/dist/types/types.d.ts

@@ -1,14 +1,36 @@
 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.
-  
-     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.
-     **/
+     * 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?: 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;
     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.4.0",
-  "description": "A table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
+  "version": "14.4.1",
+  "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,7 +21,7 @@
     "inPublicMirror": true,
     "releaseModel": "scheduled",
     "website": {
-      "name": "Dynamic Table"
+      "name": "Dynamic table"
     }
   },
   "dependencies": {