Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

chore(engine-render): add scroll config comments

Evan9596fc8e98f0
diff --git a/packages/engine-render/src/shape/scroll-bar.ts b/packages/engine-render/src/shape/scroll-bar.ts
index 3dd1dba139..9aca24bb64 100644
--- a/packages/engine-render/src/shape/scroll-bar.ts
+++ b/packages/engine-render/src/shape/scroll-bar.ts
@@ -28,31 +28,26 @@ import { Rect } from './rect';
export interface IScrollBarProps {
mainScene?: Scene;
+ /** Margin between the track to the edge of the scrollable area. Default is 2px. */
thumbMargin?: number;
thumbLengthRatio?: number;
+ /** Background color of the thumb. */
thumbBackgroundColor?: string;
+ /** Background color of the thumb on hover. */
thumbHoverBackgroundColor?: string;
+ /** Background color of the thumb when active. */
thumbActiveBackgroundColor?: string;
- /**
- * The thickness of a scrolling track(not scrolling thumb).
- */
+ /** The thickness of a scrolling track (not scrolling thumb). */
barSize?: number;
- /**
- * The thickness of track border.
- */
+ /** The thickness of track border. */
barBorder?: number;
-
+ /** Enable the horizontal scroll bar. True by default. */
enableHorizontal?: boolean;
+ /** Enable the vertical scroll bar. True by default. */
enableVertical?: boolean;
-
- /**
- * The min width of horizon thumb
- */
+ /** The min width of horizon thumb. Default is 17 px. */
minThumbSizeH?: number;
-
- /**
- * The min height of vertical thumb
- */
+ /** The min height of vertical thumb. Default is 17 px. */
minThumbSizeV?: number;
}
diff --git a/packages/sheets-ui/src/controllers/config.schema.ts b/packages/sheets-ui/src/controllers/config.schema.ts
index acc1a91065..3da2c97fe2 100644
--- a/packages/sheets-ui/src/controllers/config.schema.ts
+++ b/packages/sheets-ui/src/controllers/config.schema.ts
@@ -75,6 +75,7 @@ export interface IUniverSheetsUIConfig {
hidePasteOptions?: boolean;
};
+ /** The config of the scroll bar. */
scrollConfig?: IScrollBarProps;
/**