js-draw 1.2.2 → 1.3.1

package/dist/mjs/tools/ScrollbarTool.mjs

@@ -0,0 +1,79 @@
+import { Rect2 } from '@js-draw/math';
+import  { EditorEventType }  from '../types.mjs';
+import  BaseTool  from './BaseTool.mjs';
+/**
+ * This tool, when enabled, renders scrollbars reflecting the current position
+ * of the view relative to the import/export area of the image.
+ *
+ * **Note**: These scrollbars are currently not draggable. This may change in
+ * a future release.
+ */
+export default class ScrollbarTool extends BaseTool {
+    constructor(editor) {
+        super(editor.notifier, 'scrollbar');
+        this.editor = editor;
+        this.fadeOutTimeout = null;
+        this.scrollbarOverlay = document.createElement('div');
+        this.scrollbarOverlay.classList.add('ScrollbarTool-overlay');
+        this.verticalScrollbar = document.createElement('div');
+        this.verticalScrollbar.classList.add('vertical-scrollbar');
+        this.horizontalScrollbar = document.createElement('div');
+        this.horizontalScrollbar.classList.add('horizontal-scrollbar');
+        this.scrollbarOverlay.replaceChildren(this.verticalScrollbar, this.horizontalScrollbar);
+        let overlay = null;
+        let viewportListener = null;
+        this.enabledValue().onUpdateAndNow(enabled => {
+            overlay?.remove();
+            viewportListener?.remove();
+            viewportListener = null;
+            overlay = null;
+            if (enabled) {
+                viewportListener = editor.notifier.on(EditorEventType.ViewportChanged, _event => {
+                    this.updateScrollbars();
+                });
+                this.updateScrollbars();
+                overlay = editor.createHTMLOverlay(this.scrollbarOverlay);
+            }
+        });
+    }
+    updateScrollbars() {
+        const viewport = this.editor.viewport;
+        const screenSize = viewport.getScreenRectSize();
+        const screenRect = new Rect2(0, 0, screenSize.x, screenSize.y);
+        const imageRect = this.editor.getImportExportRect()
+            // The scrollbars are positioned in screen coordinates, so the exportRect also needs
+            // to be in screen coordinates
+            .transformedBoundingBox(viewport.canvasToScreenTransform)
+            // If the screenRect is outside of the exportRect, expand the image rectangle
+            .union(screenRect);
+        const scrollbarWidth = screenRect.width / imageRect.width * screenSize.x;
+        const scrollbarHeight = screenRect.height / imageRect.height * screenSize.y;
+        const scrollbarX = (screenRect.x - imageRect.x) / imageRect.width * (screenSize.x);
+        const scrollbarY = (screenRect.y - imageRect.y) / imageRect.height * (screenSize.y);
+        this.horizontalScrollbar.style.width = `${scrollbarWidth}px`;
+        this.verticalScrollbar.style.height = `${scrollbarHeight}px`;
+        this.horizontalScrollbar.style.marginLeft = `${scrollbarX}px`;
+        this.verticalScrollbar.style.marginTop = `${scrollbarY}px`;
+        // Style the scrollbars differently when there's no scroll (all content visible)
+        const handleNoScrollStyling = (scrollbar, size, fillSize) => {
+            const fillsWindowClass = 'represents-no-scroll';
+            if (Math.abs(size - fillSize) < 1e-8) {
+                scrollbar.classList.add(fillsWindowClass);
+            }
+            else {
+                scrollbar.classList.remove(fillsWindowClass);
+            }
+        };
+        handleNoScrollStyling(this.horizontalScrollbar, scrollbarWidth, screenSize.x);
+        handleNoScrollStyling(this.verticalScrollbar, scrollbarHeight, screenSize.y);
+        // Fade out after a delay.
+        if (this.fadeOutTimeout !== null) {
+            clearTimeout(this.fadeOutTimeout);
+        }
+        const fadeOutDelay = 3000;
+        this.fadeOutTimeout = setTimeout(() => {
+            this.scrollbarOverlay.classList.remove('just-updated');
+        }, fadeOutDelay);
+        this.scrollbarOverlay.classList.add('just-updated');
+    }
+}

package/dist/mjs/tools/SelectionTool/SelectionTool.selecting.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/mjs/tools/ToolController.mjs

