mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-05-08 07:21:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[#181] update some function names and documentation

Browse source
This commit is contained in:
Robin Scholtes 2023-05-23 20:07:24 +12:00
parent 4e67556518
commit 3a10e4a4fb
1 changed files with 5 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

70
src/web/waiters/RecipeWaiter.mjs
View file

@ -390,8 +390,7 @@ class RecipeWaiter {
/** /**
* Adds the specified operation to the recipe and * Adds the specified operation to the recipe
* adds a checkmark to the operation in Operations op-list
* *
* @fires Manager#operationadd * @fires Manager#operationadd
* @param {string} name - The name of the operation to add * @param {string} name - The name of the operation to add
@ -408,8 +407,6 @@ class RecipeWaiter {
$(item).find("[data-toggle='tooltip']").tooltip(); $(item).find("[data-toggle='tooltip']").tooltip();
this.updateSelectedOperations();
item.dispatchEvent(this.manager.operationadd); item.dispatchEvent(this.manager.operationadd);
return item; return item;
} }
@ -425,7 +422,6 @@ class RecipeWaiter {
while (recList.firstChild) { while (recList.firstChild) {
recList.removeChild(recList.firstChild); recList.removeChild(recList.firstChild);
} }
this.clearAllSelectedClasses();
recList.dispatchEvent(this.manager.operationremove); recList.dispatchEvent(this.manager.operationremove);
} }
@ -467,6 +463,7 @@ class RecipeWaiter {
/** /**
* Handler for operationadd events. * Handler for operationadd events.
* Adds 'selected' class to the added operations in #operations-dropdown
* *
* @listens Manager#operationadd * @listens Manager#operationadd
* @fires Manager#statechange * @fires Manager#statechange
@ -474,7 +471,7 @@ class RecipeWaiter {
*/ */
opAdd(e) { opAdd(e) {
log.debug(`'${e.target.getAttribute("data-name")}' added to recipe`); log.debug(`'${e.target.getAttribute("data-name")}' added to recipe`);
this.updateSelectedOperations(); this.manager.ops.addClassToOp(e.target.getAttribute("data-name"), "selected");
this.triggerArgEvents(e.target); this.triggerArgEvents(e.target);
window.dispatchEvent(this.manager.statechange); window.dispatchEvent(this.manager.statechange);
} }
@ -482,6 +479,7 @@ class RecipeWaiter {
/** /**
* Handler for operationremove events. * Handler for operationremove events.
* Updates 'selected' classes in #operations
* *
* @listens Manager#operationremove * @listens Manager#operationremove
* @fires Manager#statechange * @fires Manager#statechange
@ -489,7 +487,7 @@ class RecipeWaiter {
*/ */
opRemove(e) { opRemove(e) {
log.debug("Operation removed from recipe"); log.debug("Operation removed from recipe");
this.updateSelectedOperations(); this.manager.ops.updateListItemsClasses("#rec-list", "selected");
window.dispatchEvent(this.manager.statechange); window.dispatchEvent(this.manager.statechange);
} }
@ -587,64 +585,6 @@ class RecipeWaiter {
op.insertAdjacentHTML("beforeend", registerListEl); op.insertAdjacentHTML("beforeend", registerListEl);
} }
/**
* Remove all "selected" classes for op-list list items at once
*
* This hides all the checkmark icons of previously added ( selected )
* operations to the recipe list
*/
clearAllSelectedClasses() {
const list = document.querySelectorAll(".operation.selected");
list.forEach((item) => {
item.classList.remove("selected");
});
}
/**
* Add "selected" to the operation that is added to the recipe
*
* This displays a checkmark icon to the operation in the op-list
*
* @param {string} opDataName the data-name of the target operation
*/
addSelectedClass(opDataName) {
const ops = document.querySelectorAll(`.operation[data-name="${opDataName}"]`);
// A selected operation can occur twice if it's in favourites
// and the original category op-list
ops.forEach((op => {
op.classList.add("selected");
}))
}
/**
* Update which items are selected in op-list.
*
* First all selected classes are removed from all op-lists, then we get the current
* recipe-list ingredient names and add 'selected' to the matching operations.
*/
updateSelectedOperations() {
const recipeListItems = document.querySelectorAll("#rec-list > li");
const operations = document.querySelectorAll(".operation");
this.clearAllSelectedClasses();
recipeListItems.forEach((item) => {
const ingredientName = item.getAttribute("data-name");
operations.forEach((operation) => {
if (ingredientName === operation.getAttribute("data-name")) {
this.addSelectedClass(ingredientName);
}
});
});
}
} }
export default RecipeWaiter; export default RecipeWaiter;