Skip to content

Commit

Permalink
docs: improve description of forceSyncScrolling grid option
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding committed Aug 23, 2024
1 parent b0e7706 commit 6880f58
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/models/gridOption.interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,10 @@ export interface GridOption<C extends BaseColumn = BaseColumn> {
/** Do we want to force fit columns in the grid at all time? */
forceFitColumns?: boolean;

/** Defaults to false, force synchronous scrolling */
/**
* Defaults to false, force synchronous scrolling without throttling the UI render when scrolling.
* Note: it might be risky to disable this option on large dataset, use at your own risk
*/
forceSyncScrolling?: boolean;

/** Formatter classes factory */
Expand Down

0 comments on commit 6880f58

Please sign in to comment.