@batchfy/codemirror-minimap 0.1.0 → 0.1.1

package/README.md

@@ -2,6 +2,11 @@
 
 A minimap for CodeMirror 6.
 
+[![npm](https://img.shields.io/npm/v/@batchfy/codemirror-minimap)](https://www.npmjs.com/package/@batchfy/codemirror-minimap)
+
+Published on npm as
+[**@batchfy/codemirror-minimap**](https://www.npmjs.com/package/@batchfy/codemirror-minimap).
+
 ## Installation
 
 ```

package/dist/Overlay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Overlay.d.ts","sourceRoot":"","sources":["../src/Overlay.ts"],"names":[],"mappings":"AA+TA,eAAO,MAAM,OAAO,yCAAuB,CAAC"}
+{"version":3,"file":"Overlay.d.ts","sourceRoot":"","sources":["../src/Overlay.ts"],"names":[],"mappings":"AAgWA,eAAO,MAAM,OAAO,yCAAuB,CAAC"}

package/dist/geometry.d.ts

@@ -0,0 +1,130 @@
+import { EditorView } from "@codemirror/view";
+import { type Lines } from "./LinesState.js";
+/** Editor pixels that fit into a single minimap pixel. */
+export declare const SCALE: number;
+export type LayoutInput = {
+    /** Rows the minimap draws: one per line it lays out, folds collapsed. */
+    rowCount: number;
+    /** Height of one row. */
+    lineHeight: number;
+    paddingTop: number;
+    paddingBottom: number;
+    /** Height of the visible minimap. */
+    height: number;
+    /** Rows the editor currently shows on screen, inclusive. */
+    firstVisibleRow: number;
+    lastVisibleRow: number;
+    /**
+     * Rows a screenful holds when none of its lines wrap.
+     *
+     * How many rows are on screen right now swings with how much the lines on
+     * it wrap: a screen of code holds many lines, a screen of prose few. This
+     * count follows from the editor's height and its line height alone, so it
+     * holds still while the document scrolls.
+     */
+    rowsPerScreen: number;
+};
+export type Layout = {
+    /** Height of every row plus the document padding. */
+    contentHeight: number;
+    /** How far the rows are scrolled up inside the visible minimap. */
+    scrollTop: number;
+    /** Position of the viewport overlay inside the visible minimap. */
+    overlayTop: number;
+    overlayHeight: number;
+    /** Rows the minimap has to draw, carried through for the inverse. */
+    rowCount: number;
+    /**
+     * Rows the document can scroll through if none of its lines wrap: the ones
+     * past the first screenful.
+     *
+     * Wrapping puts fewer document lines on a screen than there are rows in it,
+     * so the editor can carry on past this — `rowAtOverlayTop` covers the rest.
+     */
+    scrollableRows: number;
+    /**
+     * How far the overlay's top edge moves between the first row of the
+     * document and the last, and so how far a drag has to travel to cross the
+     * document. It is `overlayTravel / scrollableRows` per row, which is what
+     * `rowAtOverlayTop` inverts.
+     */
+    overlayTravel: number;
+};
+/**
+ * Places the rows and the viewport overlay together.
+ *
+ * The overlay marks lines, not pixels, so its position cannot be derived from
+ * the editor's scroll offset: a wrapped line takes several rows of the editor
+ * and one row of the minimap, so equal scroll fractions stop meaning equal
+ * positions as soon as wrapping, folding or line-height variation enters the
+ * document. Both halves are therefore anchored on the rows that are actually on
+ * screen, which keeps the overlay on top of the content it stands for.
+ *
+ * The rows scroll in step with progress through the document, so the overlay
+ * ends up where that progress says it should: at the top on the first row, at
+ * the bottom on the last. Near either end, and whenever the rows have less to
+ * give than the progress asks for, the rows stop and the overlay takes over the
+ * remaining travel — covering its own rows always wins over sitting where the
+ * scroll fraction would like it to.
+ */
+export declare function computeLayout(input: LayoutInput): Layout;
+export type Geometry = Layout & {
+    lineHeight: number;
+    paddingTop: number;
+    paddingBottom: number;
+    /** Height of the visible minimap. */
+    height: number;
+};
+/**
+ * The part of the geometry that scrolling does not change.
+ *
+ * Everything here follows from the document's length, the theme's row height
+ * and the size of the editor, so it holds still while the document moves under
+ * the overlay. A drag can therefore measure it once at the outset instead of on
+ * every report from the pointer — and the type is the argument that this is
+ * safe, since a function given only these values cannot read the scroll
+ * position it would be caching past.
+ */
+export type StableGeometry = Pick<Geometry, "paddingTop" | "lineHeight" | "rowCount" | "scrollableRows" | "overlayTravel">;
+export declare function setRowHeight(view: EditorView, canvasLineHeight: number): void;
+/** Index of the row the minimap draws the given document position on. */
+export declare function rowAtPos(lines: Lines, pos: number): number;
+/**
+ * Where the minimap draws its rows and its overlay for the current state.
+ *
+ * `token` stands for the moment being drawn: anything measured for the same
+ * token describes the same moment, so it is measured once. Callers with no
+ * moment to name pass nothing and get a fresh measurement.
+ */
+export declare function readGeometry(view: EditorView, token?: object): Geometry;
+/** The row drawn `y` pixels below the top of the visible minimap. */
+export declare function rowAtY(geometry: Geometry, y: number): number;
+/**
+ * The row the editor would have to put at the top of its viewport for the
+ * overlay to sit at `overlayTop`.
+ *
+ * This is the inverse of the placement `computeLayout` performs, so dragging
+ * the overlay to a position and letting the layout put it back lands on the
+ * same pixel. It cannot be read off `rowAtY`: the rows underneath the overlay
+ * scroll as the overlay moves, so the row drawn at a position is not the row
+ * that would be on screen were the overlay taken there.
+ *
+ * The answer carries its fraction. A whole number of rows is not enough to
+ * reach the end of a document: the editor stops with the last line against the
+ * foot of the viewport, which in general falls part-way through a row, and a
+ * drag that could only name whole rows would stop short of it by that part and
+ * need a jump to finish.
+ */
+export declare function rowAtOverlayTop(geometry: StableGeometry, overlayTop: number): number;
+/**
+ * Scrolls the editor until `row` sits `offset` pixels down the viewport.
+ *
+ * `row` may name a point inside a row rather than the start of one, and the
+ * fraction is taken against that row's own height so that it means the same
+ * part of a wrapped line as of an unwrapped one. Scrolling to whole rows is
+ * enough for a click, which is aiming at a line; a drag needs the fraction, or
+ * it cannot follow the pointer through the last part of a row and stops short
+ * of the end of the document.
+ */
+export declare function scrollToRow(view: EditorView, row: number, offset?: number): void;
+//# sourceMappingURL=geometry.d.ts.map

package/dist/geometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geometry.d.ts","sourceRoot":"","sources":["../src/geometry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAc,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAEzD,0DAA0D;AAC1D,eAAO,MAAM,KAAK,QAA0C,CAAC;AAK7D,MAAM,MAAM,WAAW,GAAG;IACtB,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;;;OAOG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACjB,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAqDxD;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,QAAQ,EACN,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,gBAAgB,GAChB,eAAe,CACpB,CAAC;AAYF,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,QAOtE;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAgB1D;AAuDD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,CAgBvE;AA0BD,qEAAqE;AACrE,wBAAgB,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAO5D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,cAAc,EACxB,UAAU,EAAE,MAAM,GACnB,MAAM,CAoCR;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI,QAyBpE"}

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAA0B,MAAM,kBAAkB,CAAC;AAEtE,OAAO,EAAU,OAAO,EAAS,MAAM,aAAa,CAAC;AAgVrD,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IAC3D;;OAEG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK;QAAE,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;CACtD;AAED;;;;;GAKG;AACH,QAAA,MAAM,WAAW,mDAaf,CAAC;AAEH,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAA0B,MAAM,kBAAkB,CAAC;AAEtE,OAAO,EAAU,OAAO,EAAS,MAAM,aAAa,CAAC;AA8VrD,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IAC3D;;OAEG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK;QAAE,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC;CACtD;AAED;;;;;GAKG;AACH,QAAA,MAAM,WAAW,mDAaf,CAAC;AAEH,OAAO,EAAE,WAAW,EAAE,CAAC"}