@atlaskit/pagination 14.3.2 → 14.4.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/pagination
 
+## 14.4.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 14.4.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
+
 ## 14.3.2
 
 ### Patch Changes

package/dist/cjs/pagination.js

@@ -28,7 +28,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 var analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.2"
+  packageVersion: "14.4.1"
 };
 function InnerPagination(_ref, ref) {
   var _ref$components = _ref.components,
@@ -38,6 +38,8 @@ function InnerPagination(_ref, ref) {
     selectedIndex = _ref.selectedIndex,
     _ref$label = _ref.label,
     label = _ref$label === void 0 ? 'pagination' : _ref$label,
+    _ref$pageLabel = _ref.pageLabel,
+    pageLabel = _ref$pageLabel === void 0 ? 'page' : _ref$pageLabel,
     _ref$previousLabel = _ref.previousLabel,
     previousLabel = _ref$previousLabel === void 0 ? 'previous' : _ref$previousLabel,
     _ref$nextLabel = _ref.nextLabel,
@@ -77,6 +79,7 @@ function InnerPagination(_ref, ref) {
   }, analyticsAttributes));
   var transform = function transform(page, currPageIndex, testId) {
     var selectedPage = pages[selectedIndexValue];
+    var pageIndexLabel = "".concat(pageLabel, " ").concat(getPageLabel ? getPageLabel(page, currPageIndex) : page);
     return /*#__PURE__*/_react.default.createElement(_page.default, {
       key: "page-".concat(getPageLabel ? getPageLabel(page, currPageIndex) : currPageIndex),
       component: components.Page,
@@ -86,6 +89,8 @@ function InnerPagination(_ref, ref) {
           selectedPageIndex: currPageIndex
         });
       },
+      "aria-current": page === selectedPage ? 'page' : undefined,
+      "aria-label": pageIndexLabel,
       isSelected: page === selectedPage,
       page: page,
       testId: testId && "".concat(testId, "--").concat(page === selectedPage ? 'current-' : '', "page-").concat(currPageIndex)

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.2",
+	"version": "14.4.1",
 	"sideEffects": false
 }

package/dist/es2019/pagination.js

@@ -14,13 +14,14 @@ import collapseRange from './internal/utils/collapse-range';
 const analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.2"
