@adecore/editor 0.23.0 → 0.23.1

package/dist/engine.js

@@ -50,6 +50,7 @@ class SmartEditor {
             messages: options.messages ?? {},
             label: options.label ?? DEFAULT_LABEL,
             guides: options.guides !== false,
+            stickyScroll: options.stickyScroll !== false,
             whitespace: options.whitespace === true,
             rightMargin: options.rightMargin ?? null,
             foldOutline: options.foldOutline ?? 'hover',
@@ -641,6 +642,10 @@ class SmartEditor {
         this.settings.guides = guides;
         this.view.applySettings();
     }
+    setStickyScroll(sticky) {
+        this.settings.stickyScroll = sticky;
+        this.view.applySettings();
+    }
     setWhitespace(whitespace) {
         this.settings.whitespace = whitespace;
         this.view.applySettings();

package/dist/fake.d.ts

@@ -119,9 +119,11 @@ export declare class FakeEditor implements Editor {
     enterScope(scope: readonly EditorBlock[]): void;
     smartKeys: Partial<EditorSmartKeys>;
     guides: boolean;
+    stickyScroll: boolean;
     whitespace: boolean;
     rightMargin: number | null;
     setGuides(guides: boolean): void;
+    setStickyScroll(sticky: boolean): void;
     setWhitespace(whitespace: boolean): void;
     setRightMargin(column: number | null): void;
     foldOutline: EditorFoldOutline;

package/dist/fake.js

@@ -380,11 +380,15 @@ export class FakeEditor {
     }
     smartKeys;
     guides = true;
+    stickyScroll = true;
     whitespace = false;
     rightMargin = null;
     setGuides(guides) {
         this.guides = guides;
     }
+    setStickyScroll(sticky) {
+        this.stickyScroll = sticky;
+    }
     setWhitespace(whitespace) {
         this.whitespace = whitespace;
     }

package/dist/types.d.ts

@@ -26,6 +26,7 @@ export interface EditorOptions {
     readonly indentation?: EditorIndentation;
     readonly smartKeys?: Partial<EditorSmartKeys>;
     readonly guides?: boolean;
+    readonly stickyScroll?: boolean;
     readonly whitespace?: boolean;
     readonly rightMargin?: number | null;
     readonly foldOutline?: EditorFoldOutline;
@@ -319,6 +320,7 @@ export interface Editor {
     setIndentation(indentation: EditorIndentation): void;
     setSmartKeys(keys: Partial<EditorSmartKeys>): void;
     setGuides(guides: boolean): void;
+    setStickyScroll?(sticky: boolean): void;
     setWhitespace(whitespace: boolean): void;
     setRightMargin(column: number | null): void;
     setFoldOutline(outline: EditorFoldOutline): void;

package/dist/view.d.ts

@@ -21,6 +21,7 @@ export interface ViewSettings {
     rightMargin: number | null;
     foldOutline: 'off' | 'hover' | 'always';
     folding?: boolean;
+    stickyScroll?: boolean;
 }
 export type ViewFold = Omit<FoldingRange, 'kind'> & {
     kind: FoldingRange['kind'] | 'custom';

package/dist/view.js

@@ -2294,6 +2294,9 @@ export class EditorView {
         return Math.min(STICKY_MAX_LINES, Math.floor(this.viewportHeight / this.layout.metrics.lineHeight / STICKY_ROW_SHARE));
     }
     stickyAt(scrollTop) {
+        if (this.settings.stickyScroll === false) {
+            return [];
+        }
         const { layout } = this;
         const bottomOf = (line) => {
             const row = layout.rowForLine(line);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adecore/editor",
-  "version": "0.23.0",
+  "version": "0.23.1",
   "type": "module",
   "exports": {
     ".": {
@@ -54,7 +54,7 @@
     "test": "bun test --conditions=source"
   },
   "dependencies": {
-    "@adecore/editor-core": "0.23.0",
+    "@adecore/editor-core": "0.23.1",
     "linkedom": "^0.18.13",
     "shiki": "^4.4.3"
   },

package/src/engine.ts

@@ -106,6 +106,7 @@ class SmartEditor implements Editor {
             messages: options.messages ?? {},
             label: options.label ?? DEFAULT_LABEL,
             guides: options.guides !== false,
+            stickyScroll: options.stickyScroll !== false,
             whitespace: options.whitespace === true,
             rightMargin: options.rightMargin ?? null,
             foldOutline: options.foldOutline ?? 'hover',
@@ -806,6 +807,11 @@ class SmartEditor implements Editor {
         this.view.applySettings();
     }
 
+    setStickyScroll(sticky: boolean): void {
+        this.settings.stickyScroll = sticky;
+        this.view.applySettings();
+    }
+
     setWhitespace(whitespace: boolean): void {
         this.settings.whitespace = whitespace;
         this.view.applySettings();

package/src/fake.ts

@@ -509,6 +509,7 @@ export class FakeEditor implements Editor {
     smartKeys: Partial<EditorSmartKeys>;
 
     guides = true;
+    stickyScroll = true;
     whitespace = false;
     rightMargin: number | null = null;
 
@@ -516,6 +517,10 @@ export class FakeEditor implements Editor {
         this.guides = guides;
     }
 
+    setStickyScroll(sticky: boolean): void {
+        this.stickyScroll = sticky;
+    }
+
     setWhitespace(whitespace: boolean): void {
         this.whitespace = whitespace;
     }

package/src/types.ts

@@ -63,6 +63,8 @@ export interface EditorOptions {
     readonly smartKeys?: Partial<EditorSmartKeys>;
     /* A line at each indentation level, the one of the scope around the caret stronger; on unless false. */
     readonly guides?: boolean;
+    /* The headers of the blocks scrolled out of sight stay pinned on top; on unless false. */
+    readonly stickyScroll?: boolean;
     /* Spaces drawn as dots and tabs as arrows; off unless true. */
     readonly whitespace?: boolean;
     /* The column to draw a line at, such as the `max_line_length` of a project; none by default. */
@@ -615,6 +617,8 @@ export interface Editor {
     /* Changes what it does as a person types; the keys left out stay as they are. */
     setSmartKeys(keys: Partial<EditorSmartKeys>): void;
     setGuides(guides: boolean): void;
+    /* Optional so an editor from before it still fits. */
+    setStickyScroll?(sticky: boolean): void;
     setWhitespace(whitespace: boolean): void;
     /* The column to draw a line at; null takes it away. */
     setRightMargin(column: number | null): void;

package/src/view.ts

@@ -114,6 +114,8 @@ export interface ViewSettings {
     /* When the arrow that folds a block shows in the gutter. */
     foldOutline: 'off' | 'hover' | 'always';
     folding?: boolean;
+    /* The headers of the blocks scrolled out of sight stay pinned on top; on unless false. */
+    stickyScroll?: boolean;
 }
 
 /* The lines past the visible ones that are colored ahead of the scroll, and how long one slice of that work may take. */
@@ -2654,6 +2656,9 @@ export class EditorView {
     }
 
     private stickyAt(scrollTop: number): StickyPlacement[] {
+        if (this.settings.stickyScroll === false) {
+            return [];
+        }
         const { layout } = this;
         const bottomOf = (line: number): number => {
             const row = layout.rowForLine(line);