Skip to content

fix(grid): fix scroll bar error after load data #3644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
Merged

fix(grid): fix scroll bar error after load data #3644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/vue/src/grid/src/table/src/methods.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2048,7 +2048,7 @@ const Methods = {
},
handleDataChange() {
if (Array.isArray(this.data)) {
!this._isUpdateData && this.loadTableData(this.data, true)
!this._isUpdateData && this.loadTableData(this.data)
this._isUpdateData = false
}
Comment on lines 2050 to 2053
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Make data-change refresh reset scroll and reflow — aligns with the bugfix objective

Switching loadTableData(this.data, true) to loadTableData(this.data) will clear scroll and trigger recalculate(). This is consistent with fixing the abnormal scrollbar after data mutations. Note that clearScroll() already respects fetchOption.isReloadScroll, so consumers can still opt out of scroll reset.

Two things to verify:

  • Virtualized scenarios (scrollX/YLoad) restore as expected via attemptRestoreScroll with large-to-small data changes.
  • No unexpected UX regressions for workflows relying on preserving scroll for in-place edits (covered by isReloadScroll).

You can quickly scan for other internal callers that intend to preserve scroll by passing true to loadTableData:

🏁 Script executed:

#!/bin/bash
# Find all calls to loadTableData and show context.
rg -n -A 2 -B 2 $'loadTableData\\('

Length of output: 3190

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "----- packages/vue/src/grid/src/table/src/table.ts (1-160) -----"
sed -n '1,160p' packages/vue/src/grid/src/table/src/table.ts || true

echo
echo "----- packages/vue/src/grid/src/table/src/methods.ts (280-420) -----"
sed -n '280,420p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- packages/vue/src/grid/src/table/src/methods.ts (1990-2065) -----"
sed -n '1990,2065p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- occurrences of clearScroll, attemptRestoreScroll, recalculate, isReloadScroll -----"
rg -n "clearScroll\(|attemptRestoreScroll\(|recalculate\(|isReloadScroll" || true

Length of output: 16901

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "----- methods.ts: clearScroll (lines ~1800-1860) -----"
sed -n '1780,1860p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- methods.ts: loadTableData (lines ~280-340) -----"
sed -n '280,340p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- methods.ts: handleDataChange (lines ~2036-2060) -----"
sed -n '2028,2060p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- methods.ts: attemptRestoreScroll (lines ~2080-2120) -----"
sed -n '2080,2120p' packages/vue/src/grid/src/table/src/methods.ts || true

echo
echo "----- Search for _isUpdateData occurrences -----"
rg -n "_isUpdateData" || true

echo
echo "----- table.ts: loadStatic context (lines 88-104) -----"
sed -n '88,104p' packages/vue/src/grid/src/table/src/table.ts || true

Length of output: 8073

Make data-change refresh reset scroll and reflow — one remaining init caller to update

handleDataChange already calls loadTableData(this.data) (no notRefresh), so data-change will clear scroll and trigger recalc. However loadStatic still calls loadTableData(..., true) during initial prop load and should be updated if you want the same behavior on initial load.

Files to update / note:

  • packages/vue/src/grid/src/table/src/methods.ts:2050-2053 — handleDataChange already uses this.loadTableData(this.data) (no change required).
  • packages/vue/src/grid/src/table/src/table.ts:88-104 — loadStatic currently preserves scroll on init.

Recommended change (table.ts):

  • if (data && data.length > 0) {
  • _vm.loadTableData(data, true)
  • _vm.updateStyle()
  • }
  • if (data && data.length > 0) {
  • _vm.loadTableData(data)
  • _vm.updateStyle()
  • }

Notes to verify:

  • Virtualized scenarios: attemptRestoreScroll clamps to max scroll and triggers scroll events — verify large→small data changes restore as expected.
  • UX edge cases: clearScroll respects fetchOption.isReloadScroll, so workflows that must preserve scroll (in-place edits) remain opt-out-able.
🤖 Prompt for AI Agents 
In packages/vue/src/grid/src/table/src/table.ts around lines 88 to 104,
loadStatic currently calls _vm.loadTableData(data, true) which preserves scroll
on initial prop load; change it to call _vm.loadTableData(data) (no second arg)
so initial loads reset scroll and trigger reflow like handleDataChange, then
call _vm.updateStyle(); keep clearScroll/fetchOption.isReloadScroll behavior for
opt-out and verify virtualized scenarios clamp/restore scroll correctly.

},
Expand Down
13 changes: 11 additions & 2 deletions packages/vue/src/grid/src/table/src/table.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ import {
resolveTheme,
defineComponent,
useInstanceSlots,
useRelation
useRelation,
isVue2
} from '@opentiny/vue-common'
import Tooltip from '@opentiny/vue-tooltip'
import { extend } from '@opentiny/utils'
Expand Down Expand Up @@ -539,7 +540,15 @@ export default defineComponent({
this.handleSelectionHeader()
},
parentHeight() {
this.$nextTick(this.recalculate)
this.recalculate()
},
// 选项式监控在vue2可以检测到顶层数组splice项替换/$set项替换
// array.splice(index, 1, newItem)
// this.$set(array, index, newItem)
data(array1, array2) {
if (isVue2 && array1 === array2 && array1.length === array2.length) {
this.handleDataChange()
}
}
Comment on lines +548 to 552
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Good Vue 2 array-mutation watcher; add an Array guard to avoid unnecessary calls

The watcher correctly handles Vue 2’s same-reference array mutations (splice/$set). Add a guard to skip non-array data (since props.data also allows Object) to avoid needless handleDataChange() calls.

Apply this diff:

-    data(array1, array2) {
-      if (isVue2 && array1 === array2 && array1.length === array2.length) {
+    data(array1, array2) {
+      // Guard non-array props and avoid unnecessary calls when data is an object
+      if (isVue2 && Array.isArray(array1) && array1 === array2 && array1.length === array2.length) {
         this.handleDataChange()
       }
     }

To ensure the watcher captures Vue 2 in-place mutations across the codebase, you can grep for other places mutating props.data directly:

🏁 Script executed:

#!/bin/bash
# Look for common in-place mutations on `data` props
rg -n -A 2 -B 2 $'\\.data\\.(push|splice|pop|shift|unshift)\\('
rg -n -A 2 -B 2 $'\\$set\\(\\s*[^,]+\\.data'

Length of output: 3166

Add Array guard to Vue 2 data watcher in table.ts

The watcher should only trigger for arrays — otherwise objects (with undefined length) can cause unnecessary handleDataChange() calls. Verified the repo contains in-place mutations of .data (so arrays are in use), so this guard is safe and needed.

Files to update / check:

  • packages/vue/src/grid/src/table/src/table.ts — watcher at ~lines 548–552
  • Examples showing in-place .data mutations (for context): examples/sites/demos/pc/app/chart/question/demo4.vue, examples/sites/demos/pc/app/chart/question/demo4-composition-api.vue
  • renderless uses .data.push in: packages/renderless/src/fall-menu/index.ts, packages/renderless/src/chart-pie/index.ts
  • huicharts map uses .data.push in: packages/vue/src/huicharts/huicharts-map/src/map.ts

Apply this diff:

-    data(array1, array2) {
-      if (isVue2 && array1 === array2 && array1.length === array2.length) {
-        this.handleDataChange()
-      }
-    }
+    data(array1, array2) {
+      // Guard non-array props and avoid unnecessary calls when data is an object
+      if (isVue2 && Array.isArray(array1) && array1 === array2 && array1.length === array2.length) {
+        this.handleDataChange()
+      }
+    }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
data(array1, array2) {
if (isVue2 && array1 === array2 && array1.length === array2.length) {
this.handleDataChange()
}
}
data(array1, array2) {
// Guard non-array props and avoid unnecessary calls when data is an object
if (isVue2 && Array.isArray(array1) && array1 === array2 && array1.length === array2.length) {
this.handleDataChange()
}
}
🤖 Prompt for AI Agents 
In packages/vue/src/grid/src/table/src/table.ts around lines 548 to 552, the Vue
2 data watcher currently calls this.handleDataChange() even when the watched
value is an object without length; update the guard so it only triggers for
arrays: ensure you check Array.isArray(array1) (and optionally
Array.isArray(array2)) before verifying equality and length (i.e., if (isVue2 &&
Array.isArray(array1) && array1 === array2 && array1.length === array2.length) {
this.handleDataChange() }), so only array in-place mutations invoke
handleDataChange.

},
created() {
Expand Down
Loading