3b7323e2e9630694696b3ca338c2e646420b4648 Fix: Ensure that all confirm…

…ation messages quote the state name Fix: If Ajax loading a state, it wasn't possible to then update it Fix: Hide the "include" checkbox title if there are no checkboxes to show Fix: List of state buttons was only showing if the state restore button was the first in the collection Dev: createButton callback option - not yet publically documented Dev: createState callback option - also not yet publically documented 1df5de850c73211093120aa18b201de84aae9b3f Merge branch 'master' of github.com:DataTables/StateRestore Sync to source repo @1df5de850c73211093120aa18b201de84aae9b3f
DataTables · Oct 4, 2024 · a3902ac · a3902ac
1 parent 3373341
commit a3902ac
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 43 deletions.
diff --git a/datatables.json b/datatables.json
@@ -18,5 +18,5 @@
     ],
     "src-repo": "http://github.com/DataTables/StateRestore",
     "last-tag": "1.4.1",
-    "last-sync": "169b120d2ff1068804e727c6e89738deddfb620c"
+    "last-sync": "1df5de850c73211093120aa18b201de84aae9b3f"
 }
diff --git a/js/StateRestore.js b/js/StateRestore.js
@@ -26,7 +26,7 @@ var StateRestore = /** @class */ (function () {
             dt: table,
             identifier: identifier,
             isPreDefined: isPreDefined,
-            savedState: null,
+            savedState: state,
             tableId: state && state.stateRestore ? state.stateRestore.tableId : undefined
         };
         this.dom = {
@@ -750,13 +750,13 @@ var StateRestore = /** @class */ (function () {
             duplicateError: 'A state with this name already exists.',
             emptyError: 'Name cannot be empty.',
             emptyStates: 'No saved states',
-            removeConfirm: 'Are you sure you want to remove %s?',
+            removeConfirm: 'Are you sure you want to remove "%s"?',
             removeError: 'Failed to remove state.',
             removeJoiner: ' and ',
             removeSubmit: 'Remove',
             removeTitle: 'Remove State',
             renameButton: 'Rename',
-            renameLabel: 'New Name for %s:',
+            renameLabel: 'New Name for "%s":',
             renameTitle: 'Rename State'
         },
         modalCloseButton: true,
@@ -797,7 +797,9 @@ var StateRestore = /** @class */ (function () {
             searchBuilder: false,
             searchPanes: false,
             select: false
-        }
+        },
+        createButton: null,
+        createState: null
     };
     return StateRestore;
 }());

diff --git a/js/StateRestoreCollection.js b/js/StateRestoreCollection.js
@@ -428,10 +428,18 @@ var StateRestoreCollection = /** @class */ (function () {
                 that._collectionRebuild();
             };
             var loadedState = preDefined[state];
-            var newState = new StateRestore(this_1.s.dt, $.extend(true, {}, this_1.c, loadedState.c !== undefined ?
-                { saveState: loadedState.c.saveState } :
-                undefined, true), state, loadedState, true, successCallback);
-            newState.s.savedState = loadedState;
+            var stateConfig = $.extend(true, {}, this_1.c, loadedState.c !== undefined ?
+                {
+                    saveState: loadedState.c.saveState,
+                    remove: loadedState.c.remove,
+                    rename: loadedState.c.rename,
+                    save: loadedState.c.save
+                } :
+                undefined, true);
+            if (this_1.c.createState) {
+                this_1.c.createState(stateConfig, loadedState);
+            }
+            var newState = new StateRestore(this_1.s.dt, stateConfig, state, loadedState, true, successCallback);
             $(this_1.s.dt.table().node()).on('dtsr-modal-inserted', function () {
                 newState.dom.confirmation.one('dtsr-remove', function () { return _this._removeCallback(newState.s.identifier); });
                 newState.dom.confirmation.one('dtsr-rename', function () { return _this._collectionRebuild(); });
@@ -517,7 +525,7 @@ var StateRestoreCollection = /** @class */ (function () {
                 if (split.includes('removeState') && (!this.c.remove || !state.c.remove)) {
                     split.splice(split.indexOf('removeState'), 1);
                 }
-                stateButtons.push({
+                var buttonConfig = {
                     _stateRestore: state,
                     attr: {
                         title: state.s.identifier
@@ -528,7 +536,11 @@ var StateRestoreCollection = /** @class */ (function () {
                     extend: 'stateRestore',
                     text: StateRestore.entityEncode(state.s.identifier),
                     popoverTitle: StateRestore.entityEncode(state.s.identifier)
-                });
+                };
+                if (this.c.createButton) {
+                    this.c.createButton(buttonConfig, state.s.savedState);
+                }
+                stateButtons.push(buttonConfig);
             }
         }
         button.collectionRebuild(stateButtons);
@@ -1024,7 +1036,9 @@ var StateRestoreCollection = /** @class */ (function () {
             searchBuilder: false,
             searchPanes: false,
             select: false
-        }
+        },
+        createButton: null,
+        createState: null
     };
     return StateRestoreCollection;
 }());

diff --git a/js/dataTables.stateRestore.js b/js/dataTables.stateRestore.js
@@ -79,7 +79,7 @@ var DataTable = $.fn.dataTable;
                 dt: table,
                 identifier: identifier,
                 isPreDefined: isPreDefined,
-                savedState: null,
+                savedState: state,
                 tableId: state && state.stateRestore ? state.stateRestore.tableId : undefined
             };
             this.dom = {
@@ -803,13 +803,13 @@ var DataTable = $.fn.dataTable;
                 duplicateError: 'A state with this name already exists.',
                 emptyError: 'Name cannot be empty.',
                 emptyStates: 'No saved states',
-                removeConfirm: 'Are you sure you want to remove %s?',
+                removeConfirm: 'Are you sure you want to remove "%s"?',
                 removeError: 'Failed to remove state.',
                 removeJoiner: ' and ',
                 removeSubmit: 'Remove',
                 removeTitle: 'Remove State',
                 renameButton: 'Rename',
-                renameLabel: 'New Name for %s:',
+                renameLabel: 'New Name for "%s":',
                 renameTitle: 'Rename State'
             },
             modalCloseButton: true,
@@ -850,7 +850,9 @@ var DataTable = $.fn.dataTable;
                 searchBuilder: false,
                 searchPanes: false,
                 select: false
-            }
+            },
+            createButton: null,
+            createState: null
         };
         return StateRestore;
     }());