@@ -18,6 +18,7 @@ import  SoundUITool  from './SoundUITool.mjs';
 import  { InputEvtType }  from '../inputEvents.mjs';
 import  InputPipeline  from './InputFilter/InputPipeline.mjs';
 import  InputStabilizer  from './InputFilter/InputStabilizer.mjs';
+import  ScrollbarTool  from './ScrollbarTool.mjs';
 export default class ToolController {
     /** @internal */
     constructor(editor, localization) {
@@ -51,6 +52,7 @@ export default class ToolController {
         const soundExplorer = new SoundUITool(editor, localization.soundExplorer);
         soundExplorer.setEnabled(false);
         this.tools = [
+            new ScrollbarTool(editor),
             new PipetteTool(editor, localization.pipetteTool),
             soundExplorer,
             panZoomTool,

package/dist/mjs/types.d.ts

@@ -82,7 +82,9 @@ export interface ToolbarDropdownShownEvent {
 export type EditorEventDataType = EditorToolEvent | EditorObjectEvent | EditorViewportChangedEvent | DisplayResizedEvent | EditorUndoStackUpdated | CommandDoneEvent | CommandUndoneEvent | SelectionUpdated | ColorPickerToggled | ColorPickerColorSelected | ToolbarDropdownShownEvent;
 export type OnProgressListener = (amountProcessed: number, totalToProcess: number) => Promise<void> | null | void;
 export type ComponentAddedListener = (component: AbstractComponent) => Promise<void> | void;
-export type OnDetermineExportRectListener = (exportRect: Rect2) => void;
+export type OnDetermineExportRectListener = (exportRect: Rect2, options?: {
+    autoresize: boolean;
+}) => void;
 export interface ImageLoader {
     start(onAddComponent: ComponentAddedListener, onProgressListener: OnProgressListener, onDetermineExportRect?: OnDetermineExportRectListener): Promise<void>;
 }

package/dist/mjs/util/assertions.d.ts

@@ -21,3 +21,7 @@ export declare const assertIsNumber: (value: any, allowNaN?: boolean) => value i
  * Throws if any of `values` is not of type number.
  */
 export declare const assertIsNumberArray: (values: any[], allowNaN?: boolean) => values is number[];
+/**
+ * Throws an exception if `typeof value` is not a boolean.
+ */
+export declare const assertIsBoolean: (value: any) => value is boolean;

package/dist/mjs/util/assertions.mjs

@@ -43,3 +43,13 @@ export const assertIsNumberArray = (values, allowNaN = false) => {
     }
     return true;
 };
+/**
+ * Throws an exception if `typeof value` is not a boolean.
+ */
+export const assertIsBoolean = (value) => {
+    if (typeof value !== 'boolean') {
+        throw new Error('Given value is not a boolean');
+        // return false;
+    }
+    return true;
+};

package/dist/mjs/version.mjs

@@ -1,3 +1,3 @@
 export default {
-    number: '1.2.2',
+    number: '1.3.1',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-draw",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "description": "Draw pictures using a pen, touchscreen, or mouse! JS-draw is a drawing library for JavaScript and TypeScript. ",
   "types": "./dist/mjs/lib.d.ts",
   "main": "./dist/cjs/lib.js",
@@ -64,12 +64,11 @@
     "postpack": "ts-node tools/copyREADME.ts revert"
   },
   "dependencies": {
-    "@js-draw/math": "^1.2.2",
+    "@js-draw/math": "^1.3.1",
     "@melloware/coloris": "0.21.0"
   },
   "devDependencies": {
     "@js-draw/build-tool": "^1.0.2",
-    "@types/bezier-js": "4.1.0",
     "@types/jest": "29.5.3",
     "@types/jsdom": "21.1.1"
   },
@@ -87,5 +86,5 @@
     "freehand",
     "svg"
   ],
-  "gitHead": "ced98ae289f299c44b54515571d0087aa6d32cdc"
+  "gitHead": "65af7ec944f70b69b2a4b07d98e5bb92eeeca029"
 }

package/src/Editor.scss

@@ -136,6 +136,14 @@
 	z-index: 5;
 }
 
+// TODO: Apply this change during a future major release.
+// So as not to change the position of other overlays, all overlays should have
+// 0 height.
+// Uses the alternate overlay class name to decrease specificity.
+// .js-draw-editor-overlay {
+// 	//height: 0;
+// }
+
 @media print {
 	.imageEditorContainer .loadingMessage {
 		display: none;

package/src/dialogs/dialogs.scss

@@ -1,7 +1,8 @@
 
 @use './makeAboutDialog.scss';
 
-.dialog-container {
+// Repeat to increase specificity -- dialog containers are often overlays
+.dialog-container.dialog-container {
 	background-color: var( --background-color-transparent);
 
 	backdrop-filter: blur(5px);

package/src/toolbar/EdgeToolbar.scss

@@ -480,6 +480,8 @@
 	.toolbar-spacedList {
 		box-sizing: border-box;
 
+		--align-items-to-x: 105px;
+
 		& > div {
 			display: flex;
 			align-items: center;
@@ -491,7 +493,7 @@
 			// Align inputs (assumes labels come first)
 			& > label {
 				padding-right: 35px;
-				min-width: 105px;
+				min-width: var(--align-items-to-x);
 				flex-shrink: 1;
 				box-sizing: border-box;
 			}
@@ -499,6 +501,7 @@
 			& > input[type="checkbox"] {
 				width: 20px;
 				height: 20px;
+				margin-left: 0;
 			}
 
 			// If checkboxes have flex-grow, the checkbox region can become centered.

package/src/toolbar/widgets/DocumentPropertiesWidget.scss

@@ -4,4 +4,16 @@
 		width: 100%;
 		text-align: end;
 	}
+
+	& > * {
+		--align-items-to-x: 120px;
+	}
+
+	.js-draw-size-input-row.js-draw-size-input-row {
+		display: flex;
+
+		&.size-input-row--automatic-size {
+			display: none;
+		}
+	}
 }

package/src/toolbar/widgets/components/makeGridSelector.scss

@@ -20,7 +20,7 @@
 		flex-shrink: 1;
 		margin: 2px;
 
-		&:focus-within {
+		&.focus-visible {
 			outline: 2px solid var(--foreground-color-1);
 		}
 

package/src/tools/ScrollbarTool.scss

@@ -0,0 +1,57 @@
+
+.ScrollbarTool-overlay {
+	width: 0;
+	height: 0;
+	overflow: visible;
+
+	$visible-opacity: 0.2;
+	opacity: $visible-opacity;
+	pointer-events: none;
+
+	--fade-out-animation: 1s ease 0s fade-out;
+
+	@media (prefers-reduced-motion: reduce) {
+		--fade-out-animation: none !important;
+	}
+
+	@keyframes fade-out {
+		from { opacity: $visible-opacity; }
+		to { opacity: 0; }
+	}
+
+	&:not(.just-updated) {
+		animation: var(--fade-out-animation);
+		opacity: 0;
+	}
+
+	--scrollbar-size: 3px;
+
+	.vertical-scrollbar, .horizontal-scrollbar {
+		width: var(--scrollbar-size);
+		height: var(--scrollbar-size);
+
+		min-width: var(--scrollbar-size);
+		min-height: var(--scrollbar-size);
+
+		background-color: var(--foreground-color-1);
+		border-radius: var(--scrollbar-size);
+		position: absolute;
+
+		&.represents-no-scroll {
+			animation: var(--fade-out-animation);
+			opacity: 0;
+		}
+	}
+
+	&:not(.scrollbar-left) {
+		.vertical-scrollbar {
+			margin-left: calc(var(--editor-current-display-width-px) - var(--scrollbar-size));
+		}
+	}
+	
+	&:not(.scrollbar-top) {
+		.horizontal-scrollbar {
+			margin-top: calc(var(--editor-current-display-height-px) - var(--scrollbar-size));
+		}
+	}
+}

package/src/tools/{SoundUITool.css → SoundUITool.scss}

@@ -5,6 +5,10 @@
 	overflow: hidden;    
 }
 
+.js-draw-sound-ui-toggle button {
+	margin-top: 1px;
+}
+
 .js-draw-sound-ui-toggle:focus-within, .js-draw-sound-ui-toggle.sound-ui-tool-enabled {
 	overflow: visible;
 	z-index: 5;

package/src/tools/tools.scss

@@ -1,4 +1,5 @@
 
+@use "./ScrollbarTool.scss";
 @use "./SelectionTool/SelectionTool.css";
 @use "./FindTool.css";
-@use "./SoundUITool.css";
+@use "./SoundUITool.scss";