Merge pull request #196 from SenteraLLC/fix/set-saved-simplification

fix/set saved simplification

CHANGELOG.md

@@ -6,6 +6,10 @@ All notable changes to this project will be documented here.
 
 Nothing yet.
 
+## [0.15.2] - Oct 4th, 2024
+- Change `set_saved` on submit buttons to be a true boolean,
+rather than an optional boolean that could needlessly force a reload prompt
+
 ## [0.15.1] - Oct 4th, 2024
 - Change deprecation cases to use dedicated `mark_deprecated` function
 

api_spec.md

@@ -116,7 +116,11 @@ If either more than one submit button or more button customization is desired, t
         // If submit is unsuccessful and annotations edits should not be treated as "saved", return false
     },
     color?: "Arbitrary Color" // e.g. "#639", "#3AB890", "rgb(200, 0, 170)", "hsl(0, 100%, 50%)"
-    set_saved?: boolean // If true, will call ulabel.set_saved(true) before the hook is called, thus avoiding the "unsaved changes" warning
+    /**
+     * If true, will call ulabel.set_saved(true) before the hook is called,
+     * thus avoid the "unsaved changes" warning. Defaults to false.
+     */
+    set_saved?: boolean 
     size_factor?: number // Transform the default button size by this factor.
     row_number?: number // The row number of the button in the toolbox
     // Buttons with lower row numbers will be higher in the toolbox

index.d.ts

@@ -106,6 +106,10 @@ export type ULabelSubmitButton = {
     name: string;
     hook: (submit_data: ULabelSubmitData) => void;
     color?: string;
+    /**
+     * Whether or not the button should call `set_saved(true)`
+     * on the ULabel object when clicked. Defaults to false.
+     */
     set_saved?: boolean;
     size_factor?: number;
     row_number?: number;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ulabel",
   "description": "An image annotation tool.",
-  "version": "0.15.1",
+  "version": "0.15.2",
   "main": "dist/ulabel.js",
   "module": "dist/ulabel.js",
   "scripts": {

src/toolbox.ts

@@ -2417,6 +2417,11 @@ export class SubmitButtons extends ToolboxItem {
         // Grab the submit buttons from ulabel
         this.submit_buttons = ulabel.config.submit_buttons;
 
+        // Set `set_saved` to false if not provided
+        for (const button of this.submit_buttons) {
+            button.set_saved = button.set_saved ?? false;
+        }
+
         this.add_styles();
 
         this.add_event_listeners();
@@ -2427,6 +2432,7 @@ export class SubmitButtons extends ToolboxItem {
                 name: "Submit",
                 hook: this.submit_buttons,
                 row_number: 0,
+                set_saved: false,
             }];
         }
 
@@ -2486,8 +2492,8 @@ export class SubmitButtons extends ToolboxItem {
                 }
 
                 // Set set_saved if it was provided
-                if (this.submit_buttons[idx].set_saved !== undefined) {
-                    ulabel.set_saved(this.submit_buttons[idx].set_saved);
+                if (this.submit_buttons[idx].set_saved) {
+                    ulabel.set_saved(true);
                 }
 
                 await this.submit_buttons[idx].hook(submit_payload);

src/version.js

@@ -1 +1 @@
-export const ULABEL_VERSION = "0.15.1";
+export const ULABEL_VERSION = "0.15.2";