+  packageVersion: "14.4.1"
 };
 function InnerPagination({
   components = emptyObject,
   defaultSelectedIndex = 0,
   selectedIndex,
   label = 'pagination',
+  pageLabel = 'page',
   previousLabel = 'previous',
   nextLabel = 'next',
   style = emptyObject,
@@ -53,6 +54,7 @@ function InnerPagination({
   });
   const transform = (page, currPageIndex, testId) => {
     const selectedPage = pages[selectedIndexValue];
+    const pageIndexLabel = `${pageLabel} ${getPageLabel ? getPageLabel(page, currPageIndex) : page}`;
     return /*#__PURE__*/React.createElement(PageComponent, {
       key: `page-${getPageLabel ? getPageLabel(page, currPageIndex) : currPageIndex}`,
       component: components.Page,
@@ -60,6 +62,8 @@ function InnerPagination({
         event,
         selectedPageIndex: currPageIndex
       }),
+      "aria-current": page === selectedPage ? 'page' : undefined,
+      "aria-label": pageIndexLabel,
       isSelected: page === selectedPage,
       page: page,
       testId: testId && `${testId}--${page === selectedPage ? 'current-' : ''}page-${currPageIndex}`

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.2",
+	"version": "14.4.1",
 	"sideEffects": false
 }

package/dist/esm/pagination.js

@@ -18,7 +18,7 @@ import collapseRange from './internal/utils/collapse-range';
 var analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.2"
+  packageVersion: "14.4.1"
 };
 function InnerPagination(_ref, ref) {
   var _ref$components = _ref.components,
@@ -28,6 +28,8 @@ function InnerPagination(_ref, ref) {
     selectedIndex = _ref.selectedIndex,
     _ref$label = _ref.label,
     label = _ref$label === void 0 ? 'pagination' : _ref$label,
+    _ref$pageLabel = _ref.pageLabel,
+    pageLabel = _ref$pageLabel === void 0 ? 'page' : _ref$pageLabel,
     _ref$previousLabel = _ref.previousLabel,
     previousLabel = _ref$previousLabel === void 0 ? 'previous' : _ref$previousLabel,
     _ref$nextLabel = _ref.nextLabel,
@@ -67,6 +69,7 @@ function InnerPagination(_ref, ref) {
   }, analyticsAttributes));
   var transform = function transform(page, currPageIndex, testId) {
     var selectedPage = pages[selectedIndexValue];
+    var pageIndexLabel = "".concat(pageLabel, " ").concat(getPageLabel ? getPageLabel(page, currPageIndex) : page);
     return /*#__PURE__*/React.createElement(PageComponent, {
       key: "page-".concat(getPageLabel ? getPageLabel(page, currPageIndex) : currPageIndex),
       component: components.Page,
@@ -76,6 +79,8 @@ function InnerPagination(_ref, ref) {
           selectedPageIndex: currPageIndex
         });
       },
+      "aria-current": page === selectedPage ? 'page' : undefined,
+      "aria-label": pageIndexLabel,
       isSelected: page === selectedPage,
       page: page,
       testId: testId && "".concat(testId, "--").concat(page === selectedPage ? 'current-' : '', "page-").concat(currPageIndex)

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.2",
+	"version": "14.4.1",
 	"sideEffects": false
 }

package/dist/types/pagination.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
 import { PaginationPropTypes } from './types';
-declare function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React.Ref<HTMLDivElement>): JSX.Element;
+declare function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, pageLabel, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React.Ref<HTMLDivElement>): JSX.Element;
 declare const _default: typeof InnerPagination;
 export default _default;

package/dist/types/types.d.ts

@@ -18,15 +18,26 @@ export interface PaginationPropTypes<T = unknown> {
      */
     getPageLabel?: (page: T, pageIndex: number) => number | string;
     /**
-     * The aria-label for the pagination wrapper
+     * The aria-label for the pagination nav wrapper.
+     * The default value is "pagination".
      */
     label?: string;
     /**
-     * The aria-label for the next button
+     * The aria-label for the next button.
+     * The default value is "next".
      */
     nextLabel?: string;
     /**
-     * The aria-label for the previous button
+     * The aria-label for the individual page numbers.
+     * The default value is "page".
+     * 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;
+    /**
+     * The aria-label for the previous button.
+     * The default value is "previous".
      */
     previousLabel?: string;
     /**

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

@@ -1,5 +1,5 @@
 import React from 'react';
 import { PaginationPropTypes } from './types';
-declare function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React.Ref<HTMLDivElement>): JSX.Element;
+declare function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, pageLabel, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React.Ref<HTMLDivElement>): JSX.Element;
 declare const _default: typeof InnerPagination;
 export default _default;

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

@@ -18,15 +18,26 @@ export interface PaginationPropTypes<T = unknown> {
      */
     getPageLabel?: (page: T, pageIndex: number) => number | string;
     /**
-     * The aria-label for the pagination wrapper
+     * The aria-label for the pagination nav wrapper.
+     * The default value is "pagination".
      */
     label?: string;
     /**
-     * The aria-label for the next button
+     * The aria-label for the next button.
+     * The default value is "next".
      */
     nextLabel?: string;
     /**
-     * The aria-label for the previous button
+     * The aria-label for the individual page numbers.
+     * The default value is "page".
+     * 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;
+    /**
+     * The aria-label for the previous button.
+     * The default value is "previous".
      */
     previousLabel?: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/pagination",
-  "version": "14.3.2",
+  "version": "14.4.1",
   "description": "Pagination allows you to divide large amounts of content into smaller chunks across multiple pages.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
   },
   "atlassian": {
     "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Pagination",
       "category": "Components"
@@ -39,10 +39,10 @@
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/button": "^16.7.0",
     "@atlaskit/codemod-utils": "^4.2.0",
-    "@atlaskit/ds-explorations": "^2.1.0",
+    "@atlaskit/ds-explorations": "^2.2.0",
     "@atlaskit/ds-lib": "^2.2.0",
     "@atlaskit/icon": "^21.12.0",
-    "@atlaskit/primitives": "^0.9.0",
+    "@atlaskit/primitives": "^0.10.0",
     "@babel/runtime": "^7.0.0",
     "memoize-one": "^6.0.0"
   },
@@ -53,7 +53,7 @@
     "@atlaskit/code": "^14.6.0",
     "@atlaskit/docs": "*",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/dynamic-table": "^14.9.0",
+    "@atlaskit/dynamic-table": "^14.10.0",
     "@atlaskit/heading": "^1.3.0",
     "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",

package/report.api.md

@@ -32,6 +32,7 @@ function InnerPagination<T>(
     defaultSelectedIndex,
     selectedIndex,
     label,
+    pageLabel,
     previousLabel,
     nextLabel,
     style,
@@ -64,6 +65,7 @@ export interface PaginationPropTypes<T = unknown> {
     page: T,
     analyticsEvent?: UIAnalyticsEvent,
   ) => void;
+  pageLabel?: string;
   pages: T[];
   previousLabel?: string;
   renderEllipsis?: (arg: { key: string }) => ReactElement;

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

@@ -0,0 +1,47 @@
+## API Report File for "@atlaskit/pagination"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { CSSProperties } from 'react';
+import { default as React_2 } from 'react';
+import type { ReactElement } from 'react';
+import type { SyntheticEvent } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+
+// @public (undocumented)
+const _default: typeof InnerPagination;
+export default _default;
+
+// @public (undocumented)
+function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, pageLabel, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React_2.Ref<HTMLDivElement>): JSX.Element;
+
+// @public (undocumented)
+export interface PaginationPropTypes<T = unknown> {
+    analyticsContext?: Record<string, any>;
+    components?: {
+        Page?: React.ElementType;
+        Previous?: React.ElementType;
+        Next?: React.ElementType;
+    };
+    defaultSelectedIndex?: number;
+    getPageLabel?: (page: T, pageIndex: number) => number | string;
+    label?: string;
+    max?: number;
+    nextLabel?: string;
+    onChange?: (event: SyntheticEvent, page: T, analyticsEvent?: UIAnalyticsEvent) => void;
+    pageLabel?: string;
+    pages: T[];
+    previousLabel?: string;
+    renderEllipsis?: (arg: {
+        key: string;
+    }) => ReactElement;
+    selectedIndex?: number;
+    style?: CSSProperties;
+    testId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```