@@ -1284,10 +1286,18 @@ var DataTable = $.fn.dataTable;
                     that._collectionRebuild();
                 };
                 var loadedState = preDefined[state];
-                var newState = new StateRestore(this_1.s.dt, $$1.extend(true, {}, this_1.c, loadedState.c !== undefined ?
-                    { saveState: loadedState.c.saveState } :
-                    undefined, true), state, loadedState, true, successCallback);
-                newState.s.savedState = loadedState;
+                var stateConfig = $$1.extend(true, {}, this_1.c, loadedState.c !== undefined ?
+                    {
+                        saveState: loadedState.c.saveState,
+                        remove: loadedState.c.remove,
+                        rename: loadedState.c.rename,
+                        save: loadedState.c.save
+                    } :
+                    undefined, true);
+                if (this_1.c.createState) {
+                    this_1.c.createState(stateConfig, loadedState);
+                }
+                var newState = new StateRestore(this_1.s.dt, stateConfig, state, loadedState, true, successCallback);
                 $$1(this_1.s.dt.table().node()).on('dtsr-modal-inserted', function () {
                     newState.dom.confirmation.one('dtsr-remove', function () { return _this._removeCallback(newState.s.identifier); });
                     newState.dom.confirmation.one('dtsr-rename', function () { return _this._collectionRebuild(); });
@@ -1373,7 +1383,7 @@ var DataTable = $.fn.dataTable;
                     if (split.includes('removeState') && (!this.c.remove || !state.c.remove)) {
                         split.splice(split.indexOf('removeState'), 1);
                     }
-                    stateButtons.push({
+                    var buttonConfig = {
                         _stateRestore: state,
                         attr: {
                             title: state.s.identifier
@@ -1384,7 +1394,11 @@ var DataTable = $.fn.dataTable;
                         extend: 'stateRestore',
                         text: StateRestore.entityEncode(state.s.identifier),
                         popoverTitle: StateRestore.entityEncode(state.s.identifier)
-                    });
+                    };
+                    if (this.c.createButton) {
+                        this.c.createButton(buttonConfig, state.s.savedState);
+                    }
+                    stateButtons.push(buttonConfig);
                 }
             }
             button.collectionRebuild(stateButtons);
@@ -1880,7 +1894,9 @@ var DataTable = $.fn.dataTable;
                 searchBuilder: false,
                 searchPanes: false,
                 select: false
-            }
+            },
+            createButton: null,
+            createState: null
         };
         return StateRestoreCollection;
     }());
@@ -2147,8 +2163,9 @@ var DataTable = $.fn.dataTable;
                         0;
             });
             var button = dt.button('SaveStateRestore:name');
