Disable Pagination: Add a pagination option and hide the page selector when pagination is disabled (#651)

* Disable Pagination: Add a pagination option and hide the page selector when pagination is disabled
Fixes #320

* Rename the pagination toggle and add doccomments

---------

Co-authored-by: tsv2013 <[email protected]>
Co-authored-by: RomanTsukanov <[email protected]>

Author: 3 people

examples/custom_tabulator.js

@@ -17,8 +17,10 @@ var surveyAnalyticsTabulator = new SurveyAnalyticsTabulator.Tabulator(
   survey,
   normalizedData,
   {
-    // useNamesAsTitles: true
-    // columnMinWidth: 50
+    // useNamesAsTitles: true,
+    // columnMinWidth: 50,
+    // pageSize: 10,
+    // paginationEnabled: false
   }
 );
 

src/tables/extensions/headerextensions.ts

@@ -90,6 +90,9 @@ TableExtensions.registerExtension({
   name: "showentries",
   visibleIndex: 3,
   render: function (table: Table): HTMLElement {
+    if(table.options.paginationEnabled === false) {
+      return DocumentHelper.createElement("div");
+    }
     function getEntriesDropdown(table: Table): HTMLElement {
       const el = <HTMLSelectElement>DocumentHelper.createElement("select");
       var optionsValues = table.paginationSizeSelector || ["1", "5", "10", "25", "50", "75", "100"];

src/tables/table.ts

@@ -44,7 +44,22 @@ export interface ITableOptions {
     displayValue: any,
   }) => void;
 
+  /**
+   * Specifies the number of data items to load and display per page. Applies only if `paginationEnabled` is `true`.
+   *
+   * Default value: 10
+   * @see paginationEnabled
+   */
   pageSize?: number;
+  /**
+   * Specifies whether the dataset is split into pages.
+   *
+   * Default value: `true`
+   *
+   * > Pagination cannot be disabled if the dataset is loaded from a server (that is, if the second parameter passed to the `Tabulator` constructor is a function).
+   * @see pageSize
+   */
+  paginationEnabled?: boolean;
 }
 
 export type TabulatorFilter = { field: string, type: string, value: any };

src/tables/tabulator.ts

@@ -151,7 +151,8 @@ export class Tabulator extends Table {
       {
         data,
         layout: "fitColumns",
-        pagination: "local",
+        pagination: this.options.paginationEnabled !== false,
+        paginationMode: "local",
         paginationSize: this.currentPageSize,
         movableColumns: true,
         // maxHeight: "100%",
@@ -181,6 +182,7 @@ export class Tabulator extends Table {
       delete config.data;
       config.pagination = true;
       config.paginationMode = "remote";
+      config.paginationSize = this.currentPageSize,
       config.ajaxFiltering = true; // Tabulator v4.8
       config.filterMode = "remote"; // Tabulator v6.2
       config.ajaxSorting = true; // Tabulator v4.8