[Terra-Paginator] Added hidePageCount prop to hide default page cou…

…nt provided by Paginator (#3924)

Co-authored-by: SM051274 <sm051274@cerner.net>

packages/terra-core-docs/CHANGELOG.md

@@ -2,8 +2,13 @@
 
 ## Unreleased
 
+* Added
+  * Added progressive paginator examples for custom page label and page count.
+
 * Updated
+  * Updated test example to validate `hidePageCount` prop.
   * Updated terra-list examples to demonstrate arrow key navigation within list and list sections.
+
 ## 1.42.0 - (September 26, 2023)
 
 * Updated

packages/terra-core-docs/src/terra-dev-site/doc/paginator/ProgressivePaginator.3.doc.mdx

@@ -1,6 +1,8 @@
 import { Badge } from 'terra-paginator/package.json?dev-site-package';
 
 import ProgressivePaginatorExample from './example/ProgressivePaginatorExample?dev-site-example';
+import ProgressivePaginatorCustomPageLabelExample from './example/ProgressivePaginatorCustomPageLabelExample?dev-site-example';
+import ProgressivePaginatorCustomPageCountExample from './example/ProgressivePaginatorCustomPageCountExample?dev-site-example';
 import ProgressivePaginatorWithoutTotalCountExample from './example/ProgressivePaginatorWithoutTotalCountExample?dev-site-example';
 
 import ProgressivePaginatorPropsTable from 'terra-paginator/lib/ProgressivePaginator?dev-site-props-table';
@@ -30,6 +32,8 @@ import ProgressivePaginator from 'terra-paginator/lib/ProgressivePaginator';
 
 ## Examples
 <ProgressivePaginatorExample />
+<ProgressivePaginatorCustomPageLabelExample />
+<ProgressivePaginatorCustomPageCountExample />
 <ProgressivePaginatorWithoutTotalCountExample />
 
 ## Progressive Paginator Props

packages/terra-core-docs/src/terra-dev-site/doc/paginator/example/ProgressivePaginatorCustomPageCountExample.jsx

@@ -0,0 +1,56 @@
+import React from 'react';
+import Dialog from 'terra-dialog';
+import ProgressivePaginator from 'terra-paginator/lib/ProgressivePaginator';
+import classNames from 'classnames/bind';
+import styles from './PaginatorExampleCommon.module.scss';
+
+const cx = classNames.bind(styles);
+const totalCount = 450;
+
+const buildPage = () => {
+  const fullContent = [<p>Patients are requesting greater affordability and efficiency in healthcare. With procedures performed in an ambulatory surgery center costing up to 60% less compared to a hospital outpatient department (1), the demand for these facilities is increasing. In fact, the U.S. ambulatory surgery center market is expected to see a 6.9 % compound annual growth rate, reaching $33 billion by 2028. (2) Cerner understands the urgency to grow in the ambulatory surgery center market while continuing to deliver excellent care. Healthcare IT products can help improve clinician efficiency and patient outcomes, as well as enhance communication and data exchange between ambulatory surgery center providers and patients.</p>];
+
+  return (
+    fullContent
+  );
+};
+
+class ProgressivePaginatorCustomPageCountExample extends React.Component {
+  constructor(props) {
+    super(props);
+
+    this.state = {
+      content: buildPage(),
+      currentPage: 1,
+      pageLabel: `Summary 1 in ${totalCount}`,
+    };
+
+    this.changePages = this.changePages.bind(this);
+  }
+
+  changePages(index) {
+    this.setState({ currentPage: index });
+    this.setState({ pageLabel: `Summary ${index} of total ${totalCount}` });
+  }
+
+  render() {
+    return (
+      <div className={cx('paginator-wrapper')}>
+        <Dialog
+          header={(
+            <h1 id="progressive_paginator_header_id">
+              Progressive Paginator With Custom PageLabel and Page Count
+            </h1>
+)}
+          // eslint-disable-next-line react/prop-types
+          footer={<ProgressivePaginator onPageChange={this.changePages} selectedPage={this.state.currentPage} totalCount={totalCount} itemCountPerPage={10} ariaLabelledBy="progressive_paginator_header_id" pageLabel={this.state.pageLabel} hidePageCount />}
+        >
+          {this.state.content}
+        </Dialog>
+        <b>Note: Ensure translated string is provided for pageLabel to make it accessible in different locales</b>
+      </div>
+    );
+  }
+}
+
+export default ProgressivePaginatorCustomPageCountExample;

packages/terra-core-docs/src/terra-dev-site/doc/paginator/example/ProgressivePaginatorCustomPageLabelExample.jsx

@@ -0,0 +1,55 @@
+import React from 'react';
+import Dialog from 'terra-dialog';
+import ProgressivePaginator from 'terra-paginator/lib/ProgressivePaginator';
+import classNames from 'classnames/bind';
+import styles from './PaginatorExampleCommon.module.scss';
+
+const cx = classNames.bind(styles);
+const totalCount = 450;
+const pageLabel = 'Summary';
+
+const buildPage = () => {
+  const fullContent = [<p>Patients are requesting greater affordability and efficiency in healthcare. With procedures performed in an ambulatory surgery center costing up to 60% less compared to a hospital outpatient department (1), the demand for these facilities is increasing. In fact, the U.S. ambulatory surgery center market is expected to see a 6.9 % compound annual growth rate, reaching $33 billion by 2028. (2) Cerner understands the urgency to grow in the ambulatory surgery center market while continuing to deliver excellent care. Healthcare IT products can help improve clinician efficiency and patient outcomes, as well as enhance communication and data exchange between ambulatory surgery center providers and patients.</p>];
+
+  return (
+    fullContent
+  );
+};
+
+class ProgressivePaginatorCustomPageLabelExample extends React.Component {
+  constructor(props) {
+    super(props);
+
+    this.state = {
+      content: buildPage(),
+      currentPage: 1,
+    };
+
+    this.changePages = this.changePages.bind(this);
+  }
+
+  changePages(index) {
+    this.setState({ currentPage: index });
+  }
+
+  render() {
+    return (
+      <div className={cx('paginator-wrapper')}>
+        <Dialog
+          header={(
+            <h1 id="progressive_paginator_header_id">
+              Progressive Paginator With Custom Page Label
+            </h1>
+)}
+          // eslint-disable-next-line react/prop-types
+          footer={<ProgressivePaginator onPageChange={this.changePages} selectedPage={this.state.currentPage} totalCount={totalCount} itemCountPerPage={10} ariaLabelledBy="progressive_paginator_header_id" pageLabel={pageLabel} />}
+        >
+          {this.state.content}
+        </Dialog>
+        <b>Note: Ensure translated string is provided for pageLabel to make it accessible in different locales</b>
+      </div>
+    );
+  }
+}
+
+export default ProgressivePaginatorCustomPageLabelExample;

packages/terra-core-docs/src/terra-dev-site/test/paginator/ProgressivePaginatorWithCustomLabel.test.jsx

@@ -5,15 +5,18 @@ import ProgressivePaginator from 'terra-paginator/lib/ProgressivePaginator';
 const ProgressivePaginatorWithCustomLabel = () => {
   const [totalCount, setTotalCount] = useState();
   const [currentPage, setCurrentPage] = useState(1);
+  const [hidePageCount, setHidePageCount] = useState(false);
+  const [pageLabel, setPageLabel] = useState('WebPage');
 
   const changePages = (index) => {
     setCurrentPage(index);
   };
   return (
     <div>
       <Button id="total-count-button" text="Set Total Count to 45" onClick={() => { setTotalCount(45); }} />
-      {/* eslint-disable-next-line no-console */}
-      <ProgressivePaginator pageLabel="WebPage" totalCount={totalCount} onPageChange={changePages} selectedPage={currentPage} />
+      <Button id="hide-count-button" text="Hide Page Count" onClick={() => { setHidePageCount(true); setPageLabel('WebPage 444 of 445'); }} />
+      <Button id="clear-page-lable-button" text="clear Page label" onClick={() => { setPageLabel(undefined); }} />
+      <ProgressivePaginator pageLabel={pageLabel} hidePageCount={hidePageCount} totalCount={totalCount} onPageChange={changePages} selectedPage={currentPage} />
     </div>
   );
 };

packages/terra-paginator/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Added
+  * Added `hidePageCount` prop to hide page count provided by paginator.
+
 ## 2.85.0 - (September 19, 2023)
 
 * Added

packages/terra-paginator/src/ControlledProgressivePaginator.jsx

@@ -50,6 +50,12 @@ const propTypes = {
    * Allows user to set custom page label. _(usage note: User must pass translated text)_. It should not contain page number and total count details, which will lead to conflicts with built-in accessibility ARIA contexts.
    */
   pageLabel: PropTypes.string,
+  /**
+   * ![IMPORTANT](https://badgen.net/badge/UX/Accessibility/blue)
+   * When specified allows user to set custom page count. User should provide custom page count as part `pageLabel` for best accessibility practices.
+   * _(usage note: when `pageLabel` is not provided page count will not be hidden and default page count is displayed for best accessibility practices)_.
+   */
+  hidePageCount: PropTypes.bool,
 };
 
 class ControlledProgressivePaginator extends React.Component {
@@ -108,6 +114,7 @@ class ControlledProgressivePaginator extends React.Component {
       ariaLabelledBy,
       ariaLabel,
       pageLabel,
+      hidePageCount,
     } = this.props;
     const totalPages = (totalCount) ? calculatePages(totalCount, itemCountPerPage) : 0;
     const previousPageIndex = selectedPage === 1 ? 1 : selectedPage - 1;
@@ -116,14 +123,11 @@ class ControlledProgressivePaginator extends React.Component {
     const renderFirstandLastButton = totalCount > 0;
 
     const { messageId, messageAttributes } = getPageLabel(pageLabel, selectedPage, totalPages);
+    const pageDetails = (hidePageCount && pageLabel) ? <div>{pageLabel}</div> : <div>{intl.formatMessage({ id: messageId }, messageAttributes)}</div>;
 
     const fullViewChildren = (
       <>
-        <div>
-          {
-            intl.formatMessage({ id: messageId }, messageAttributes)
-          }
-        </div>
+        {pageDetails}
         <ul className={cx('progressive-list')}>
           {
             renderFirstandLastButton && (
@@ -215,6 +219,7 @@ class ControlledProgressivePaginator extends React.Component {
       ariaLabelledBy,
       ariaLabel,
       pageLabel,
+      hidePageCount,
     } = this.props;
     const totalPages = (totalCount) ? calculatePages(totalCount, itemCountPerPage) : 0;
     const previousPageIndex = selectedPage === 1 ? 1 : selectedPage - 1;
@@ -223,14 +228,11 @@ class ControlledProgressivePaginator extends React.Component {
     const renderFirstandLastButton = totalCount > 0;
 
     const { messageId, messageAttributes } = getPageLabel(pageLabel, selectedPage, totalPages);
+    const pageDetails = (hidePageCount && pageLabel) ? <div>{pageLabel}</div> : <div>{intl.formatMessage({ id: messageId }, messageAttributes)}</div>;
 
     const reducedViewChildren = (
       <>
-        <div>
-          {
-            intl.formatMessage({ id: messageId }, messageAttributes)
-          }
-        </div>
+        {pageDetails}
         <ul className={cx('progressive-list')}>
           {
             renderFirstandLastButton && (

packages/terra-paginator/src/ProgressivePaginator.jsx

@@ -50,6 +50,12 @@ const propTypes = {
    * Allows user to set custom page label. _(usage note: User must pass translated text)_. It should not contain page number and total count details, which will lead to conflicts with built-in accessibility ARIA contexts.
    */
   pageLabel: PropTypes.string,
+  /**
+   * ![IMPORTANT](https://badgen.net/badge/UX/Accessibility/blue)
+   * When specified allows user to set custom page count. User should provide custom page count as part `pageLabel` for best accessibility practices.
+   * _(usage note: when `pageLabel` is not provided page count will not be hidden and default page count is displayed for best accessibility practices)_.
+   */
+  hidePageCount: PropTypes.bool,
 };
 
 class ProgressivePaginator extends React.Component {
@@ -114,6 +120,7 @@ class ProgressivePaginator extends React.Component {
       ariaLabelledBy,
       ariaLabel,
       pageLabel,
+      hidePageCount,
     } = this.props;
     const totalPages = (totalCount) ? calculatePages(totalCount, itemCountPerPage) : 0;
     const { selectedPage } = this.state;
@@ -123,14 +130,11 @@ class ProgressivePaginator extends React.Component {
     const renderFirstandLastButton = totalCount > 0;
 
     const { messageId, messageAttributes } = getPageLabel(pageLabel, selectedPage, totalPages);
+    const pageDetails = (hidePageCount && pageLabel) ? <div>{pageLabel}</div> : <div>{intl.formatMessage({ id: messageId }, messageAttributes)}</div>;
 
     const fullViewChildren = (
       <>
-        <div>
-          {
-            intl.formatMessage({ id: messageId }, messageAttributes)
-          }
-        </div>
+        {pageDetails}
         <ul className={cx('progressive-list')}>
           {
             renderFirstandLastButton && (
@@ -221,6 +225,7 @@ class ProgressivePaginator extends React.Component {
       ariaLabelledBy,
       ariaLabel,
       pageLabel,
+      hidePageCount,
     } = this.props;
     const totalPages = (totalCount) ? calculatePages(totalCount, itemCountPerPage) : 0;
     const { selectedPage } = this.state;
@@ -230,14 +235,11 @@ class ProgressivePaginator extends React.Component {
     const renderFirstandLastButton = totalCount > 0;
 
     const { messageId, messageAttributes } = getPageLabel(pageLabel, selectedPage, totalPages);
+    const pageDetails = (hidePageCount && pageLabel) ? <div>{pageLabel}</div> : <div>{intl.formatMessage({ id: messageId }, messageAttributes)}</div>;
 
     const reducedViewChildren = (
       <>
-        <div>
-          {
-            intl.formatMessage({ id: messageId }, messageAttributes)
-          }
-        </div>
+        {pageDetails}
         <ul className={cx('progressive-list')}>
           {
             renderFirstandLastButton && (

packages/terra-paginator/tests/wdio/paginator-spec.js

@@ -148,5 +148,15 @@ Terra.describeViewports('Controlled Paginator', ['large'], () => {
       $('#total-count-button').click();
       Terra.validates.element('custom page label with total count');
     });
+
+    it('should display custom page count with custom page label when hidePageCount is set to true', () => {
+      $('#hide-count-button').click();
+      Terra.validates.element('custom page label with custom page count');
+    });
+
+    it('should display progressive paginator with default page count when page label is not provided', () => {
+      $('#clear-page-lable-button').click();
+      Terra.validates.element('paginator with default page count');
+    });
   });
 });