-            var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[0].buttons !== undefined ?
-                button[0].inst.c.buttons[0].buttons :
+            var buttonIndex = parseInt(button.index());
+            var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[buttonIndex].buttons !== undefined ?
+                button[0].inst.c.buttons[buttonIndex].buttons :
                 [];
             // remove any states from the previous rebuild - if they are still there they will be added later
             for (var i = 0; i < stateButtons.length; i++) {

diff --git a/js/dataTables.stateRestore.min.js b/js/dataTables.stateRestore.min.js
diff --git a/js/dataTables.stateRestore.min.mjs b/js/dataTables.stateRestore.min.mjs
diff --git a/js/dataTables.stateRestore.mjs b/js/dataTables.stateRestore.mjs
@@ -39,7 +39,7 @@ let $ = jQuery;
                 dt: table,
                 identifier: identifier,
                 isPreDefined: isPreDefined,
-                savedState: null,
+                savedState: state,
                 tableId: state && state.stateRestore ? state.stateRestore.tableId : undefined
             };
             this.dom = {
@@ -763,13 +763,13 @@ let $ = jQuery;
                 duplicateError: 'A state with this name already exists.',
                 emptyError: 'Name cannot be empty.',
                 emptyStates: 'No saved states',
-                removeConfirm: 'Are you sure you want to remove %s?',
+                removeConfirm: 'Are you sure you want to remove "%s"?',
                 removeError: 'Failed to remove state.',
                 removeJoiner: ' and ',
                 removeSubmit: 'Remove',
                 removeTitle: 'Remove State',
                 renameButton: 'Rename',
-                renameLabel: 'New Name for %s:',
+                renameLabel: 'New Name for "%s":',
                 renameTitle: 'Rename State'
             },
             modalCloseButton: true,
@@ -810,7 +810,9 @@ let $ = jQuery;
                 searchBuilder: false,
                 searchPanes: false,
                 select: false
-            }
+            },
+            createButton: null,
+            createState: null
         };
         return StateRestore;
     }());
@@ -1244,10 +1246,18 @@ let $ = jQuery;
                     that._collectionRebuild();
                 };
                 var loadedState = preDefined[state];
-                var newState = new StateRestore(this_1.s.dt, $$1.extend(true, {}, this_1.c, loadedState.c !== undefined ?
-                    { saveState: loadedState.c.saveState } :
-                    undefined, true), state, loadedState, true, successCallback);
-                newState.s.savedState = loadedState;
+                var stateConfig = $$1.extend(true, {}, this_1.c, loadedState.c !== undefined ?
+                    {
+                        saveState: loadedState.c.saveState,
+                        remove: loadedState.c.remove,
+                        rename: loadedState.c.rename,
+                        save: loadedState.c.save
+                    } :
+                    undefined, true);
+                if (this_1.c.createState) {
+                    this_1.c.createState(stateConfig, loadedState);
+                }
+                var newState = new StateRestore(this_1.s.dt, stateConfig, state, loadedState, true, successCallback);
                 $$1(this_1.s.dt.table().node()).on('dtsr-modal-inserted', function () {
                     newState.dom.confirmation.one('dtsr-remove', function () { return _this._removeCallback(newState.s.identifier); });
                     newState.dom.confirmation.one('dtsr-rename', function () { return _this._collectionRebuild(); });
@@ -1333,7 +1343,7 @@ let $ = jQuery;
                     if (split.includes('removeState') && (!this.c.remove || !state.c.remove)) {
                         split.splice(split.indexOf('removeState'), 1);
                     }
-                    stateButtons.push({
+                    var buttonConfig = {
                         _stateRestore: state,
                         attr: {
                             title: state.s.identifier
@@ -1344,7 +1354,11 @@ let $ = jQuery;
                         extend: 'stateRestore',
                         text: StateRestore.entityEncode(state.s.identifier),
                         popoverTitle: StateRestore.entityEncode(state.s.identifier)
-                    });
+                    };
+                    if (this.c.createButton) {
+                        this.c.createButton(buttonConfig, state.s.savedState);
+                    }
+                    stateButtons.push(buttonConfig);
                 }
             }
             button.collectionRebuild(stateButtons);
@@ -1840,7 +1854,9 @@ let $ = jQuery;
                 searchBuilder: false,
                 searchPanes: false,
                 select: false
-            }
+            },
+            createButton: null,
+            createState: null
         };
         return StateRestoreCollection;
     }());
@@ -2107,8 +2123,9 @@ let $ = jQuery;
                         0;
             });
             var button = dt.button('SaveStateRestore:name');
-            var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[0].buttons !== undefined ?
-                button[0].inst.c.buttons[0].buttons :
+            var buttonIndex = parseInt(button.index());
+            var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[buttonIndex].buttons !== undefined ?
+                button[0].inst.c.buttons[buttonIndex].buttons :
                 [];
             // remove any states from the previous rebuild - if they are still there they will be added later
             for (var i = 0; i < stateButtons.length; i++) {

diff --git a/js/index.js b/js/index.js
@@ -280,8 +280,9 @@ DataTable.ext.buttons.createState = {
                     0;
         });
         var button = dt.button('SaveStateRestore:name');
-        var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[0].buttons !== undefined ?
-            button[0].inst.c.buttons[0].buttons :
+        var buttonIndex = parseInt(button.index());
+        var stateButtons = button[0] !== undefined && button[0].inst.c.buttons[buttonIndex].buttons !== undefined ?
+            button[0].inst.c.buttons[buttonIndex].buttons :
             [];
         // remove any states from the previous rebuild - if they are still there they will be added later
         for (var i = 0; i < stateButtons.length; i++) {