@atlaskit/dynamic-table 14.9.2 → 14.10.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/dynamic-table
 
+## 14.10.0
+
+### Minor Changes
+
+- [`12d9c63d4c1`](https://bitbucket.org/atlassian/atlassian-frontend/commits/12d9c63d4c1) - [ux] pass pageLabel to dynamic-table component and updat prev label in examples, add description in the types file, update example files
+
+### Patch Changes
+
+- Updated dependencies
+
+## 14.9.3
+
+### Patch Changes
+
+- [`77766ad157d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/77766ad157d) - Enrol packages to push-model consumption in Jira.
+
 ## 14.9.2
 
 ### Patch Changes

package/dist/cjs/components/loading-container-advanced.js

@@ -23,6 +23,9 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 // there is a bug with findDOMNode and Suspense in React < 16.9: https://github.com/facebook/react/issues/14188
 var safeFindDOMNode = function safeFindDOMNode(component) {
   try {
+    // DSP-10519 TODO: ReactDOM.findDOMNode is deprecated in React18, consider using alternative solution
+    // https://react.dev/reference/react-dom/findDOMNode#alternatives
+    // eslint-disable-next-line react/no-find-dom-node
     return (0, _reactDom.findDOMNode)(component);
   } catch (e) {
     return null;

package/dist/cjs/components/managed-pagination.js

@@ -52,6 +52,7 @@ var ManagedPagination = /*#__PURE__*/function (_React$Component) {
         label: i18n === null || i18n === void 0 ? void 0 : i18n.label,
         nextLabel: i18n === null || i18n === void 0 ? void 0 : i18n.next,
         previousLabel: i18n === null || i18n === void 0 ? void 0 : i18n.prev,
+        pageLabel: i18n === null || i18n === void 0 ? void 0 : i18n.pageLabel,
         onChange: this.onChange,
         pages: pages,
         testId: testId && "".concat(testId, "--pagination")

package/dist/cjs/components/stateless.js

@@ -29,7 +29,7 @@ var _tableHead = _interopRequireDefault(require("./table-head"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 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.9.2";
+var packageVersion = "14.10.0";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case _constants.DESC:
@@ -265,9 +265,10 @@ exports.DynamicTableWithoutAnalytics = DynamicTable;
   onRankStart: _noop.default,
   onRankEnd: _noop.default,
   paginationi18n: {
-    prev: 'Prev',
+    prev: 'Previous',
     next: 'Next',
-    label: 'Pagination'
+    label: 'Pagination',
+    pageLabel: 'Page'
   }
 });
 var createAndFireEventOnAtlaskit = (0, _analyticsNext.createAndFireEvent)('atlaskit');

package/dist/cjs/version.json

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

package/dist/es2019/components/loading-container-advanced.js

@@ -8,6 +8,9 @@ import { Container, SpinnerBackdrop, SpinnerContainer } from '../styled/loading-
 // there is a bug with findDOMNode and Suspense in React < 16.9: https://github.com/facebook/react/issues/14188
 const safeFindDOMNode = component => {
   try {
+    // DSP-10519 TODO: ReactDOM.findDOMNode is deprecated in React18, consider using alternative solution
+    // https://react.dev/reference/react-dom/findDOMNode#alternatives
+    // eslint-disable-next-line react/no-find-dom-node
     return findDOMNode(component);
   } catch (e) {
     return null;

package/dist/es2019/components/managed-pagination.js

@@ -24,6 +24,7 @@ export default class ManagedPagination extends React.Component {
       label: i18n === null || i18n === void 0 ? void 0 : i18n.label,
       nextLabel: i18n === null || i18n === void 0 ? void 0 : i18n.next,
       previousLabel: i18n === null || i18n === void 0 ? void 0 : i18n.prev,
+      pageLabel: i18n === null || i18n === void 0 ? void 0 : i18n.pageLabel,
       onChange: this.onChange,
       pages: pages,
       testId: testId && `${testId}--pagination`

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.9.2";
+const packageVersion = "14.10.0";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case DESC:
@@ -236,9 +236,10 @@ _defineProperty(DynamicTable, "defaultProps", {
   onRankStart: noop,
   onRankEnd: noop,
   paginationi18n: {
-    prev: 'Prev',
+    prev: 'Previous',
     next: 'Next',
-    label: 'Pagination'
+    label: 'Pagination',
+    pageLabel: 'Page'
   }
 });
 export { DynamicTable as DynamicTableWithoutAnalytics };

package/dist/es2019/version.json

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

package/dist/esm/components/loading-container-advanced.js

@@ -17,6 +17,9 @@ import { Container, SpinnerBackdrop, SpinnerContainer } from '../styled/loading-
 // there is a bug with findDOMNode and Suspense in React < 16.9: https://github.com/facebook/react/issues/14188
 var safeFindDOMNode = function safeFindDOMNode(component) {
   try {
+    // DSP-10519 TODO: ReactDOM.findDOMNode is deprecated in React18, consider using alternative solution
+    // https://react.dev/reference/react-dom/findDOMNode#alternatives
+    // eslint-disable-next-line react/no-find-dom-node
     return findDOMNode(component);
   } catch (e) {
     return null;

package/dist/esm/components/managed-pagination.js

@@ -45,6 +45,7 @@ var ManagedPagination = /*#__PURE__*/function (_React$Component) {
         label: i18n === null || i18n === void 0 ? void 0 : i18n.label,
         nextLabel: i18n === null || i18n === void 0 ? void 0 : i18n.next,
         previousLabel: i18n === null || i18n === void 0 ? void 0 : i18n.prev,
+        pageLabel: i18n === null || i18n === void 0 ? void 0 : i18n.pageLabel,
         onChange: this.onChange,
         pages: pages,
         testId: testId && "".concat(testId, "--pagination")

package/dist/esm/components/stateless.js

@@ -22,7 +22,7 @@ import ManagedPagination from './managed-pagination';
 import RankableTableBody from './rankable/body';
 import TableHead from './table-head';
 var packageName = "@atlaskit/dynamic-table";
-var packageVersion = "14.9.2";
+var packageVersion = "14.10.0";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case DESC:
@@ -257,9 +257,10 @@ _defineProperty(DynamicTable, "defaultProps", {
   onRankStart: noop,
   onRankEnd: noop,
   paginationi18n: {
-    prev: 'Prev',
+    prev: 'Previous',
     next: 'Next',
-    label: 'Pagination'
+    label: 'Pagination',
+    pageLabel: 'Page'
   }
 });
 export { DynamicTable as DynamicTableWithoutAnalytics };

package/dist/esm/version.json

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

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

@@ -25,6 +25,7 @@ declare class DynamicTable extends React.Component<Props, State> {
             prev: string;
             next: string;
             label: string;
+            pageLabel: string;
         };
     };
     UNSAFE_componentWillMount(): void;
@@ -53,6 +54,7 @@ declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<Props, ke
         prev: string;
         next: string;
         label: string;
+        pageLabel: string;
     };
 }, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "head" | "caption" | "rows" | "emptyView" | "loadingSpinnerSize" | "isLoading" | "isFixedSize" | "rowsPerPage" | "totalRows" | "onSetPage" | "onSort" | "onPageRowsUpdate" | "page" | "sortKey" | "sortOrder" | "isRankable" | "isRankingDisabled" | "onRankStart" | "onRankEnd" | "paginationi18n" | "highlightedRowIndex" | "testId" | "label" | "key" | "analyticsContext"> & React.RefAttributes<any>>;
 export default _default;

package/dist/types/types.d.ts

@@ -32,6 +32,13 @@ export interface I18nShape {
      * Accessible label applied to the current page button in the pagination component.
      */
     label: string;
+    /**
+     * Accessible label for the individual page numbers.
+     * The page number is automatically appended to the pageLabel.
+     * For Example, pageLabel="página" will render aria-label="página 1"
+     * as the label for page 1.
+     */
+    pageLabel?: string;
 }
 export interface StatelessProps extends WithAnalyticsEventsProps {
     /**
@@ -121,7 +128,7 @@ export interface StatelessProps extends WithAnalyticsEventsProps {
     onRankEnd?: (rankEnd: RankEnd, uiAnalyticsEvent?: UIAnalyticsEvent) => void;
     /**
      * Labels for the pagination wrapper, previous and next buttons used in pagination.
-     * Defaults to `"pagination"`, `"previous"` and `"next"`.
+     * Defaults to `"page"`, `"pagination"`, `"previous"` and `"next"`.
      */
     paginationi18n?: I18nShape;
     /**

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

@@ -25,6 +25,7 @@ declare class DynamicTable extends React.Component<Props, State> {
             prev: string;
             next: string;
             label: string;
+            pageLabel: string;
         };
     };
     UNSAFE_componentWillMount(): void;
@@ -53,6 +54,7 @@ declare const _default: React.ForwardRefExoticComponent<Pick<Pick<Omit<Props, ke
         prev: string;
         next: string;
         label: string;
+        pageLabel: string;
     };
 }, never>> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "head" | "caption" | "rows" | "emptyView" | "loadingSpinnerSize" | "isLoading" | "isFixedSize" | "rowsPerPage" | "totalRows" | "onSetPage" | "onSort" | "onPageRowsUpdate" | "page" | "sortKey" | "sortOrder" | "isRankable" | "isRankingDisabled" | "onRankStart" | "onRankEnd" | "paginationi18n" | "highlightedRowIndex" | "testId" | "label" | "key" | "analyticsContext"> & React.RefAttributes<any>>;
 export default _default;

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

@@ -32,6 +32,13 @@ export interface I18nShape {
      * Accessible label applied to the current page button in the pagination component.
      */
     label: string;
+    /**
+     * Accessible label for the individual page numbers.
+     * The page number is automatically appended to the pageLabel.
+     * For Example, pageLabel="página" will render aria-label="página 1"
+     * as the label for page 1.
+     */
+    pageLabel?: string;
 }
 export interface StatelessProps extends WithAnalyticsEventsProps {
     /**
@@ -121,7 +128,7 @@ export interface StatelessProps extends WithAnalyticsEventsProps {
     onRankEnd?: (rankEnd: RankEnd, uiAnalyticsEvent?: UIAnalyticsEvent) => void;
     /**
      * Labels for the pagination wrapper, previous and next buttons used in pagination.
-     * Defaults to `"pagination"`, `"previous"` and `"next"`.
+     * Defaults to `"page"`, `"pagination"`, `"previous"` and `"next"`.
      */
     paginationi18n?: I18nShape;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/dynamic-table",
-  "version": "14.9.2",
+  "version": "14.10.0",
   "description": "A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,7 +26,10 @@
   "atlassian": {
     "team": "Design System Team",
     "deprecatedAutoEntryPoints": true,
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
+    "productPushConsumption": [
+      "jira"
+    ],
     "website": {
       "name": "Dynamic table",
       "category": "Components"
@@ -35,10 +38,10 @@
   "dependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/pagination": "^14.3.0",
+    "@atlaskit/pagination": "^14.4.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.5.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "react-beautiful-dnd": "^12.1.1"

package/report.api.md

@@ -39,14 +39,11 @@ class DynamicTable extends React_2.Component<StatefulProps, State> {
   // (undocumented)
   onRankEndIfExistsHandler: (params: RankEnd) => void;
   // (undocumented)
-  onSetPageHandler: (
-    page: number,
-    analyticsEvent?: UIAnalyticsEvent | undefined,
-  ) => void;
+  onSetPageHandler: (page: number, analyticsEvent?: UIAnalyticsEvent) => void;
   // (undocumented)
   onSortHandler: (
     { key, item, sortOrder }: any,
-    analyticsEvent?: UIAnalyticsEvent | undefined,
+    analyticsEvent?: UIAnalyticsEvent,
   ) => void;
   // (undocumented)
   render(): JSX.Element;
@@ -113,6 +110,7 @@ export const DynamicTableStateless: React_2.ForwardRefExoticComponent<
               prev: string;
               next: string;
               label: string;
+              pageLabel: string;
             };
           },
           never
@@ -166,6 +164,7 @@ interface HeadType {
 interface I18nShape {
   label: string;
   next: string;
+  pageLabel?: string;
   prev: string;
 }
 

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

@@ -0,0 +1,215 @@
+## API Report File for "@atlaskit/dynamic-table"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import noop from '@atlaskit/ds-lib/noop';
+import { default as React_2 } from 'react';
+import { Ref } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import { WithContextProps } from '@atlaskit/analytics-next';
+
+// @public
+class DynamicTable extends React_2.Component<StatefulProps, State> {
+    // (undocumented)
+    static defaultProps: {
+        defaultPage: number;
+        isLoading: boolean;
+        isFixedSize: boolean;
+        isRankable: boolean;
+        onSetPage: typeof noop;
+        onSort: typeof noop;
+        rowsPerPage: number;
+    };
+    // (undocumented)
+    onRankEndHandler: (params: RankEnd) => void;
+    // (undocumented)
+    onRankEndIfExistsHandler: (params: RankEnd) => void;
+    // (undocumented)
+    onSetPageHandler: (page: number, analyticsEvent?: UIAnalyticsEvent) => void;
+    // (undocumented)
+    onSortHandler: ({ key, item, sortOrder }: any, analyticsEvent?: UIAnalyticsEvent) => 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;
+
+// @public (undocumented)
+export const DynamicTableStateless: React_2.ForwardRefExoticComponent<Pick<Pick<Omit<StatelessProps, keyof WithAnalyticsEventsProps>, "caption" | "emptyView" | "head" | "highlightedRowIndex" | "label" | "loadingSpinnerSize" | "onPageRowsUpdate" | "rows" | "sortKey" | "sortOrder" | "testId" | "totalRows"> & Partial<Pick<Omit<StatelessProps, keyof WithAnalyticsEventsProps>, "isFixedSize" | "isLoading" | "isRankable" | "isRankingDisabled" | "onRankEnd" | "onRankStart" | "onSetPage" | "onSort" | "page" | "paginationi18n" | "rowsPerPage">> & Partial<Pick<{
+    isLoading: boolean;
+    isFixedSize: boolean;
+    rowsPerPage: number;
+    onSetPage: typeof noop;
+    onSort: typeof noop;
+    page: number;
+    isRankable: boolean;
+    isRankingDisabled: boolean;
+    onRankStart: typeof noop;
+    onRankEnd: typeof noop;
+    paginationi18n: {
+        prev: string;
+        next: string;
+        label: string;
+        pageLabel: string;
+    };
+}, never>> & React_2.RefAttributes<any> & WithContextProps, "analyticsContext" | "caption" | "emptyView" | "head" | "highlightedRowIndex" | "isFixedSize" | "isLoading" | "isRankable" | "isRankingDisabled" | "key" | "label" | "loadingSpinnerSize" | "onPageRowsUpdate" | "onRankEnd" | "onRankStart" | "onSetPage" | "onSort" | "page" | "paginationi18n" | "rows" | "rowsPerPage" | "sortKey" | "sortOrder" | "testId" | "totalRows"> & React_2.RefAttributes<any>>;
+
+// @public (undocumented)
+interface HeadCellType extends RowCellType {
+    isSortable?: boolean;
+    shouldTruncate?: boolean;
+    width?: number;
+}
+
+// @public (undocumented)
+interface HeadType {
+    // (undocumented)
+    cells: Array<HeadCellType>;
+}
+
+// @public (undocumented)
+interface I18nShape {
+    label: string;
+    next: string;
+    pageLabel?: string;
+    prev: string;
+}
+
+// @public (undocumented)
+type LoadingSpinnerSizeType = 'large' | 'small';
+
+// @public (undocumented)
+interface RankEnd {
+    // (undocumented)
+    destination?: RankEndLocation;
+    // (undocumented)
+    sourceIndex: number;
+    // (undocumented)
+    sourceKey: string;
+}
+
+// @public (undocumented)
+interface RankEndLocation {
+    // (undocumented)
+    afterKey?: string;
+    // (undocumented)
+    beforeKey?: string;
+    // (undocumented)
+    index: number;
+}
+
+// @public (undocumented)
+interface RankStart {
+    // (undocumented)
+    index: number;
+    // (undocumented)
+    key: string;
+}
+
+// @public (undocumented)
+interface RowCellType {
+    colSpan?: number;
+    content?: React_2.ReactNode | string;
+    key?: number | string;
+    testId?: string;
+}
+
+// @public (undocumented)
+interface RowType extends React_2.ComponentPropsWithoutRef<'tr'> {
+    // (undocumented)
+    cells: Array<RowCellType>;
+    isHighlighted?: boolean;
+    // (undocumented)
+    key?: string;
+    onClick?: React_2.MouseEventHandler;
+    onKeyPress?: React_2.KeyboardEventHandler;
+    // (undocumented)
+    ref?: Ref<HTMLTableRowElement>;
+    testId?: string;
+}
+
+// @public
+type SortOrderType = 'ASC' | 'DESC';
+
+// @public (undocumented)
+interface State {
+    // (undocumented)
+    page?: number;
+    // (undocumented)
+    rows?: RowType[];
+    // (undocumented)
+    sortKey?: string;
+    // (undocumented)
+    sortOrder?: SortOrderType;
+}
+
+// @public (undocumented)
+interface StatefulProps extends WithAnalyticsEventsProps {
+    caption?: React_2.ReactNode;
+    defaultPage?: number;
+    defaultSortKey?: string;
+    defaultSortOrder?: SortOrderType;
+    emptyView?: React_2.ReactElement<any>;
+    head?: HeadType;
+    highlightedRowIndex?: number | number[];
+    isFixedSize?: boolean;
+    isLoading?: boolean;
+    isRankable?: boolean;
+    isRankingDisabled?: boolean;
+    label?: string;
+    loadingSpinnerSize?: LoadingSpinnerSizeType;
+    onPageRowsUpdate?: (pageRows: Array<RowType>) => void;
+    onRankEnd?: (rankEnd: RankEnd) => void;
+    onRankStart?: (rankStart: RankStart) => void;
+    onSetPage?: (page: number, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
+    onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
+    page?: number;
+    paginationi18n?: I18nShape;
+    rows?: Array<RowType>;
+    rowsPerPage?: number;
+    sortKey?: string;
+    sortOrder?: SortOrderType;
+    testId?: string;
+}
+
+// @public (undocumented)
+interface StatelessProps extends WithAnalyticsEventsProps {
+    caption?: React_2.ReactNode;
+    emptyView?: React_2.ReactElement<any>;
+    head?: HeadType;
+    highlightedRowIndex?: number | number[];
+    isFixedSize?: boolean;
+    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;
+    onSort?: (data: any, UIAnalyticsEvent?: UIAnalyticsEvent) => void;
+    page?: number;
+    paginationi18n?: I18nShape;
+    rows?: Array<RowType>;
+    rowsPerPage?: number;
+    sortKey?: string;
+    sortOrder?: SortOrderType;
+    testId?: string;
+    totalRows?: number;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```