Added fixedScroll option

wenzhixin · Feb 22, 2024 · fc65e2c · fc65e2c
1 parent 2960aae
commit fc65e2c
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -325,6 +325,7 @@ export interface BootstrapTableOptions {
   ) => boolean | void;
   buttonsClass?: string;
   pageList?: number[];
+  fixedScroll?: boolean;
 }
 
 declare global {

diff --git a/site/docs/api/table-options.md b/site/docs/api/table-options.md
@@ -543,6 +543,20 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Example:** [Filter Options](https://examples.bootstrap-table.com/#options/filter-options.html)
 
+## fixedScroll
+
+- **Attribute:** `data-fixed-scroll`
+
+- **Type:** `Boolean`
+
+- **Detail:**
+
+  Set `true` to enable the fixed scrollbar position of the table when loading data.
+
+- **Default:** `false`
+
+- **Example:** [Fixed Scroll](https://examples.bootstrap-table.com/#options/fixed-scroll.html)
+
 ## footerField
 
 - **Attribute:** `data-footer-field`

diff --git a/src/bootstrap-table.js b/src/bootstrap-table.js
@@ -2516,7 +2516,7 @@ class BootstrapTable {
       this.footerData = data[this.options.footerField] ? [data[this.options.footerField]] : undefined
     }
 
-    fixedScroll = data.fixedScroll
+    fixedScroll = this.options.fixedScroll || data.fixedScroll
     data = Array.isArray(data) ? data : data[this.options.dataField]
 
     this.initData(data)

diff --git a/src/constants/index.js b/src/constants/index.js
@@ -247,6 +247,7 @@ const DEFAULTS = {
   iconsPrefix: undefined, // init in initConstants
   icons: {}, // init in initConstants
   iconSize: undefined,
+  fixedScroll: false,
   loadingFontSize: 'auto',
   loadingTemplate (loadingMessage) {
     return `<span class="loading-wrap">