diff --git a/grade/amd/build/searchwidget/basewidget.min.js b/grade/amd/build/searchwidget/basewidget.min.js index 038154053e9..64fbb503d1a 100644 --- a/grade/amd/build/searchwidget/basewidget.min.js +++ b/grade/amd/build/searchwidget/basewidget.min.js @@ -1,10 +1,10 @@ -define("core_grades/searchwidget/basewidget",["exports","core/modal_factory","core/modal_events","core/utils","core/templates","core/aria"],(function(_exports,ModalFactory,ModalEvents,_utils,Templates,_aria){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj} +define("core_grades/searchwidget/basewidget",["exports","core/utils","core/templates","core_grades/searchwidget/selectors","core/notification"],(function(_exports,_utils,Templates,Selectors,_notification){var obj;function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj} /** - * A small modal to search users or grade items within the gradebook. + * A widget to search users or grade items within the gradebook. * * @module core_grades/searchwidget/basewidget * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.promisesAndResolvers=_exports.init=void 0,ModalFactory=_interopRequireWildcard(ModalFactory),ModalEvents=_interopRequireWildcard(ModalEvents),Templates=_interopRequireWildcard(Templates);_exports.init=function(bodyPromise,data,searchFunc,modalTitle){let unsearchableContent=arguments.length>4&&void 0!==arguments[4]?arguments[4]:null;const modal=buildModal(bodyPromise,modalTitle);registerListenerEvents(modal,data,searchFunc,unsearchableContent)};const registerListenerEvents=(modal,data,searchFunc,unsearchableContent)=>{modal.then((modal=>{modal.getRoot().on(ModalEvents.hidden,(()=>{modal.destroy()})),modal.getBodyPromise().then((body=>body[0])).then((body=>{const searchInput=body.querySelector('input[data-action="search"]'),searchResultsContainer=body.querySelector('[data-region="search-results-container-widget"]');if(renderSearchResults(searchResultsContainer,data),unsearchableContent){body.querySelector('[data-region="unsearchable-content-container-widget"]').innerHTML+=unsearchableContent}return searchInput.addEventListener("input",(0,_utils.debounce)((async()=>{await renderSearchResults(searchResultsContainer,debounceCallee(searchInput.value,data,searchFunc()))}),300)),(0,_aria.comboBox)(searchInput),body})).catch()})).catch()},buildModal=(bodyPromise,modalTitle)=>ModalFactory.create({type:ModalFactory.types.DEFAULT,title:modalTitle,body:bodyPromise,small:!0,scrollable:!1,templateContext:{classes:"reportdatasearch modal-sm"}}).then((modal=>(modal.show(),modal))),debounceCallee=(searchValue,data,searchFunction)=>searchValue.length>0?searchFunction(data,searchValue):data,renderSearchResults=async(searchResultsContainer,searchResultsData)=>{const templateData={searchresults:searchResultsData},{html:html,js:js}=await Templates.renderForPromise("core_grades/searchwidget/searchresults",templateData);await Templates.replaceNodeContents(searchResultsContainer,html,js)};_exports.promisesAndResolvers=()=>{let bodyPromiseResolver;const bodyPromise=new Promise((resolve=>{bodyPromiseResolver=resolve}));return{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}}})); + */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.showLoader=_exports.registerListenerEvents=_exports.promisesAndResolvers=_exports.init=void 0,Templates=_interopRequireWildcard(Templates),Selectors=_interopRequireWildcard(Selectors),_notification=(obj=_notification)&&obj.__esModule?obj:{default:obj};_exports.init=async function(widgetContentContainer,bodyPromise,data,searchFunc){let unsearchableContent=arguments.length>4&&void 0!==arguments[4]?arguments[4]:null;bodyPromise.then((async bodyContent=>{if(widgetContentContainer.innerHTML=bodyContent,unsearchableContent){widgetContentContainer.querySelector(Selectors.regions.unsearchableContent).innerHTML+=unsearchableContent}const searchResultsContainer=widgetContentContainer.querySelector(Selectors.regions.searchResults);await showLoader(searchResultsContainer),await renderSearchResults(searchResultsContainer,data),registerListenerEvents(widgetContentContainer,data,searchFunc)})).catch(_notification.default.exception)};const registerListenerEvents=(widgetContentContainer,data,searchFunc)=>{const searchResultsContainer=widgetContentContainer.querySelector(Selectors.regions.searchResults),searchInput=widgetContentContainer.querySelector(Selectors.actions.search);searchInput.focus();const clearSearchButton=widgetContentContainer.querySelector(Selectors.actions.clearSearch);searchInput.addEventListener("input",(0,_utils.debounce)((async()=>{searchInput.value.length>0?clearSearchButton.classList.remove("d-none"):clearSearchButton.classList.add("d-none"),await renderSearchResults(searchResultsContainer,debounceCallee(searchInput.value,data,searchFunc()))}),300)),clearSearchButton.addEventListener("click",(async e=>{e.stopPropagation(),searchInput.value="",searchInput.focus(),clearSearchButton.classList.add("d-none"),await renderSearchResults(searchResultsContainer,debounceCallee(searchInput.value,data,searchFunc()))}))};_exports.registerListenerEvents=registerListenerEvents;const showLoader=async container=>{const{html:html,js:js}=await Templates.renderForPromise("core_grades/searchwidget/loading",{});Templates.replaceNodeContents(container,html,js)};_exports.showLoader=showLoader;const debounceCallee=(searchValue,data,searchFunction)=>searchValue.length>0?searchFunction(data,searchValue):data,renderSearchResults=async(searchResultsContainer,searchResultsData)=>{const templateData={searchresults:searchResultsData},{html:html,js:js}=await Templates.renderForPromise("core_grades/searchwidget/searchresults",templateData);await Templates.replaceNodeContents(searchResultsContainer,html,js)};_exports.promisesAndResolvers=()=>{let bodyPromiseResolver;const bodyPromise=new Promise((resolve=>{bodyPromiseResolver=resolve}));return{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}}})); //# sourceMappingURL=basewidget.min.js.map \ No newline at end of file diff --git a/grade/amd/build/searchwidget/basewidget.min.js.map b/grade/amd/build/searchwidget/basewidget.min.js.map index 60cc764b89e..4d136840e37 100644 --- a/grade/amd/build/searchwidget/basewidget.min.js.map +++ b/grade/amd/build/searchwidget/basewidget.min.js.map @@ -1 +1 @@ -{"version":3,"file":"basewidget.min.js","sources":["../../src/searchwidget/basewidget.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search users or grade items within the gradebook.\n *\n * @module core_grades/searchwidget/basewidget\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport * as ModalFactory from 'core/modal_factory';\nimport * as ModalEvents from 'core/modal_events';\nimport {debounce} from 'core/utils';\nimport * as Templates from 'core/templates';\nimport {comboBox} from 'core/aria';\n\n/**\n * Build the base searching widget.\n *\n * @method init\n * @param {Promise} bodyPromise The promise from the callee of the contents to place in the modal body.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n * @param {string} modalTitle The name of the search widget.\n * @param {string|null} unsearchableContent The content rendered in a non-searchable area.\n */\nexport const init = (bodyPromise, data, searchFunc, modalTitle, unsearchableContent = null) => {\n const modal = buildModal(bodyPromise, modalTitle);\n registerListenerEvents(modal, data, searchFunc, unsearchableContent);\n};\n\n/**\n * Register chooser related event listeners.\n *\n * @method registerListenerEvents\n * @param {Promise} modal Our modal that we are working with.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n * @param {string|null} unsearchableContent The content rendered in a non-searchable area.\n */\nconst registerListenerEvents = (modal, data, searchFunc, unsearchableContent) => {\n modal.then(modal => {\n // We want to destroy this when the dialog is closed.\n modal.getRoot().on(ModalEvents.hidden, () => {\n modal.destroy();\n });\n // Once the body of the modal has been resolved, add more features.\n modal.getBodyPromise()\n // The return value of getBodyPromise is a jquery object containing the body NodeElement.\n .then(body => body[0])\n .then(body => {\n const searchInput = body.querySelector('input[data-action=\"search\"]');\n const searchResultsContainer = body.querySelector('[data-region=\"search-results-container-widget\"]');\n\n renderSearchResults(searchResultsContainer, data);\n\n if (unsearchableContent) {\n const unsearchableContentContainer = body.querySelector(\n '[data-region=\"unsearchable-content-container-widget\"]');\n unsearchableContentContainer.innerHTML += unsearchableContent;\n }\n\n // The search input is triggered.\n searchInput.addEventListener('input', debounce(async() => {\n // Display the search results.\n await renderSearchResults(\n searchResultsContainer,\n debounceCallee(\n searchInput.value,\n data,\n searchFunc()\n )\n );\n }, 300));\n // Trigger event handling for the results in line with aria guidelines.\n comboBox(searchInput);\n return body;\n }).catch();\n }).catch();\n};\n\n/**\n * Given an object we want to build a modal ready to show.\n *\n * @method buildModal\n * @param {Promise} bodyPromise Body promise that the caller should resolve.\n * @param {string} modalTitle The name of the search widget.\n * @return {Object} The modal ready to display immediately and render body in later.\n */\nconst buildModal = (bodyPromise, modalTitle) => {\n return ModalFactory.create({\n type: ModalFactory.types.DEFAULT,\n title: modalTitle,\n body: bodyPromise,\n small: true,\n scrollable: false,\n templateContext: {\n classes: 'reportdatasearch modal-sm'\n }\n }).then(modal => {\n modal.show();\n return modal;\n });\n};\n\n/**\n * We have a small helper that'll call the curried search function allowing callers to filter\n * the data set however we want rather than defining how data must be filtered.\n *\n * @method debounceCallee\n * @param {String} searchValue The input from the user that we'll search against.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunction Partially applied function we need to manage search the passed dataset.\n * @return {Array} The filtered subset of the provided data that we'll then render into the results.\n */\nconst debounceCallee = (searchValue, data, searchFunction) => {\n if (searchValue.length > 0) { // Search query is present.\n return searchFunction(data, searchValue);\n }\n return data;\n};\n\n/**\n * Given the output of the callers' search function, render out the results into the modal.\n *\n * @method renderSearchResults\n * @param {HTMLElement} searchResultsContainer The DOM node of the widget where we'll render the provided results.\n * @param {Array} searchResultsData The filtered subset of the provided data that we'll then render into the results.\n */\nconst renderSearchResults = async(searchResultsContainer, searchResultsData) => {\n const templateData = {\n 'searchresults': searchResultsData,\n };\n // Build up the html & js ready to place into the help section.\n const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/searchresults', templateData);\n await Templates.replaceNodeContents(searchResultsContainer, html, js);\n};\n\n/**\n * We want to create the basic promises and hooks that the caller will implement, so we can build modals\n * ahead of time and allow the caller to resolve their promises once complete.\n *\n * @method promisesAndResolvers\n * @returns {{bodyPromise: Promise, bodyPromiseResolver}}\n */\nexport const promisesAndResolvers = () => {\n // We want to show the modal instantly but loading whilst waiting for our data.\n let bodyPromiseResolver;\n const bodyPromise = new Promise(resolve => {\n bodyPromiseResolver = resolve;\n });\n\n return {bodyPromiseResolver, bodyPromise};\n};\n"],"names":["bodyPromise","data","searchFunc","modalTitle","unsearchableContent","modal","buildModal","registerListenerEvents","then","getRoot","on","ModalEvents","hidden","destroy","getBodyPromise","body","searchInput","querySelector","searchResultsContainer","renderSearchResults","innerHTML","addEventListener","async","debounceCallee","value","catch","ModalFactory","create","type","types","DEFAULT","title","small","scrollable","templateContext","classes","show","searchValue","searchFunction","length","searchResultsData","templateData","html","js","Templates","renderForPromise","replaceNodeContents","bodyPromiseResolver","Promise","resolve"],"mappings":";;;;;;;+QAsCoB,SAACA,YAAaC,KAAMC,WAAYC,gBAAYC,2EAAsB,WAC5EC,MAAQC,WAAWN,YAAaG,YACtCI,uBAAuBF,MAAOJ,KAAMC,WAAYE,4BAY9CG,uBAAyB,CAACF,MAAOJ,KAAMC,WAAYE,uBACrDC,MAAMG,MAAKH,QAEPA,MAAMI,UAAUC,GAAGC,YAAYC,QAAQ,KACnCP,MAAMQ,aAGVR,MAAMS,iBAEDN,MAAKO,MAAQA,KAAK,KAClBP,MAAKO,aACIC,YAAcD,KAAKE,cAAc,+BACjCC,uBAAyBH,KAAKE,cAAc,sDAElDE,oBAAoBD,uBAAwBjB,MAExCG,oBAAqB,CACgBW,KAAKE,cACtC,yDACyBG,WAAahB,2BAI9CY,YAAYK,iBAAiB,SAAS,oBAASC,gBAErCH,oBACFD,uBACAK,eACIP,YAAYQ,MACZvB,KACAC,iBAGT,yBAEMc,aACFD,QACRU,WACRA,SAWDnB,WAAa,CAACN,YAAaG,aACtBuB,aAAaC,OAAO,CACvBC,KAAMF,aAAaG,MAAMC,QACzBC,MAAO5B,WACPY,KAAMf,YACNgC,OAAO,EACPC,YAAY,EACZC,gBAAiB,CACbC,QAAS,+BAEd3B,MAAKH,QACJA,MAAM+B,OACC/B,SAcTkB,eAAiB,CAACc,YAAapC,KAAMqC,iBACnCD,YAAYE,OAAS,EACdD,eAAerC,KAAMoC,aAEzBpC,KAULkB,oBAAsBG,MAAMJ,uBAAwBsB,2BAChDC,aAAe,eACAD,oBAGfE,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,yCAA0CJ,oBACxFG,UAAUE,oBAAoB5B,uBAAwBwB,KAAMC,mCAUlC,SAE5BI,0BACE/C,YAAc,IAAIgD,SAAQC,UAC5BF,oBAAsBE,iBAGnB,CAACF,oBAAAA,oBAAqB/C,YAAAA"} \ No newline at end of file +{"version":3,"file":"basewidget.min.js","sources":["../../src/searchwidget/basewidget.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A widget to search users or grade items within the gradebook.\n *\n * @module core_grades/searchwidget/basewidget\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport {debounce} from 'core/utils';\nimport * as Templates from 'core/templates';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\nimport Notification from 'core/notification';\n\n/**\n * Build the base searching widget.\n *\n * @method init\n * @param {HTMLElement} widgetContentContainer The selector for the widget container element.\n * @param {Promise} bodyPromise The promise from the callee of the contents to place in the widget container.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n * @param {string|null} unsearchableContent The content rendered in a non-searchable area.\n */\nexport const init = async(widgetContentContainer, bodyPromise, data, searchFunc, unsearchableContent = null) => {\n bodyPromise.then(async(bodyContent) => {\n // Render the body content.\n widgetContentContainer.innerHTML = bodyContent;\n\n // Render the unsearchable content if defined.\n if (unsearchableContent) {\n const unsearchableContentContainer = widgetContentContainer.querySelector(Selectors.regions.unsearchableContent);\n unsearchableContentContainer.innerHTML += unsearchableContent;\n }\n\n const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults);\n // Display a loader until the search results are rendered.\n await showLoader(searchResultsContainer);\n // Render the search results.\n await renderSearchResults(searchResultsContainer, data);\n\n registerListenerEvents(widgetContentContainer, data, searchFunc);\n\n }).catch(Notification.exception);\n};\n\n/**\n * Register the event listeners for the search widget.\n *\n * @method registerListenerEvents\n * @param {HTMLElement} widgetContentContainer The selector for the widget container element.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n */\nexport const registerListenerEvents = (widgetContentContainer, data, searchFunc) => {\n const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults);\n const searchInput = widgetContentContainer.querySelector(Selectors.actions.search);\n // We want to focus on the first known user interable element within the dropdown.\n searchInput.focus();\n const clearSearchButton = widgetContentContainer.querySelector(Selectors.actions.clearSearch);\n\n // The search input is triggered.\n searchInput.addEventListener('input', debounce(async() => {\n // If search query is present display the 'clear search' button, otherwise hide it.\n if (searchInput.value.length > 0) {\n clearSearchButton.classList.remove('d-none');\n } else {\n clearSearchButton.classList.add('d-none');\n }\n // Display the search results.\n await renderSearchResults(\n searchResultsContainer,\n debounceCallee(\n searchInput.value,\n data,\n searchFunc()\n )\n );\n }, 300));\n\n // Clear search is triggered.\n clearSearchButton.addEventListener('click', async(e) => {\n e.stopPropagation();\n // Clear the entered search query in the search bar.\n searchInput.value = \"\";\n searchInput.focus();\n clearSearchButton.classList.add('d-none');\n\n // Display all results.\n await renderSearchResults(\n searchResultsContainer,\n debounceCallee(\n searchInput.value,\n data,\n searchFunc()\n )\n );\n });\n};\n\n/**\n * Renders the loading placeholder for the search widget.\n *\n * @method showLoader\n * @param {HTMLElement} container The DOM node where we'll render the loading placeholder.\n */\nexport const showLoader = async(container) => {\n const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/loading', {});\n Templates.replaceNodeContents(container, html, js);\n};\n\n/**\n * We have a small helper that'll call the curried search function allowing callers to filter\n * the data set however we want rather than defining how data must be filtered.\n *\n * @method debounceCallee\n * @param {String} searchValue The input from the user that we'll search against.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunction Partially applied function we need to manage search the passed dataset.\n * @return {Array} The filtered subset of the provided data that we'll then render into the results.\n */\nconst debounceCallee = (searchValue, data, searchFunction) => {\n if (searchValue.length > 0) { // Search query is present.\n return searchFunction(data, searchValue);\n }\n return data;\n};\n\n/**\n * Given the output of the callers' search function, render out the results into the search results container.\n *\n * @method renderSearchResults\n * @param {HTMLElement} searchResultsContainer The DOM node of the widget where we'll render the provided results.\n * @param {Array} searchResultsData The filtered subset of the provided data that we'll then render into the results.\n */\nconst renderSearchResults = async(searchResultsContainer, searchResultsData) => {\n const templateData = {\n 'searchresults': searchResultsData,\n };\n // Build up the html & js ready to place into the help section.\n const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/searchresults', templateData);\n await Templates.replaceNodeContents(searchResultsContainer, html, js);\n};\n\n/**\n * We want to create the basic promises and hooks that the caller will implement, so we can build the search widget\n * ahead of time and allow the caller to resolve their promises once complete.\n *\n * @method promisesAndResolvers\n * @returns {{bodyPromise: Promise, bodyPromiseResolver}}\n */\nexport const promisesAndResolvers = () => {\n // We want to show the widget instantly but loading whilst waiting for our data.\n let bodyPromiseResolver;\n const bodyPromise = new Promise(resolve => {\n bodyPromiseResolver = resolve;\n });\n\n return {bodyPromiseResolver, bodyPromise};\n};\n"],"names":["async","widgetContentContainer","bodyPromise","data","searchFunc","unsearchableContent","then","innerHTML","bodyContent","querySelector","Selectors","regions","searchResultsContainer","searchResults","showLoader","renderSearchResults","registerListenerEvents","catch","Notification","exception","searchInput","actions","search","focus","clearSearchButton","clearSearch","addEventListener","value","length","classList","remove","add","debounceCallee","e","stopPropagation","html","js","Templates","renderForPromise","replaceNodeContents","container","searchValue","searchFunction","searchResultsData","templateData","bodyPromiseResolver","Promise","resolve"],"mappings":";;;;;;;gVAqCoBA,eAAMC,uBAAwBC,YAAaC,KAAMC,gBAAYC,2EAAsB,KACnGH,YAAYI,MAAKN,MAAAA,iBAEbC,uBAAuBM,UAAYC,YAG/BH,oBAAqB,CACgBJ,uBAAuBQ,cAAcC,UAAUC,QAAQN,qBAC/DE,WAAaF,0BAGxCO,uBAAyBX,uBAAuBQ,cAAcC,UAAUC,QAAQE,qBAEhFC,WAAWF,8BAEXG,oBAAoBH,uBAAwBT,MAElDa,uBAAuBf,uBAAwBE,KAAMC,eAEtDa,MAAMC,sBAAaC,kBAWbH,uBAAyB,CAACf,uBAAwBE,KAAMC,oBAC3DQ,uBAAyBX,uBAAuBQ,cAAcC,UAAUC,QAAQE,eAChFO,YAAcnB,uBAAuBQ,cAAcC,UAAUW,QAAQC,QAE3EF,YAAYG,cACNC,kBAAoBvB,uBAAuBQ,cAAcC,UAAUW,QAAQI,aAGjFL,YAAYM,iBAAiB,SAAS,oBAAS1B,UAEvCoB,YAAYO,MAAMC,OAAS,EAC3BJ,kBAAkBK,UAAUC,OAAO,UAEnCN,kBAAkBK,UAAUE,IAAI,gBAG9BhB,oBACFH,uBACAoB,eACIZ,YAAYO,MACZxB,KACAC,iBAGT,MAGHoB,kBAAkBE,iBAAiB,SAAS1B,MAAAA,IACxCiC,EAAEC,kBAEFd,YAAYO,MAAQ,GACpBP,YAAYG,QACZC,kBAAkBK,UAAUE,IAAI,gBAG1BhB,oBACFH,uBACAoB,eACIZ,YAAYO,MACZxB,KACAC,gFAYHU,WAAad,MAAAA,kBAChBmC,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,mCAAoC,IACxFD,UAAUE,oBAAoBC,UAAWL,KAAMC,0CAa7CJ,eAAiB,CAACS,YAAatC,KAAMuC,iBACnCD,YAAYb,OAAS,EACdc,eAAevC,KAAMsC,aAEzBtC,KAULY,oBAAsBf,MAAMY,uBAAwB+B,2BAChDC,aAAe,eACAD,oBAGfR,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,yCAA0CM,oBACxFP,UAAUE,oBAAoB3B,uBAAwBuB,KAAMC,mCAUlC,SAE5BS,0BACE3C,YAAc,IAAI4C,SAAQC,UAC5BF,oBAAsBE,iBAGnB,CAACF,oBAAAA,oBAAqB3C,YAAAA"} \ No newline at end of file diff --git a/grade/amd/build/searchwidget/group.min.js b/grade/amd/build/searchwidget/group.min.js index 5ab94e45af9..9bac0576b75 100644 --- a/grade/amd/build/searchwidget/group.min.js +++ b/grade/amd/build/searchwidget/group.min.js @@ -1,10 +1,10 @@ -define("core_grades/searchwidget/group",["exports","core/pending","core/templates","core/custom_interaction_events","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/str"],(function(_exports,_pending,Templates,_custom_interaction_events,Repository,WidgetBase,_str){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} +define("core_grades/searchwidget/group",["exports","core/pending","core/templates","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","jquery","core_grades/searchwidget/selectors"],(function(_exports,_pending,Templates,Repository,WidgetBase,_jquery,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** - * A small modal to search groups within the gradebook. + * A widget to search groups within the gradebook. * * @module core_grades/searchwidget/group * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase);let registered=!1;_exports.init=()=>{if(registered)return;const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve(),registered=!0};const registerListenerEvents=()=>{const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events);let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();events.forEach((event=>{document.addEventListener(event,(async e=>{const trigger=e.target.closest(".groupwidget");if(trigger){const courseID=trigger.dataset.courseid,actionBaseUrl=trigger.dataset.actionBaseUrl;e.preventDefault();const data=await Repository.groupFetch(courseID,actionBaseUrl).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));if(data===[])return;WidgetBase.init(bodyPromise,data.groups,searchGroups(),(0,_str.get_string)("selectagroup","core"))}}))})),bodyPromiseResolver(Templates.render("core_grades/searchwidget/group/groupsearch_body",[]))},searchGroups=()=>()=>(groups,searchTerm)=>{if(""===searchTerm)return groups;searchTerm=searchTerm.toLowerCase();const searchResults=[];return groups.forEach((group=>{group.name.toLowerCase().includes(searchTerm)&&searchResults.push(group)})),searchResults}})); + */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_jquery=_interopRequireDefault(_jquery),Selectors=_interopRequireWildcard(Selectors);let registered=!1;_exports.init=()=>{if(registered)return;const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve(),registered=!0};const registerListenerEvents=()=>{let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();const dropdownMenuContainer=document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector("group"));(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("group")).on("show.bs.dropdown",(async e=>{const courseID=e.relatedTarget.dataset.courseid,actionBaseUrl=e.relatedTarget.dataset.actionBaseUrl;await WidgetBase.showLoader(dropdownMenuContainer);const data=await Repository.groupFetch(courseID,actionBaseUrl).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));data!==[]&&await WidgetBase.init(dropdownMenuContainer,bodyPromise,data.groups,searchGroups())})),bodyPromiseResolver(Templates.render("core_grades/searchwidget/group/groupsearch_body",[])),(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("group")).on("hide.bs.dropdown",(()=>{dropdownMenuContainer.innerHTML=""}))},searchGroups=()=>()=>(groups,searchTerm)=>{if(""===searchTerm)return groups;searchTerm=searchTerm.toLowerCase();const searchResults=[];return groups.forEach((group=>{group.name.toLowerCase().includes(searchTerm)&&searchResults.push(group)})),searchResults}})); //# sourceMappingURL=group.min.js.map \ No newline at end of file diff --git a/grade/amd/build/searchwidget/group.min.js.map b/grade/amd/build/searchwidget/group.min.js.map index 6ec32f69fe5..5d5973c9fe1 100644 --- a/grade/amd/build/searchwidget/group.min.js.map +++ b/grade/amd/build/searchwidget/group.min.js.map @@ -1 +1 @@ -{"version":3,"file":"group.min.js","sources":["../../src/searchwidget/group.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search groups within the gradebook.\n *\n * @module core_grades/searchwidget/group\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport {get_string as getString} from 'core/str';\n\n/**\n * Whether the event listener has already been registered for this module.\n *\n * @type {boolean}\n */\nlet registered = false;\n\n/**\n * Our entry point into starting to build the group search widget.\n *\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n if (registered) {\n return;\n }\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n registered = true;\n};\n\n/**\n * Register event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, async(e) => {\n const trigger = e.target.closest('.groupwidget');\n if (trigger) {\n const courseID = trigger.dataset.courseid;\n const actionBaseUrl = trigger.dataset.actionBaseUrl;\n e.preventDefault();\n\n // If an error occurs while fetching the data, display the error within the modal.\n const data = await Repository.groupFetch(courseID, actionBaseUrl).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n WidgetBase.init(\n bodyPromise,\n data.groups,\n searchGroups(),\n getString('selectagroup', 'core')\n );\n }\n });\n });\n // Resolvers for passed functions in the modal creation.\n bodyPromiseResolver(Templates.render(\n 'core_grades/searchwidget/group/groupsearch_body',\n []\n ));\n};\n\n/**\n * Define how we want to search and filter groups when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchGroups = () => {\n return () => {\n return (groups, searchTerm) => {\n if (searchTerm === '') {\n return groups;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n groups.forEach((group) => {\n const groupName = group.name.toLowerCase();\n if (groupName.includes(searchTerm)) {\n searchResults.push(group);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["registered","pendingPromise","Pending","registerListenerEvents","resolve","events","CustomEvents","activate","keyboardActivate","define","document","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","forEach","event","addEventListener","async","trigger","e","target","closest","courseID","dataset","courseid","actionBaseUrl","preventDefault","data","Repository","groupFetch","catch","errorTemplateData","message","Templates","render","init","groups","searchGroups","searchTerm","toLowerCase","searchResults","group","name","includes","push"],"mappings":";;;;;;;yVAmCIA,YAAa,gBASG,QACZA,wBAGEC,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,UACfJ,YAAa,SAQXG,uBAAyB,WACrBE,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOC,SAAUL,YAE1BM,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,uBAGpDT,OAAOU,SAASC,QACZN,SAASO,iBAAiBD,OAAOE,MAAAA,UACvBC,QAAUC,EAAEC,OAAOC,QAAQ,mBAC7BH,QAAS,OACHI,SAAWJ,QAAQK,QAAQC,SAC3BC,cAAgBP,QAAQK,QAAQE,cACtCN,EAAEO,uBAGIC,WAAaC,WAAWC,WAAWP,SAAUG,eAAeK,OAAMb,MAAAA,UAC9Dc,kBAAoB,cACNZ,EAAEa,SAEtBtB,0BACUuB,UAAUC,OAAO,iCAAkCH,0BAI7DJ,OAAS,UAGbf,WAAWuB,KACPxB,YACAgB,KAAKS,OACLC,gBACA,mBAAU,eAAgB,gBAM1C3B,oBAAoBuB,UAAUC,OAC1B,kDACA,MAUFG,aAAe,IACV,IACI,CAACD,OAAQE,iBACO,KAAfA,kBACOF,OAEXE,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBJ,OAAOtB,SAAS2B,QACMA,MAAMC,KAAKH,cACfI,SAASL,aACnBE,cAAcI,KAAKH,UAGpBD"} \ No newline at end of file +{"version":3,"file":"group.min.js","sources":["../../src/searchwidget/group.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A widget to search groups within the gradebook.\n *\n * @module core_grades/searchwidget/group\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport $ from 'jquery';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\n\n/**\n * Whether the event listener has already been registered for this module.\n *\n * @type {boolean}\n */\nlet registered = false;\n\n/**\n * Our entry point into starting to build the group search widget.\n *\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n if (registered) {\n return;\n }\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n registered = true;\n};\n\n/**\n * Register event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('group'));\n\n // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed).\n $(Selectors.elements.getSearchWidgetSelector('group')).on('show.bs.dropdown', async(e) => {\n const courseID = e.relatedTarget.dataset.courseid;\n const actionBaseUrl = e.relatedTarget.dataset.actionBaseUrl;\n // Display a loading icon in the dropdown menu container until the body promise is resolved.\n await WidgetBase.showLoader(dropdownMenuContainer);\n\n // If an error occurs while fetching the data, display the error within the dropdown menu.\n const data = await Repository.groupFetch(courseID, actionBaseUrl).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n await WidgetBase.init(\n dropdownMenuContainer,\n bodyPromise,\n data.groups,\n searchGroups(),\n );\n });\n\n // Resolvers for passed functions in the dropdown creation.\n bodyPromiseResolver(Templates.render(\n 'core_grades/searchwidget/group/groupsearch_body',\n []\n ));\n\n // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed).\n $(Selectors.elements.getSearchWidgetSelector('group')).on('hide.bs.dropdown', () => {\n // Reset the state once the groups menu dropdown is closed.\n dropdownMenuContainer.innerHTML = '';\n });\n};\n\n/**\n * Define how we want to search and filter groups when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchGroups = () => {\n return () => {\n return (groups, searchTerm) => {\n if (searchTerm === '') {\n return groups;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n groups.forEach((group) => {\n const groupName = group.name.toLowerCase();\n if (groupName.includes(searchTerm)) {\n searchResults.push(group);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["registered","pendingPromise","Pending","registerListenerEvents","resolve","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","dropdownMenuContainer","document","querySelector","Selectors","elements","getSearchWidgetDropdownSelector","getSearchWidgetSelector","on","async","courseID","e","relatedTarget","dataset","courseid","actionBaseUrl","showLoader","data","Repository","groupFetch","catch","errorTemplateData","message","Templates","render","init","groups","searchGroups","innerHTML","searchTerm","toLowerCase","searchResults","forEach","group","name","includes","push"],"mappings":";;;;;;;gWAmCIA,YAAa,gBASG,QACZA,wBAGEC,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,UACfJ,YAAa,SAQXG,uBAAyB,SACvBE,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,6BAC9CC,sBAAwBC,SAASC,cAAcC,UAAUC,SAASC,gCAAgC,8BAGtGF,UAAUC,SAASE,wBAAwB,UAAUC,GAAG,oBAAoBC,MAAAA,UACpEC,SAAWC,EAAEC,cAAcC,QAAQC,SACnCC,cAAgBJ,EAAEC,cAAcC,QAAQE,oBAExChB,WAAWiB,WAAWf,6BAGtBgB,WAAaC,WAAWC,WAAWT,SAAUK,eAAeK,OAAMX,MAAAA,UAC9DY,kBAAoB,cACNV,EAAEW,SAEtBzB,0BACU0B,UAAUC,OAAO,iCAAkCH,uBAI7DJ,OAAS,UAGPlB,WAAW0B,KACbxB,sBACAH,YACAmB,KAAKS,OACLC,mBAKR9B,oBAAoB0B,UAAUC,OAC1B,kDACA,yBAIFpB,UAAUC,SAASE,wBAAwB,UAAUC,GAAG,oBAAoB,KAE1EP,sBAAsB2B,UAAY,OAUpCD,aAAe,IACV,IACI,CAACD,OAAQG,iBACO,KAAfA,kBACOH,OAEXG,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBL,OAAOM,SAASC,QACMA,MAAMC,KAAKJ,cACfK,SAASN,aACnBE,cAAcK,KAAKH,UAGpBF"} \ No newline at end of file diff --git a/grade/amd/build/searchwidget/selectors.min.js b/grade/amd/build/searchwidget/selectors.min.js new file mode 100644 index 00000000000..5a3cf5ceaa0 --- /dev/null +++ b/grade/amd/build/searchwidget/selectors.min.js @@ -0,0 +1,3 @@ +define("core_grades/searchwidget/selectors",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;return _exports.default={regions:{searchResults:'[data-region="search-results-container-widget"]',unsearchableContent:'[data-region="unsearchable-content-container-widget"]'},actions:{search:'[data-action="search"]',clearSearch:'[data-action="clearsearch"]'},elements:{getSearchWidgetSelector:searchtype=>'.search-widget[data-searchtype="'.concat(searchtype,'"]'),getSearchWidgetDropdownSelector:searchtype=>'.search-widget[data-searchtype="'.concat(searchtype,'"] .dropdown-menu')}},_exports.default})); + +//# sourceMappingURL=selectors.min.js.map \ No newline at end of file diff --git a/grade/amd/build/searchwidget/selectors.min.js.map b/grade/amd/build/searchwidget/selectors.min.js.map new file mode 100644 index 00000000000..6b1c4d7e8ed --- /dev/null +++ b/grade/amd/build/searchwidget/selectors.min.js.map @@ -0,0 +1 @@ +{"version":3,"file":"selectors.min.js","sources":["../../src/searchwidget/selectors.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * Selectors for the search widget.\n *\n * @module core_grades/searchwidget/selectors\n * @copyright 2022 Mihail Geshoski \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nexport default {\n regions: {\n searchResults: '[data-region=\"search-results-container-widget\"]',\n unsearchableContent: '[data-region=\"unsearchable-content-container-widget\"]',\n },\n actions: {\n search: '[data-action=\"search\"]',\n clearSearch: '[data-action=\"clearsearch\"]',\n },\n elements: {\n getSearchWidgetSelector: searchtype => `.search-widget[data-searchtype=\"${searchtype}\"]`,\n getSearchWidgetDropdownSelector: searchtype => `.search-widget[data-searchtype=\"${searchtype}\"] .dropdown-menu`,\n },\n};\n"],"names":["regions","searchResults","unsearchableContent","actions","search","clearSearch","elements","getSearchWidgetSelector","searchtype","getSearchWidgetDropdownSelector"],"mappings":"oLAuBe,CACXA,QAAS,CACLC,cAAe,kDACfC,oBAAqB,yDAEzBC,QAAS,CACLC,OAAQ,yBACRC,YAAa,+BAEjBC,SAAU,CACNC,wBAAyBC,sDAAiDA,iBAC1EC,gCAAiCD,sDAAiDA"} \ No newline at end of file diff --git a/grade/amd/src/searchwidget/basewidget.js b/grade/amd/src/searchwidget/basewidget.js index d208cc7a490..6f66768e62a 100644 --- a/grade/amd/src/searchwidget/basewidget.js +++ b/grade/amd/src/searchwidget/basewidget.js @@ -14,105 +14,112 @@ // along with Moodle. If not, see . /** - * A small modal to search users or grade items within the gradebook. + * A widget to search users or grade items within the gradebook. * * @module core_grades/searchwidget/basewidget * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -import * as ModalFactory from 'core/modal_factory'; -import * as ModalEvents from 'core/modal_events'; import {debounce} from 'core/utils'; import * as Templates from 'core/templates'; -import {comboBox} from 'core/aria'; +import * as Selectors from 'core_grades/searchwidget/selectors'; +import Notification from 'core/notification'; /** * Build the base searching widget. * * @method init - * @param {Promise} bodyPromise The promise from the callee of the contents to place in the modal body. + * @param {HTMLElement} widgetContentContainer The selector for the widget container element. + * @param {Promise} bodyPromise The promise from the callee of the contents to place in the widget container. * @param {Array} data An array of all the data generated by the callee. * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset. - * @param {string} modalTitle The name of the search widget. * @param {string|null} unsearchableContent The content rendered in a non-searchable area. */ -export const init = (bodyPromise, data, searchFunc, modalTitle, unsearchableContent = null) => { - const modal = buildModal(bodyPromise, modalTitle); - registerListenerEvents(modal, data, searchFunc, unsearchableContent); +export const init = async(widgetContentContainer, bodyPromise, data, searchFunc, unsearchableContent = null) => { + bodyPromise.then(async(bodyContent) => { + // Render the body content. + widgetContentContainer.innerHTML = bodyContent; + + // Render the unsearchable content if defined. + if (unsearchableContent) { + const unsearchableContentContainer = widgetContentContainer.querySelector(Selectors.regions.unsearchableContent); + unsearchableContentContainer.innerHTML += unsearchableContent; + } + + const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults); + // Display a loader until the search results are rendered. + await showLoader(searchResultsContainer); + // Render the search results. + await renderSearchResults(searchResultsContainer, data); + + registerListenerEvents(widgetContentContainer, data, searchFunc); + + }).catch(Notification.exception); }; /** - * Register chooser related event listeners. + * Register the event listeners for the search widget. * * @method registerListenerEvents - * @param {Promise} modal Our modal that we are working with. + * @param {HTMLElement} widgetContentContainer The selector for the widget container element. * @param {Array} data An array of all the data generated by the callee. * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset. - * @param {string|null} unsearchableContent The content rendered in a non-searchable area. */ -const registerListenerEvents = (modal, data, searchFunc, unsearchableContent) => { - modal.then(modal => { - // We want to destroy this when the dialog is closed. - modal.getRoot().on(ModalEvents.hidden, () => { - modal.destroy(); - }); - // Once the body of the modal has been resolved, add more features. - modal.getBodyPromise() - // The return value of getBodyPromise is a jquery object containing the body NodeElement. - .then(body => body[0]) - .then(body => { - const searchInput = body.querySelector('input[data-action="search"]'); - const searchResultsContainer = body.querySelector('[data-region="search-results-container-widget"]'); +export const registerListenerEvents = (widgetContentContainer, data, searchFunc) => { + const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults); + const searchInput = widgetContentContainer.querySelector(Selectors.actions.search); + // We want to focus on the first known user interable element within the dropdown. + searchInput.focus(); + const clearSearchButton = widgetContentContainer.querySelector(Selectors.actions.clearSearch); - renderSearchResults(searchResultsContainer, data); + // The search input is triggered. + searchInput.addEventListener('input', debounce(async() => { + // If search query is present display the 'clear search' button, otherwise hide it. + if (searchInput.value.length > 0) { + clearSearchButton.classList.remove('d-none'); + } else { + clearSearchButton.classList.add('d-none'); + } + // Display the search results. + await renderSearchResults( + searchResultsContainer, + debounceCallee( + searchInput.value, + data, + searchFunc() + ) + ); + }, 300)); - if (unsearchableContent) { - const unsearchableContentContainer = body.querySelector( - '[data-region="unsearchable-content-container-widget"]'); - unsearchableContentContainer.innerHTML += unsearchableContent; - } + // Clear search is triggered. + clearSearchButton.addEventListener('click', async(e) => { + e.stopPropagation(); + // Clear the entered search query in the search bar. + searchInput.value = ""; + searchInput.focus(); + clearSearchButton.classList.add('d-none'); - // The search input is triggered. - searchInput.addEventListener('input', debounce(async() => { - // Display the search results. - await renderSearchResults( - searchResultsContainer, - debounceCallee( - searchInput.value, - data, - searchFunc() - ) - ); - }, 300)); - // Trigger event handling for the results in line with aria guidelines. - comboBox(searchInput); - return body; - }).catch(); - }).catch(); + // Display all results. + await renderSearchResults( + searchResultsContainer, + debounceCallee( + searchInput.value, + data, + searchFunc() + ) + ); + }); }; /** - * Given an object we want to build a modal ready to show. + * Renders the loading placeholder for the search widget. * - * @method buildModal - * @param {Promise} bodyPromise Body promise that the caller should resolve. - * @param {string} modalTitle The name of the search widget. - * @return {Object} The modal ready to display immediately and render body in later. + * @method showLoader + * @param {HTMLElement} container The DOM node where we'll render the loading placeholder. */ -const buildModal = (bodyPromise, modalTitle) => { - return ModalFactory.create({ - type: ModalFactory.types.DEFAULT, - title: modalTitle, - body: bodyPromise, - small: true, - scrollable: false, - templateContext: { - classes: 'reportdatasearch modal-sm' - } - }).then(modal => { - modal.show(); - return modal; - }); +export const showLoader = async(container) => { + const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/loading', {}); + Templates.replaceNodeContents(container, html, js); }; /** @@ -133,7 +140,7 @@ const debounceCallee = (searchValue, data, searchFunction) => { }; /** - * Given the output of the callers' search function, render out the results into the modal. + * Given the output of the callers' search function, render out the results into the search results container. * * @method renderSearchResults * @param {HTMLElement} searchResultsContainer The DOM node of the widget where we'll render the provided results. @@ -149,14 +156,14 @@ const renderSearchResults = async(searchResultsContainer, searchResultsData) => }; /** - * We want to create the basic promises and hooks that the caller will implement, so we can build modals + * We want to create the basic promises and hooks that the caller will implement, so we can build the search widget * ahead of time and allow the caller to resolve their promises once complete. * * @method promisesAndResolvers * @returns {{bodyPromise: Promise, bodyPromiseResolver}} */ export const promisesAndResolvers = () => { - // We want to show the modal instantly but loading whilst waiting for our data. + // We want to show the widget instantly but loading whilst waiting for our data. let bodyPromiseResolver; const bodyPromise = new Promise(resolve => { bodyPromiseResolver = resolve; diff --git a/grade/amd/src/searchwidget/group.js b/grade/amd/src/searchwidget/group.js index e6170c33216..2882d6316c0 100644 --- a/grade/amd/src/searchwidget/group.js +++ b/grade/amd/src/searchwidget/group.js @@ -14,7 +14,7 @@ // along with Moodle. If not, see . /** - * A small modal to search groups within the gradebook. + * A widget to search groups within the gradebook. * * @module core_grades/searchwidget/group * @copyright 2022 Mathew May @@ -23,10 +23,10 @@ import Pending from 'core/pending'; import * as Templates from 'core/templates'; -import CustomEvents from "core/custom_interaction_events"; import * as Repository from 'core_grades/searchwidget/repository'; import * as WidgetBase from 'core_grades/searchwidget/basewidget'; -import {get_string as getString} from 'core/str'; +import $ from 'jquery'; +import * as Selectors from 'core_grades/searchwidget/selectors'; /** * Whether the event listener has already been registered for this module. @@ -58,51 +58,48 @@ export const init = () => { * @method registerListenerEvents */ const registerListenerEvents = () => { - const events = [ - 'click', - CustomEvents.events.activate, - CustomEvents.events.keyboardActivate - ]; - CustomEvents.define(document, events); - let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers(); + const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('group')); - // Register events. - events.forEach((event) => { - document.addEventListener(event, async(e) => { - const trigger = e.target.closest('.groupwidget'); - if (trigger) { - const courseID = trigger.dataset.courseid; - const actionBaseUrl = trigger.dataset.actionBaseUrl; - e.preventDefault(); + // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed). + $(Selectors.elements.getSearchWidgetSelector('group')).on('show.bs.dropdown', async(e) => { + const courseID = e.relatedTarget.dataset.courseid; + const actionBaseUrl = e.relatedTarget.dataset.actionBaseUrl; + // Display a loading icon in the dropdown menu container until the body promise is resolved. + await WidgetBase.showLoader(dropdownMenuContainer); - // If an error occurs while fetching the data, display the error within the modal. - const data = await Repository.groupFetch(courseID, actionBaseUrl).catch(async(e) => { - const errorTemplateData = { - 'errormessage': e.message - }; - bodyPromiseResolver( - await Templates.render('core_grades/searchwidget/error', errorTemplateData) - ); - }); - // Early return if there is no module data. - if (data === []) { - return; - } - WidgetBase.init( - bodyPromise, - data.groups, - searchGroups(), - getString('selectagroup', 'core') - ); - } + // If an error occurs while fetching the data, display the error within the dropdown menu. + const data = await Repository.groupFetch(courseID, actionBaseUrl).catch(async(e) => { + const errorTemplateData = { + 'errormessage': e.message + }; + bodyPromiseResolver( + await Templates.render('core_grades/searchwidget/error', errorTemplateData) + ); }); + // Early return if there is no module data. + if (data === []) { + return; + } + await WidgetBase.init( + dropdownMenuContainer, + bodyPromise, + data.groups, + searchGroups(), + ); }); - // Resolvers for passed functions in the modal creation. + + // Resolvers for passed functions in the dropdown creation. bodyPromiseResolver(Templates.render( 'core_grades/searchwidget/group/groupsearch_body', [] )); + + // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed). + $(Selectors.elements.getSearchWidgetSelector('group')).on('hide.bs.dropdown', () => { + // Reset the state once the groups menu dropdown is closed. + dropdownMenuContainer.innerHTML = ''; + }); }; /** diff --git a/grade/amd/src/searchwidget/selectors.js b/grade/amd/src/searchwidget/selectors.js new file mode 100644 index 00000000000..d283ec94736 --- /dev/null +++ b/grade/amd/src/searchwidget/selectors.js @@ -0,0 +1,37 @@ +// This file is part of Moodle - http://moodle.org/ +// +// Moodle is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Moodle is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Moodle. If not, see . + +/** + * Selectors for the search widget. + * + * @module core_grades/searchwidget/selectors + * @copyright 2022 Mihail Geshoski + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +export default { + regions: { + searchResults: '[data-region="search-results-container-widget"]', + unsearchableContent: '[data-region="unsearchable-content-container-widget"]', + }, + actions: { + search: '[data-action="search"]', + clearSearch: '[data-action="clearsearch"]', + }, + elements: { + getSearchWidgetSelector: searchtype => `.search-widget[data-searchtype="${searchtype}"]`, + getSearchWidgetDropdownSelector: searchtype => `.search-widget[data-searchtype="${searchtype}"] .dropdown-menu`, + }, +}; diff --git a/grade/classes/external/get_enrolled_users_for_search_widget.php b/grade/classes/external/get_enrolled_users_for_search_widget.php index 37bfc2b0a6f..91e16f6de88 100644 --- a/grade/classes/external/get_enrolled_users_for_search_widget.php +++ b/grade/classes/external/get_enrolled_users_for_search_widget.php @@ -105,6 +105,7 @@ class get_enrolled_users_for_search_widget extends external_api { $userpicture->size = 1; $user->profileimage = $userpicture->get_url($PAGE)->out(false); $user->email = $guiuser->email; + $user->active = false; // @TODO MDL-76246 $users[] = $user; } @@ -151,6 +152,7 @@ class get_enrolled_users_for_search_widget extends external_api { core_user::get_property_type('email'), 'An email address - allow email as root@localhost', VALUE_OPTIONAL), + 'active' => new external_value(PARAM_BOOL, 'Are we currently on this item?', VALUE_REQUIRED) ]; return new external_single_structure($userfields); } diff --git a/grade/classes/external/get_groups_for_search_widget.php b/grade/classes/external/get_groups_for_search_widget.php index 9e3d527c973..6424318a873 100644 --- a/grade/classes/external/get_groups_for_search_widget.php +++ b/grade/classes/external/get_groups_for_search_widget.php @@ -116,8 +116,10 @@ class get_groups_for_search_widget extends external_api { 'group' => $group->id ]); return (object) [ + 'id' => $group->id, 'name' => $group->name, 'url' => $url->out(false), + 'active' => false // @TODO MDL-76246 ]; }, $groupsmenu); } @@ -147,8 +149,10 @@ class get_groups_for_search_widget extends external_api { */ public static function group_description(): external_description { $groupfields = [ + 'id' => new external_value(PARAM_ALPHANUM, 'An ID for the group', VALUE_REQUIRED), 'url' => new external_value(PARAM_URL, 'The link that applies the group action', VALUE_REQUIRED), 'name' => new external_value(PARAM_TEXT, 'The full name of the group', VALUE_REQUIRED), + 'active' => new external_value(PARAM_BOOL, 'Are we currently on this item?', VALUE_REQUIRED) ]; return new external_single_structure($groupfields); } diff --git a/grade/report/singleview/amd/build/grade.min.js b/grade/report/singleview/amd/build/grade.min.js index 7f2ec52a68f..97635d1baa0 100644 --- a/grade/report/singleview/amd/build/grade.min.js +++ b/grade/report/singleview/amd/build/grade.min.js @@ -1,10 +1,10 @@ -define("gradereport_singleview/grade",["exports","core/pending","core/templates","core/custom_interaction_events","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/str"],(function(_exports,_pending,Templates,_custom_interaction_events,Repository,WidgetBase,_str){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} +define("gradereport_singleview/grade",["exports","core/pending","core/templates","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","jquery","core_grades/searchwidget/selectors"],(function(_exports,_pending,Templates,Repository,WidgetBase,_jquery,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** - * A small modal to search users within the gradebook. + * A small modal to search grade items within the gradebook. * * @module gradereport_singleview * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events);let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();events.forEach((event=>{document.addEventListener(event,(async e=>{const trigger=e.target.closest(".gradewidget");if(trigger){const courseID=trigger.dataset.courseid;e.preventDefault();const data=await Repository.gradeitemFetch(courseID).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));if(data===[]||void 0===data)return;WidgetBase.init(bodyPromise,data.gradeitems,searchGradeitems(),(0,_str.get_string)("selectagrade","gradereport_singleview"))}}))})),bodyPromiseResolver(Templates.render("gradereport_singleview/gradesearch_body",[]))},searchGradeitems=()=>()=>(modules,searchTerm)=>{if(""===searchTerm)return modules;searchTerm=searchTerm.toLowerCase();const searchResults=[];return modules.forEach((module=>{module.name.toLowerCase().includes(searchTerm)&&searchResults.push(module)})),searchResults}})); + */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_jquery=_interopRequireDefault(_jquery),Selectors=_interopRequireWildcard(Selectors);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();const dropdownMenuContainer=document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector("grade"));(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("grade")).on("show.bs.dropdown",(async e=>{const courseID=e.relatedTarget.dataset.courseid;await WidgetBase.showLoader(dropdownMenuContainer);const data=await Repository.gradeitemFetch(courseID).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));data!==[]&&(await WidgetBase.init(dropdownMenuContainer,bodyPromise,data.gradeitems,searchGradeitems()),bodyPromiseResolver(Templates.render("gradereport_singleview/gradesearch_body",[])))})),(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("grade")).on("hide.bs.dropdown",(()=>{dropdownMenuContainer.innerHTML=""}))},searchGradeitems=()=>()=>(modules,searchTerm)=>{if(""===searchTerm)return modules;searchTerm=searchTerm.toLowerCase();const searchResults=[];return modules.forEach((module=>{module.name.toLowerCase().includes(searchTerm)&&searchResults.push(module)})),searchResults}})); //# sourceMappingURL=grade.min.js.map \ No newline at end of file diff --git a/grade/report/singleview/amd/build/grade.min.js.map b/grade/report/singleview/amd/build/grade.min.js.map index 1ec797a12d0..ba46337c248 100644 --- a/grade/report/singleview/amd/build/grade.min.js.map +++ b/grade/report/singleview/amd/build/grade.min.js.map @@ -1 +1 @@ -{"version":3,"file":"grade.min.js","sources":["../src/grade.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search users within the gradebook.\n *\n * @module gradereport_singleview\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport {get_string as getString} from 'core/str';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register grade item search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, async(e) => {\n const trigger = e.target.closest('.gradewidget');\n if (trigger) {\n const courseID = trigger.dataset.courseid;\n e.preventDefault();\n\n // If an error occurs while fetching the data, display the error within the modal.\n const data = await Repository.gradeitemFetch(courseID).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n // Early return if there is no module data.\n if (data === [] || data === undefined) {\n return;\n }\n WidgetBase.init(\n bodyPromise,\n data.gradeitems,\n searchGradeitems(),\n getString('selectagrade', 'gradereport_singleview')\n );\n }\n });\n });\n // Resolvers for passed functions in the modal creation.\n bodyPromiseResolver(Templates.render(\n 'gradereport_singleview/gradesearch_body',\n []\n ));\n};\n\n/**\n * Define how we want to search and filter grade items when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchGradeitems = () => {\n return () => {\n return (modules, searchTerm) => {\n if (searchTerm === '') {\n return modules;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n modules.forEach((module) => {\n const moduleName = module.name.toLowerCase();\n if (moduleName.includes(searchTerm)) {\n searchResults.push(module);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","events","CustomEvents","activate","keyboardActivate","define","document","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","forEach","event","addEventListener","async","trigger","e","target","closest","courseID","dataset","courseid","preventDefault","data","Repository","gradeitemFetch","catch","errorTemplateData","message","Templates","render","undefined","init","gradeitems","searchGradeitems","modules","searchTerm","toLowerCase","searchResults","module","name","includes","push"],"mappings":";;;;;;;mWAoCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,WACrBE,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOC,SAAUL,YAE1BM,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,uBAGpDT,OAAOU,SAASC,QACZN,SAASO,iBAAiBD,OAAOE,MAAAA,UACvBC,QAAUC,EAAEC,OAAOC,QAAQ,mBAC7BH,QAAS,OACHI,SAAWJ,QAAQK,QAAQC,SACjCL,EAAEM,uBAGIC,WAAaC,WAAWC,eAAeN,UAAUO,OAAMZ,MAAAA,UACnDa,kBAAoB,cACNX,EAAEY,SAEtBrB,0BACUsB,UAAUC,OAAO,iCAAkCH,0BAI7DJ,OAAS,SAAeQ,IAATR,YAGnBd,WAAWuB,KACPxB,YACAe,KAAKU,WACLC,oBACA,mBAAU,eAAgB,kCAM1C3B,oBAAoBsB,UAAUC,OAC1B,0CACA,MAUFI,iBAAmB,IACd,IACI,CAACC,QAASC,iBACM,KAAfA,kBACOD,QAEXC,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBH,QAAQxB,SAAS4B,SACMA,OAAOC,KAAKH,cAChBI,SAASL,aACpBE,cAAcI,KAAKH,WAGpBD"} \ No newline at end of file +{"version":3,"file":"grade.min.js","sources":["../src/grade.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search grade items within the gradebook.\n *\n * @module gradereport_singleview\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport $ from 'jquery';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register grade item search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('grade'));\n\n // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed).\n $(Selectors.elements.getSearchWidgetSelector('grade')).on('show.bs.dropdown', async(e) => {\n const courseID = e.relatedTarget.dataset.courseid;\n // Display a loading icon in the dropdown menu container until the body promise is resolved.\n await WidgetBase.showLoader(dropdownMenuContainer);\n\n // If an error occurs while fetching the data, display the error within the modal.\n const data = await Repository.gradeitemFetch(courseID).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n\n await WidgetBase.init(\n dropdownMenuContainer,\n bodyPromise,\n data.gradeitems,\n searchGradeitems()\n );\n\n // Resolvers for passed functions in the modal creation.\n bodyPromiseResolver(Templates.render('gradereport_singleview/gradesearch_body', []));\n });\n\n // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed).\n $(Selectors.elements.getSearchWidgetSelector('grade')).on('hide.bs.dropdown', () => {\n // Reset the state once the grade item menu dropdown is closed.\n dropdownMenuContainer.innerHTML = '';\n });\n};\n\n/**\n * Define how we want to search and filter grade items when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchGradeitems = () => {\n return () => {\n return (modules, searchTerm) => {\n if (searchTerm === '') {\n return modules;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n modules.forEach((module) => {\n const moduleName = module.name.toLowerCase();\n if (moduleName.includes(searchTerm)) {\n searchResults.push(module);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","dropdownMenuContainer","document","querySelector","Selectors","elements","getSearchWidgetDropdownSelector","getSearchWidgetSelector","on","async","courseID","e","relatedTarget","dataset","courseid","showLoader","data","Repository","gradeitemFetch","catch","errorTemplateData","message","Templates","render","init","gradeitems","searchGradeitems","innerHTML","modules","searchTerm","toLowerCase","searchResults","forEach","module","name","includes","push"],"mappings":";;;;;;;0WAoCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,SACvBE,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,6BAC9CC,sBAAwBC,SAASC,cAAcC,UAAUC,SAASC,gCAAgC,8BAGtGF,UAAUC,SAASE,wBAAwB,UAAUC,GAAG,oBAAoBC,MAAAA,UACpEC,SAAWC,EAAEC,cAAcC,QAAQC,eAEnCf,WAAWgB,WAAWd,6BAGtBe,WAAaC,WAAWC,eAAeR,UAAUS,OAAMV,MAAAA,UACnDW,kBAAoB,cACNT,EAAEU,SAEtBxB,0BACUyB,UAAUC,OAAO,iCAAkCH,uBAK7DJ,OAAS,WAIPjB,WAAWyB,KACbvB,sBACAH,YACAkB,KAAKS,WACLC,oBAIJ7B,oBAAoByB,UAAUC,OAAO,0CAA2C,6BAIlFnB,UAAUC,SAASE,wBAAwB,UAAUC,GAAG,oBAAoB,KAE1EP,sBAAsB0B,UAAY,OAUpCD,iBAAmB,IACd,IACI,CAACE,QAASC,iBACM,KAAfA,kBACOD,QAEXC,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBH,QAAQI,SAASC,SACMA,OAAOC,KAAKJ,cAChBK,SAASN,aACpBE,cAAcK,KAAKH,WAGpBF"} \ No newline at end of file diff --git a/grade/report/singleview/amd/build/user.min.js b/grade/report/singleview/amd/build/user.min.js index 452a78e89e6..053c89338ae 100644 --- a/grade/report/singleview/amd/build/user.min.js +++ b/grade/report/singleview/amd/build/user.min.js @@ -1,10 +1,10 @@ -define("gradereport_singleview/user",["exports","core/pending","core/templates","core/custom_interaction_events","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/str","core/url"],(function(_exports,_pending,Templates,_custom_interaction_events,Repository,WidgetBase,_str,_url){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} +define("gradereport_singleview/user",["exports","core/pending","core/templates","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/url","jquery","core_grades/searchwidget/selectors"],(function(_exports,_pending,Templates,Repository,WidgetBase,_url,_jquery,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * A small modal to search users within the gradebook. * * @module gradereport_singleview/user * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_url=_interopRequireDefault(_url);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events);let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();events.forEach((event=>{document.addEventListener(event,(async e=>{const trigger=e.target.closest(".userwidget");if(trigger){const courseID=trigger.dataset.courseid,groupId=trigger.dataset.groupid;e.preventDefault();const actionBaseUrl=_url.default.relativeUrl("/grade/report/singleview/index.php",{item:"user"},!1),data=await Repository.userFetch(courseID,actionBaseUrl,groupId).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));if(data===[])return;WidgetBase.init(bodyPromise,data.users,searchUsers(),(0,_str.get_string)("selectauser","grades"))}}))})),bodyPromiseResolver(Templates.render("core_grades/searchwidget/user/usersearch_body",[]))},searchUsers=()=>()=>(users,searchTerm)=>{if(""===searchTerm)return users;searchTerm=searchTerm.toLowerCase();const searchResults=[];return users.forEach((user=>{user.fullname.toLowerCase().includes(searchTerm)&&searchResults.push(user)})),searchResults}})); + */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_url=_interopRequireDefault(_url),_jquery=_interopRequireDefault(_jquery),Selectors=_interopRequireWildcard(Selectors);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();const dropdownMenuContainer=document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector("user"));(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("user")).on("show.bs.dropdown",(async e=>{const courseID=e.relatedTarget.dataset.courseid,groupId=e.relatedTarget.dataset.groupid,actionBaseUrl=_url.default.relativeUrl("/grade/report/singleview/index.php",{item:"user"},!1);await WidgetBase.showLoader(dropdownMenuContainer);const data=await Repository.userFetch(courseID,actionBaseUrl,groupId).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));data!==[]&&(await WidgetBase.init(dropdownMenuContainer,bodyPromise,data.users,searchUsers()),bodyPromiseResolver(Templates.render("core_grades/searchwidget/user/usersearch_body",[])))})),(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("user")).on("hide.bs.dropdown",(()=>{dropdownMenuContainer.innerHTML=""}))},searchUsers=()=>()=>(users,searchTerm)=>{if(""===searchTerm)return users;searchTerm=searchTerm.toLowerCase();const searchResults=[];return users.forEach((user=>{user.fullname.toLowerCase().includes(searchTerm)&&searchResults.push(user)})),searchResults}})); //# sourceMappingURL=user.min.js.map \ No newline at end of file diff --git a/grade/report/singleview/amd/build/user.min.js.map b/grade/report/singleview/amd/build/user.min.js.map index 512f2687ed4..b164448fb99 100644 --- a/grade/report/singleview/amd/build/user.min.js.map +++ b/grade/report/singleview/amd/build/user.min.js.map @@ -1 +1 @@ -{"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search users within the gradebook.\n *\n * @module gradereport_singleview/user\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport {get_string as getString} from 'core/str';\nimport Url from 'core/url';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register user search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, async(e) => {\n const trigger = e.target.closest('.userwidget');\n if (trigger) {\n const courseID = trigger.dataset.courseid;\n const groupId = trigger.dataset.groupid;\n e.preventDefault();\n\n const actionBaseUrl = Url.relativeUrl('/grade/report/singleview/index.php', {item: 'user'}, false);\n // If an error occurs while fetching the data, display the error within the modal.\n const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n WidgetBase.init(\n bodyPromise,\n data.users,\n searchUsers(),\n getString('selectauser', 'grades')\n );\n }\n });\n });\n // Resolvers for passed functions in the modal creation.\n bodyPromiseResolver(Templates.render(\n 'core_grades/searchwidget/user/usersearch_body',\n []\n ));\n};\n\n/**\n * Define how we want to search and filter users when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchUsers = () => {\n return () => {\n return (users, searchTerm) => {\n if (searchTerm === '') {\n return users;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n users.forEach((user) => {\n const userName = user.fullname.toLowerCase();\n if (userName.includes(searchTerm)) {\n searchResults.push(user);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","events","CustomEvents","activate","keyboardActivate","define","document","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","forEach","event","addEventListener","async","trigger","e","target","closest","courseID","dataset","courseid","groupId","groupid","preventDefault","actionBaseUrl","Url","relativeUrl","item","data","Repository","userFetch","catch","errorTemplateData","message","Templates","render","init","users","searchUsers","searchTerm","toLowerCase","searchResults","user","fullname","includes","push"],"mappings":";;;;;;;qYAqCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,WACrBE,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOC,SAAUL,YAE1BM,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,uBAGpDT,OAAOU,SAASC,QACZN,SAASO,iBAAiBD,OAAOE,MAAAA,UACvBC,QAAUC,EAAEC,OAAOC,QAAQ,kBAC7BH,QAAS,OACHI,SAAWJ,QAAQK,QAAQC,SAC3BC,QAAUP,QAAQK,QAAQG,QAChCP,EAAEQ,uBAEIC,cAAgBC,aAAIC,YAAY,qCAAsC,CAACC,KAAM,SAAS,GAEtFC,WAAaC,WAAWC,UAAUZ,SAAUM,cAAeH,SAASU,OAAMlB,MAAAA,UACtEmB,kBAAoB,cACNjB,EAAEkB,SAEtB3B,0BACU4B,UAAUC,OAAO,iCAAkCH,0BAI7DJ,OAAS,UAGbpB,WAAW4B,KACP7B,YACAqB,KAAKS,MACLC,eACA,mBAAU,cAAe,kBAMzChC,oBAAoB4B,UAAUC,OAC1B,gDACA,MAUFG,YAAc,IACT,IACI,CAACD,MAAOE,iBACQ,KAAfA,kBACOF,MAEXE,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBJ,MAAM3B,SAASgC,OACMA,KAAKC,SAASH,cAClBI,SAASL,aAClBE,cAAcI,KAAKH,SAGpBD"} \ No newline at end of file +{"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search users within the gradebook.\n *\n * @module gradereport_singleview/user\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport Url from 'core/url';\nimport $ from 'jquery';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register user search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('user'));\n\n // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed).\n $(Selectors.elements.getSearchWidgetSelector('user')).on('show.bs.dropdown', async(e) => {\n const courseID = e.relatedTarget.dataset.courseid;\n const groupId = e.relatedTarget.dataset.groupid;\n const actionBaseUrl = Url.relativeUrl('/grade/report/singleview/index.php', {item: 'user'}, false);\n // Display a loading icon in the dropdown menu container until the body promise is resolved.\n await WidgetBase.showLoader(dropdownMenuContainer);\n\n // If an error occurs while fetching the data, display the error within the dropdown menu.\n const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n\n await WidgetBase.init(\n dropdownMenuContainer,\n bodyPromise,\n data.users,\n searchUsers()\n );\n\n // Resolvers for passed functions in the dropdown menu creation.\n bodyPromiseResolver(Templates.render('core_grades/searchwidget/user/usersearch_body', []));\n });\n\n // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed).\n $(Selectors.elements.getSearchWidgetSelector('user')).on('hide.bs.dropdown', () => {\n // Reset the state once the user menu dropdown is closed.\n dropdownMenuContainer.innerHTML = '';\n });\n};\n\n/**\n * Define how we want to search and filter users when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchUsers = () => {\n return () => {\n return (users, searchTerm) => {\n if (searchTerm === '') {\n return users;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n users.forEach((user) => {\n const userName = user.fullname.toLowerCase();\n if (userName.includes(searchTerm)) {\n searchResults.push(user);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","dropdownMenuContainer","document","querySelector","Selectors","elements","getSearchWidgetDropdownSelector","getSearchWidgetSelector","on","async","courseID","e","relatedTarget","dataset","courseid","groupId","groupid","actionBaseUrl","Url","relativeUrl","item","showLoader","data","Repository","userFetch","catch","errorTemplateData","message","Templates","render","init","users","searchUsers","innerHTML","searchTerm","toLowerCase","searchResults","forEach","user","fullname","includes","push"],"mappings":";;;;;;;4YAqCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,SACvBE,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,6BAC9CC,sBAAwBC,SAASC,cAAcC,UAAUC,SAASC,gCAAgC,6BAGtGF,UAAUC,SAASE,wBAAwB,SAASC,GAAG,oBAAoBC,MAAAA,UACnEC,SAAWC,EAAEC,cAAcC,QAAQC,SACnCC,QAAUJ,EAAEC,cAAcC,QAAQG,QAClCC,cAAgBC,aAAIC,YAAY,qCAAsC,CAACC,KAAM,SAAS,SAEtFrB,WAAWsB,WAAWpB,6BAGtBqB,WAAaC,WAAWC,UAAUd,SAAUO,cAAeF,SAASU,OAAMhB,MAAAA,UACtEiB,kBAAoB,cACNf,EAAEgB,SAEtB9B,0BACU+B,UAAUC,OAAO,iCAAkCH,uBAK7DJ,OAAS,WAIPvB,WAAW+B,KACb7B,sBACAH,YACAwB,KAAKS,MACLC,eAIJnC,oBAAoB+B,UAAUC,OAAO,gDAAiD,6BAIxFzB,UAAUC,SAASE,wBAAwB,SAASC,GAAG,oBAAoB,KAEzEP,sBAAsBgC,UAAY,OAUpCD,YAAc,IACT,IACI,CAACD,MAAOG,iBACQ,KAAfA,kBACOH,MAEXG,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBL,MAAMM,SAASC,OACMA,KAAKC,SAASJ,cAClBK,SAASN,aAClBE,cAAcK,KAAKH,SAGpBF"} \ No newline at end of file diff --git a/grade/report/singleview/amd/src/grade.js b/grade/report/singleview/amd/src/grade.js index fca697e914c..c03ad94f844 100644 --- a/grade/report/singleview/amd/src/grade.js +++ b/grade/report/singleview/amd/src/grade.js @@ -14,7 +14,7 @@ // along with Moodle. If not, see . /** - * A small modal to search users within the gradebook. + * A small modal to search grade items within the gradebook. * * @module gradereport_singleview * @copyright 2022 Mathew May @@ -23,10 +23,10 @@ import Pending from 'core/pending'; import * as Templates from 'core/templates'; -import CustomEvents from "core/custom_interaction_events"; import * as Repository from 'core_grades/searchwidget/repository'; import * as WidgetBase from 'core_grades/searchwidget/basewidget'; -import {get_string as getString} from 'core/str'; +import $ from 'jquery'; +import * as Selectors from 'core_grades/searchwidget/selectors'; /** * Our entry point into starting to build the search widget. @@ -46,50 +46,46 @@ export const init = () => { * @method registerListenerEvents */ const registerListenerEvents = () => { - const events = [ - 'click', - CustomEvents.events.activate, - CustomEvents.events.keyboardActivate - ]; - CustomEvents.define(document, events); - let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers(); + const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('grade')); - // Register events. - events.forEach((event) => { - document.addEventListener(event, async(e) => { - const trigger = e.target.closest('.gradewidget'); - if (trigger) { - const courseID = trigger.dataset.courseid; - e.preventDefault(); + // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed). + $(Selectors.elements.getSearchWidgetSelector('grade')).on('show.bs.dropdown', async(e) => { + const courseID = e.relatedTarget.dataset.courseid; + // Display a loading icon in the dropdown menu container until the body promise is resolved. + await WidgetBase.showLoader(dropdownMenuContainer); - // If an error occurs while fetching the data, display the error within the modal. - const data = await Repository.gradeitemFetch(courseID).catch(async(e) => { - const errorTemplateData = { - 'errormessage': e.message - }; - bodyPromiseResolver( - await Templates.render('core_grades/searchwidget/error', errorTemplateData) - ); - }); - // Early return if there is no module data. - if (data === [] || data === undefined) { - return; - } - WidgetBase.init( - bodyPromise, - data.gradeitems, - searchGradeitems(), - getString('selectagrade', 'gradereport_singleview') - ); - } + // If an error occurs while fetching the data, display the error within the modal. + const data = await Repository.gradeitemFetch(courseID).catch(async(e) => { + const errorTemplateData = { + 'errormessage': e.message + }; + bodyPromiseResolver( + await Templates.render('core_grades/searchwidget/error', errorTemplateData) + ); }); + + // Early return if there is no module data. + if (data === []) { + return; + } + + await WidgetBase.init( + dropdownMenuContainer, + bodyPromise, + data.gradeitems, + searchGradeitems() + ); + + // Resolvers for passed functions in the modal creation. + bodyPromiseResolver(Templates.render('gradereport_singleview/gradesearch_body', [])); + }); + + // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed). + $(Selectors.elements.getSearchWidgetSelector('grade')).on('hide.bs.dropdown', () => { + // Reset the state once the grade item menu dropdown is closed. + dropdownMenuContainer.innerHTML = ''; }); - // Resolvers for passed functions in the modal creation. - bodyPromiseResolver(Templates.render( - 'gradereport_singleview/gradesearch_body', - [] - )); }; /** diff --git a/grade/report/singleview/amd/src/user.js b/grade/report/singleview/amd/src/user.js index 267ba0423e2..bbd16a8f845 100644 --- a/grade/report/singleview/amd/src/user.js +++ b/grade/report/singleview/amd/src/user.js @@ -23,11 +23,11 @@ import Pending from 'core/pending'; import * as Templates from 'core/templates'; -import CustomEvents from "core/custom_interaction_events"; import * as Repository from 'core_grades/searchwidget/repository'; import * as WidgetBase from 'core_grades/searchwidget/basewidget'; -import {get_string as getString} from 'core/str'; import Url from 'core/url'; +import $ from 'jquery'; +import * as Selectors from 'core_grades/searchwidget/selectors'; /** * Our entry point into starting to build the search widget. @@ -47,52 +47,48 @@ export const init = () => { * @method registerListenerEvents */ const registerListenerEvents = () => { - const events = [ - 'click', - CustomEvents.events.activate, - CustomEvents.events.keyboardActivate - ]; - CustomEvents.define(document, events); - let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers(); + const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('user')); - // Register events. - events.forEach((event) => { - document.addEventListener(event, async(e) => { - const trigger = e.target.closest('.userwidget'); - if (trigger) { - const courseID = trigger.dataset.courseid; - const groupId = trigger.dataset.groupid; - e.preventDefault(); + // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed). + $(Selectors.elements.getSearchWidgetSelector('user')).on('show.bs.dropdown', async(e) => { + const courseID = e.relatedTarget.dataset.courseid; + const groupId = e.relatedTarget.dataset.groupid; + const actionBaseUrl = Url.relativeUrl('/grade/report/singleview/index.php', {item: 'user'}, false); + // Display a loading icon in the dropdown menu container until the body promise is resolved. + await WidgetBase.showLoader(dropdownMenuContainer); - const actionBaseUrl = Url.relativeUrl('/grade/report/singleview/index.php', {item: 'user'}, false); - // If an error occurs while fetching the data, display the error within the modal. - const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => { - const errorTemplateData = { - 'errormessage': e.message - }; - bodyPromiseResolver( - await Templates.render('core_grades/searchwidget/error', errorTemplateData) - ); - }); - // Early return if there is no module data. - if (data === []) { - return; - } - WidgetBase.init( - bodyPromise, - data.users, - searchUsers(), - getString('selectauser', 'grades') - ); - } + // If an error occurs while fetching the data, display the error within the dropdown menu. + const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => { + const errorTemplateData = { + 'errormessage': e.message + }; + bodyPromiseResolver( + await Templates.render('core_grades/searchwidget/error', errorTemplateData) + ); }); + + // Early return if there is no module data. + if (data === []) { + return; + } + + await WidgetBase.init( + dropdownMenuContainer, + bodyPromise, + data.users, + searchUsers() + ); + + // Resolvers for passed functions in the dropdown menu creation. + bodyPromiseResolver(Templates.render('core_grades/searchwidget/user/usersearch_body', [])); + }); + + // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed). + $(Selectors.elements.getSearchWidgetSelector('user')).on('hide.bs.dropdown', () => { + // Reset the state once the user menu dropdown is closed. + dropdownMenuContainer.innerHTML = ''; }); - // Resolvers for passed functions in the modal creation. - bodyPromiseResolver(Templates.render( - 'core_grades/searchwidget/user/usersearch_body', - [] - )); }; /** diff --git a/grade/report/singleview/classes/external/singleview.php b/grade/report/singleview/classes/external/singleview.php index 6f73bbbe57d..6a1dd25472b 100644 --- a/grade/report/singleview/classes/external/singleview.php +++ b/grade/report/singleview/classes/external/singleview.php @@ -85,7 +85,7 @@ class singleview extends core_course_external { $gradeitems = array_map(function ($gradeitem) use ($PAGE, $USER, $params) { $item = new \stdClass(); - $item->gid = $gradeitem->id; + $item->id = $gradeitem->id; $url = new moodle_url('/grade/report/singleview/index.php', [ 'id' => $params['courseid'], 'itemid' => $gradeitem->id, @@ -94,6 +94,7 @@ class singleview extends core_course_external { ); $item->name = $gradeitem->get_name(true); $item->url = $url->out(false); + $item->active = false; // @TODO MDL-76246 return $item; }, $gradeableitems); @@ -114,13 +115,14 @@ class singleview extends core_course_external { return new external_single_structure([ 'gradeitems' => new external_multiple_structure( new external_single_structure([ - 'gid' => new external_value(PARAM_INT, 'ID of the grade item', VALUE_OPTIONAL), + 'id' => new external_value(PARAM_INT, 'ID of the grade item', VALUE_OPTIONAL), 'url' => new external_value( PARAM_URL, 'The link to the grade report', VALUE_OPTIONAL ), 'name' => new external_value(PARAM_TEXT, 'The full name of the grade item', VALUE_OPTIONAL), + 'active' => new external_value(PARAM_BOOL, 'Are we currently on this item?', VALUE_REQUIRED) ]) ), 'warnings' => new external_warnings(), diff --git a/grade/report/singleview/renderer.php b/grade/report/singleview/renderer.php index 70b7998e1cc..8663e2b7106 100644 --- a/grade/report/singleview/renderer.php +++ b/grade/report/singleview/renderer.php @@ -61,7 +61,7 @@ class gradereport_singleview_renderer extends plugin_renderer_base { } $this->page->requires->js_call_amd('gradereport_singleview/user', 'init'); - return $this->render_from_template('gradereport_singleview/user_selector', $data); + return $this->render_from_template('core_grades/user_selector', $data); } /** diff --git a/grade/report/singleview/styles.css b/grade/report/singleview/styles.css index 2fe1cc15f8a..9d02f09f702 100644 --- a/grade/report/singleview/styles.css +++ b/grade/report/singleview/styles.css @@ -147,7 +147,7 @@ overflow: auto; } -.path-grade-report-singleview .user-selector .userinitials { +.path-grade-report-singleview .search-widget[data-searchtype="user"] .userinitials { width: 40px; height: 40px; } diff --git a/grade/report/singleview/templates/grade_item_selector.mustache b/grade/report/singleview/templates/grade_item_selector.mustache index 890711a02ae..0f68a908c94 100644 --- a/grade/report/singleview/templates/grade_item_selector.mustache +++ b/grade/report/singleview/templates/grade_item_selector.mustache @@ -29,8 +29,8 @@ } } }} -
-
+
+ +
diff --git a/grade/report/singleview/templates/user_selector.mustache b/grade/report/singleview/templates/user_selector.mustache deleted file mode 100644 index a9269571fac..00000000000 --- a/grade/report/singleview/templates/user_selector.mustache +++ /dev/null @@ -1,71 +0,0 @@ -{{! - This file is part of Moodle - http://moodle.org/ - Moodle is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - Moodle is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with Moodle. If not, see . -}} -{{! - @template gradereport_singleview/user_selector - - The user selector trigger element. - - Context variables required for this template: - * courseid - The course ID. - * groupid - The group ID. - * selectedoption - (optional) Object containing information about the selected option. - * image - The image corresponding to the selected option. - * text - The text of the selected option. - * additionaltext - (optional) Additional text displayed below the selected option (e.g. the user email) - - Example context (json): - { - "courseid": "2", - "groupid": "2", - "selectedoption": { - "image": "\"\"", - "text": "John Doe", - "additionaltext": "johndoe@example.com" - } - } -}} -
-
-
- {{#selectedoption}} -
- {{#image}} - {{{image}}} - {{/image}} - {{^image}} - - {{/image}} -
-
- - {{text}} - - {{#additionaltext}} - - {{additionaltext}} - - {{/additionaltext}} -
- {{/selectedoption}} - {{^selectedoption}} -
- -
- - {{/selectedoption}} -
-
-
diff --git a/grade/report/singleview/templates/zero_state.mustache b/grade/report/singleview/templates/zero_state.mustache index 9a918c4646a..38797640f65 100644 --- a/grade/report/singleview/templates/zero_state.mustache +++ b/grade/report/singleview/templates/zero_state.mustache @@ -27,7 +27,7 @@ } }}
- {{#str}}pluginname, gradereport_singleview{{/str}} +

{{#str}}pluginname, gradereport_singleview{{/str}}

{{#str}}viewsingleuserorgradeitem, gradereport_singleview{{/str}}

diff --git a/grade/report/singleview/templates/zero_state_grade.mustache b/grade/report/singleview/templates/zero_state_grade.mustache index 955415cfce8..3cf1aadba3e 100644 --- a/grade/report/singleview/templates/zero_state_grade.mustache +++ b/grade/report/singleview/templates/zero_state_grade.mustache @@ -25,7 +25,7 @@ } }}
- {{#str}}viewsinglegradeitem, gradereport_singleview{{/str}} +

{{#str}}viewsinglegradeitem, gradereport_singleview{{/str}}

{{#str}}singleviewdescription, gradereport_singleview{{/str}}

diff --git a/grade/report/singleview/templates/zero_state_user.mustache b/grade/report/singleview/templates/zero_state_user.mustache index e3d8c2c898f..8af52294598 100644 --- a/grade/report/singleview/templates/zero_state_user.mustache +++ b/grade/report/singleview/templates/zero_state_user.mustache @@ -25,7 +25,7 @@ } }}
- {{#str}}viewsingleuser, gradereport_singleview{{/str}} +

{{#str}}viewsingleuser, gradereport_singleview{{/str}}

{{#str}}singleviewdescription, gradereport_singleview{{/str}}

diff --git a/grade/report/singleview/tests/behat/gradeitemsearch.feature b/grade/report/singleview/tests/behat/gradeitemsearch.feature index 6fd0686a6f7..03c5a99edb2 100644 --- a/grade/report/singleview/tests/behat/gradeitemsearch.feature +++ b/grade/report/singleview/tests/behat/gradeitemsearch.feature @@ -22,10 +22,10 @@ Feature: Given we have opted to search for a grade item, Lets find and search th Scenario: A teacher can search for and find a grade item to view Given I navigate to "View > Single view" in the course gradebook And I click on "Grade items" "link" in the ".page-toggler" "css_element" - When I click on ".gradewidget" "css_element" - Then I confirm "Test assignment one" in "Select a grade item" search within the gradebook widget exists - And I confirm "Test assignment two" in "Select a grade item" search within the gradebook widget exists + When I click on ".search-widget[data-searchtype='grade']" "css_element" + Then I confirm "Test assignment one" in "grade" search within the gradebook widget exists + And I confirm "Test assignment two" in "grade" search within the gradebook widget exists And I set the field "searchinput" to "two" And I wait "1" seconds - And I confirm "Test assignment two" in "Select a grade item" search within the gradebook widget exists - And I confirm "Test assignment one" in "Select a grade item" search within the gradebook widget does not exist + And I confirm "Test assignment two" in "grade" search within the gradebook widget exists + And I confirm "Test assignment one" in "grade" search within the gradebook widget does not exist diff --git a/grade/report/singleview/tests/behat/reportswitching.feature b/grade/report/singleview/tests/behat/reportswitching.feature index 41b872be791..feb106d8e45 100644 --- a/grade/report/singleview/tests/behat/reportswitching.feature +++ b/grade/report/singleview/tests/behat/reportswitching.feature @@ -21,9 +21,10 @@ Feature: Given we land on the index page, select what type of report we wish to Scenario: I switch between the two report types within singleview Given I navigate to "View > Single view" in the course gradebook And I click on "Grade items" "link" in the ".page-toggler" "css_element" - When I click on ".gradewidget" "css_element" - Then I wait until "Select a grade item" "dialogue" exists - And I click on "Close" "button" in the "Select a grade item" "dialogue" - And I click on "Users" "link" in the ".page-toggler" "css_element" - And I click on ".userwidget" "css_element" - And I wait until "Select a user" "dialogue" exists + And ".search-widget[data-searchtype='user']" "css_element" should not exist + And ".search-widget[data-searchtype='grade']" "css_element" should exist + And I confirm "assign" in "grade" search within the gradebook widget exists + When I click on "Users" "link" in the ".page-toggler" "css_element" + Then ".search-widget[data-searchtype='grade']" "css_element" should not exist + And ".search-widget[data-searchtype='user']" "css_element" should exist + And I confirm "student1" in "user" search within the gradebook widget exists diff --git a/grade/report/singleview/tests/behat/singleview.feature b/grade/report/singleview/tests/behat/singleview.feature index 9e9d9f55d21..aa2f53fad33 100644 --- a/grade/report/singleview/tests/behat/singleview.feature +++ b/grade/report/singleview/tests/behat/singleview.feature @@ -59,7 +59,7 @@ Feature: We can use Single view Scenario: I can update grades, add feedback and exclude grades. Given I navigate to "View > Single view" in the course gradebook - And I click on "Users" "link" + And I click on "Users" "link" in the ".page-toggler" "css_element" And I click on "Student" in the "user" search widget And I turn editing mode on And I set the field "Override for Test assignment one" to "1" @@ -99,7 +99,7 @@ Feature: We can use Single view And I log in as "teacher2" And I am on "Course 1" course homepage Given I navigate to "View > Single view" in the course gradebook - And I click on "Users" "link" + And I click on "Users" "link" in the ".page-toggler" "css_element" And I click on "Student" in the "user" search widget And I turn editing mode on And the "Exclude for Test assignment one" "checkbox" should be disabled diff --git a/grade/report/singleview/tests/behat/usersearch.feature b/grade/report/singleview/tests/behat/usersearch.feature index a79d3f38973..5108f23ef02 100644 --- a/grade/report/singleview/tests/behat/usersearch.feature +++ b/grade/report/singleview/tests/behat/usersearch.feature @@ -23,12 +23,12 @@ Feature: Within the singleview report, a teacher can search for users. Given I navigate to "View > Single view" in the course gradebook When I click on "Users" "link" in the ".page-toggler" "css_element" And I wait until the page is ready - And I click on ".userwidget" "css_element" - Then I confirm "Student 1" in "Select a user" search within the gradebook widget exists - And I confirm "Student 2" in "Select a user" search within the gradebook widget exists - And I confirm "Student 32" in "Select a user" search within the gradebook widget exists + And I click on ".search-widget[data-searchtype='user']" "css_element" + Then I confirm "Student 1" in "user" search within the gradebook widget exists + And I confirm "Student 2" in "user" search within the gradebook widget exists + And I confirm "Student 32" in "user" search within the gradebook widget exists And I set the field "searchinput" to "2" And I wait "1" seconds - And I confirm "Student 2" in "Select a user" search within the gradebook widget exists - And I confirm "Student 32" in "Select a user" search within the gradebook widget exists - And I confirm "Student 1" in "Select a user" search within the gradebook widget does not exist + And I confirm "Student 2" in "user" search within the gradebook widget exists + And I confirm "Student 32" in "user" search within the gradebook widget exists + And I confirm "Student 1" in "user" search within the gradebook widget does not exist diff --git a/grade/report/user/amd/build/user.min.js b/grade/report/user/amd/build/user.min.js index 85735074c39..e5018892cf3 100644 --- a/grade/report/user/amd/build/user.min.js +++ b/grade/report/user/amd/build/user.min.js @@ -1,10 +1,10 @@ -define("gradereport_user/user",["exports","core/pending","core/templates","core/custom_interaction_events","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/str","core/url"],(function(_exports,_pending,Templates,_custom_interaction_events,Repository,WidgetBase,_str,_url){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} +define("gradereport_user/user",["exports","core/pending","core/templates","core_grades/searchwidget/repository","core_grades/searchwidget/basewidget","core/str","core/url","jquery","core_grades/searchwidget/selectors"],(function(_exports,_pending,Templates,Repository,WidgetBase,_str,_url,_jquery,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** - * A small modal to search users within the gradebook. + * A widget to search users within the gradebook. * * @module gradereport_user/user * @copyright 2022 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_url=_interopRequireDefault(_url);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events);let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();events.forEach((event=>{document.addEventListener(event,(async e=>{const trigger=e.target.closest(".userwidget");if(trigger){const courseID=trigger.dataset.courseid,groupId=trigger.dataset.groupid;e.preventDefault();const actionBaseUrl=_url.default.relativeUrl("/grade/report/user/index.php",{},!1),data=await Repository.userFetch(courseID,actionBaseUrl,groupId).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));if(data===[])return;const allUsersOptionName=await(0,_str.get_string)("allusersnum","gradereport_user",data.users.length),allUsersOption=await Templates.render("core_grades/searchwidget/searchitem",{id:0,name:allUsersOptionName,url:_url.default.relativeUrl("/grade/report/user/index.php",{id:courseID,userid:0},!1)});WidgetBase.init(bodyPromise,data.users,searchUsers(),(0,_str.get_string)("selectauser","grades"),allUsersOption)}}))})),bodyPromiseResolver(Templates.render("core_grades/searchwidget/user/usersearch_body",{displayunsearchablecontent:!0}))},searchUsers=()=>()=>(users,searchTerm)=>{if(""===searchTerm)return users;searchTerm=searchTerm.toLowerCase();const searchResults=[];return users.forEach((user=>{user.fullname.toLowerCase().includes(searchTerm)&&searchResults.push(user)})),searchResults}})); + */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Templates=_interopRequireWildcard(Templates),Repository=_interopRequireWildcard(Repository),WidgetBase=_interopRequireWildcard(WidgetBase),_url=_interopRequireDefault(_url),_jquery=_interopRequireDefault(_jquery),Selectors=_interopRequireWildcard(Selectors);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{let{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}=WidgetBase.promisesAndResolvers();const dropdownMenuContainer=document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector("user"));(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("user")).on("show.bs.dropdown",(async e=>{const courseID=e.relatedTarget.dataset.courseid,groupId=e.relatedTarget.dataset.groupid,actionBaseUrl=_url.default.relativeUrl("/grade/report/user/index.php",{},!1);await WidgetBase.showLoader(dropdownMenuContainer);const data=await Repository.userFetch(courseID,actionBaseUrl,groupId).catch((async e=>{const errorTemplateData={errormessage:e.message};bodyPromiseResolver(await Templates.render("core_grades/searchwidget/error",errorTemplateData))}));if(data===[])return;const allUsersOptionName=await(0,_str.get_string)("allusersnum","gradereport_user",data.users.length),allUsersOption=await Templates.render("gradereport_user/all_users_item",{id:0,name:allUsersOptionName,url:_url.default.relativeUrl("/grade/report/user/index.php",{id:courseID,userid:0},!1)});await WidgetBase.init(dropdownMenuContainer,bodyPromise,data.users,searchUsers(),allUsersOption),bodyPromiseResolver(Templates.render("core_grades/searchwidget/user/usersearch_body",{displayunsearchablecontent:!0}))})),(0,_jquery.default)(Selectors.elements.getSearchWidgetSelector("user")).on("hide.bs.dropdown",(()=>{dropdownMenuContainer.innerHTML=""}))},searchUsers=()=>()=>(users,searchTerm)=>{if(""===searchTerm)return users;searchTerm=searchTerm.toLowerCase();const searchResults=[];return users.forEach((user=>{user.fullname.toLowerCase().includes(searchTerm)&&searchResults.push(user)})),searchResults}})); //# sourceMappingURL=user.min.js.map \ No newline at end of file diff --git a/grade/report/user/amd/build/user.min.js.map b/grade/report/user/amd/build/user.min.js.map index 82a3f8ed0fd..64792d3b973 100644 --- a/grade/report/user/amd/build/user.min.js.map +++ b/grade/report/user/amd/build/user.min.js.map @@ -1 +1 @@ -{"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A small modal to search users within the gradebook.\n *\n * @module gradereport_user/user\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport {get_string as getString} from 'core/str';\nimport Url from 'core/url';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register user search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, async(e) => {\n const trigger = e.target.closest('.userwidget');\n if (trigger) {\n const courseID = trigger.dataset.courseid;\n const groupId = trigger.dataset.groupid;\n e.preventDefault();\n\n const actionBaseUrl = Url.relativeUrl('/grade/report/user/index.php', {}, false);\n // If an error occurs while fetching the data, display the error within the modal.\n const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n\n // The HTML for the 'All users' option which will be rendered in the non-searchable content are of the widget.\n const allUsersOptionName = await getString('allusersnum', 'gradereport_user', data.users.length);\n const allUsersOption = await Templates.render('core_grades/searchwidget/searchitem', {\n id: 0,\n name: allUsersOptionName,\n url: Url.relativeUrl('/grade/report/user/index.php', {id: courseID, userid: 0}, false),\n });\n\n WidgetBase.init(\n bodyPromise,\n data.users,\n searchUsers(),\n getString('selectauser', 'grades'),\n allUsersOption\n );\n }\n });\n });\n // Resolvers for passed functions in the modal creation.\n bodyPromiseResolver(Templates.render(\n 'core_grades/searchwidget/user/usersearch_body', {displayunsearchablecontent: true}\n ));\n};\n\n/**\n * Define how we want to search and filter users when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchUsers = () => {\n return () => {\n return (users, searchTerm) => {\n if (searchTerm === '') {\n return users;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n users.forEach((user) => {\n const userName = user.fullname.toLowerCase();\n if (userName.includes(searchTerm)) {\n searchResults.push(user);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","events","CustomEvents","activate","keyboardActivate","define","document","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","forEach","event","addEventListener","async","trigger","e","target","closest","courseID","dataset","courseid","groupId","groupid","preventDefault","actionBaseUrl","Url","relativeUrl","data","Repository","userFetch","catch","errorTemplateData","message","Templates","render","allUsersOptionName","users","length","allUsersOption","id","name","url","userid","init","searchUsers","displayunsearchablecontent","searchTerm","toLowerCase","searchResults","user","fullname","includes","push"],"mappings":";;;;;;;qYAqCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,WACrBE,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOC,SAAUL,YAE1BM,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,uBAGpDT,OAAOU,SAASC,QACZN,SAASO,iBAAiBD,OAAOE,MAAAA,UACvBC,QAAUC,EAAEC,OAAOC,QAAQ,kBAC7BH,QAAS,OACHI,SAAWJ,QAAQK,QAAQC,SAC3BC,QAAUP,QAAQK,QAAQG,QAChCP,EAAEQ,uBAEIC,cAAgBC,aAAIC,YAAY,+BAAgC,IAAI,GAEpEC,WAAaC,WAAWC,UAAUX,SAAUM,cAAeH,SAASS,OAAMjB,MAAAA,UACtEkB,kBAAoB,cACNhB,EAAEiB,SAEtB1B,0BACU2B,UAAUC,OAAO,iCAAkCH,0BAK7DJ,OAAS,gBAKPQ,yBAA2B,mBAAU,cAAe,mBAAoBR,KAAKS,MAAMC,QACnFC,qBAAuBL,UAAUC,OAAO,sCAAuC,CACjFK,GAAI,EACJC,KAAML,mBACNM,IAAKhB,aAAIC,YAAY,+BAAgC,CAACa,GAAIrB,SAAUwB,OAAQ,IAAI,KAGpFlC,WAAWmC,KACPpC,YACAoB,KAAKS,MACLQ,eACA,mBAAU,cAAe,UACzBN,uBAMhBhC,oBAAoB2B,UAAUC,OAC1B,gDAAiD,CAACW,4BAA4B,MAUhFD,YAAc,IACT,IACI,CAACR,MAAOU,iBACQ,KAAfA,kBACOV,MAEXU,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBZ,MAAM1B,SAASuC,OACMA,KAAKC,SAASH,cAClBI,SAASL,aAClBE,cAAcI,KAAKH,SAGpBD"} \ No newline at end of file +{"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * A widget to search users within the gradebook.\n *\n * @module gradereport_user/user\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Templates from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport * as WidgetBase from 'core_grades/searchwidget/basewidget';\nimport {get_string as getString} from 'core/str';\nimport Url from 'core/url';\nimport $ from 'jquery';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\n\n/**\n * Our entry point into starting to build the search widget.\n * It'll eventually, based upon the listeners, open the search widget and allow filtering.\n *\n * @method init\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register user search widget related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers();\n const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('user'));\n\n // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed).\n $(Selectors.elements.getSearchWidgetSelector('user')).on('show.bs.dropdown', async(e) => {\n const courseID = e.relatedTarget.dataset.courseid;\n const groupId = e.relatedTarget.dataset.groupid;\n const actionBaseUrl = Url.relativeUrl('/grade/report/user/index.php', {}, false);\n // Display a loading icon in the dropdown menu container until the body promise is resolved.\n await WidgetBase.showLoader(dropdownMenuContainer);\n\n // If an error occurs while fetching the data, display the error within the dropdown menu.\n const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => {\n const errorTemplateData = {\n 'errormessage': e.message\n };\n bodyPromiseResolver(\n await Templates.render('core_grades/searchwidget/error', errorTemplateData)\n );\n });\n\n // Early return if there is no module data.\n if (data === []) {\n return;\n }\n\n // The HTML for the 'All users' option which will be rendered in the non-searchable content are of the widget.\n const allUsersOptionName = await getString('allusersnum', 'gradereport_user', data.users.length);\n const allUsersOption = await Templates.render('gradereport_user/all_users_item', {\n id: 0,\n name: allUsersOptionName,\n url: Url.relativeUrl('/grade/report/user/index.php', {id: courseID, userid: 0}, false),\n });\n\n await WidgetBase.init(\n dropdownMenuContainer,\n bodyPromise,\n data.users,\n searchUsers(),\n allUsersOption\n );\n\n // Resolvers for passed functions in the dropdown menu creation.\n bodyPromiseResolver(Templates.render(\n 'core_grades/searchwidget/user/usersearch_body', {displayunsearchablecontent: true}\n ));\n });\n\n // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed).\n $(Selectors.elements.getSearchWidgetSelector('user')).on('hide.bs.dropdown', () => {\n // Reset the state once the user menu dropdown is closed.\n dropdownMenuContainer.innerHTML = '';\n });\n};\n\n/**\n * Define how we want to search and filter users when the user decides to input a search value.\n *\n * @method registerListenerEvents\n * @returns {function(): function(*, *): (*)}\n */\nconst searchUsers = () => {\n return () => {\n return (users, searchTerm) => {\n if (searchTerm === '') {\n return users;\n }\n searchTerm = searchTerm.toLowerCase();\n const searchResults = [];\n users.forEach((user) => {\n const userName = user.fullname.toLowerCase();\n if (userName.includes(searchTerm)) {\n searchResults.push(user);\n }\n });\n return searchResults;\n };\n };\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","bodyPromiseResolver","bodyPromise","WidgetBase","promisesAndResolvers","dropdownMenuContainer","document","querySelector","Selectors","elements","getSearchWidgetDropdownSelector","getSearchWidgetSelector","on","async","courseID","e","relatedTarget","dataset","courseid","groupId","groupid","actionBaseUrl","Url","relativeUrl","showLoader","data","Repository","userFetch","catch","errorTemplateData","message","Templates","render","allUsersOptionName","users","length","allUsersOption","id","name","url","userid","init","searchUsers","displayunsearchablecontent","innerHTML","searchTerm","toLowerCase","searchResults","forEach","user","fullname","includes","push"],"mappings":";;;;;;;4YAsCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,SACvBE,oBAACA,oBAADC,YAAsBA,aAAeC,WAAWC,6BAC9CC,sBAAwBC,SAASC,cAAcC,UAAUC,SAASC,gCAAgC,6BAGtGF,UAAUC,SAASE,wBAAwB,SAASC,GAAG,oBAAoBC,MAAAA,UACnEC,SAAWC,EAAEC,cAAcC,QAAQC,SACnCC,QAAUJ,EAAEC,cAAcC,QAAQG,QAClCC,cAAgBC,aAAIC,YAAY,+BAAgC,IAAI,SAEpEpB,WAAWqB,WAAWnB,6BAGtBoB,WAAaC,WAAWC,UAAUb,SAAUO,cAAeF,SAASS,OAAMf,MAAAA,UACtEgB,kBAAoB,cACNd,EAAEe,SAEtB7B,0BACU8B,UAAUC,OAAO,iCAAkCH,0BAK7DJ,OAAS,gBAKPQ,yBAA2B,mBAAU,cAAe,mBAAoBR,KAAKS,MAAMC,QACnFC,qBAAuBL,UAAUC,OAAO,kCAAmC,CAC7EK,GAAI,EACJC,KAAML,mBACNM,IAAKjB,aAAIC,YAAY,+BAAgC,CAACc,GAAIvB,SAAU0B,OAAQ,IAAI,WAG9ErC,WAAWsC,KACbpC,sBACAH,YACAuB,KAAKS,MACLQ,cACAN,gBAIJnC,oBAAoB8B,UAAUC,OAC1B,gDAAiD,CAACW,4BAA4B,4BAKpFnC,UAAUC,SAASE,wBAAwB,SAASC,GAAG,oBAAoB,KAEzEP,sBAAsBuC,UAAY,OAUpCF,YAAc,IACT,IACI,CAACR,MAAOW,iBACQ,KAAfA,kBACOX,MAEXW,WAAaA,WAAWC,oBAClBC,cAAgB,UACtBb,MAAMc,SAASC,OACMA,KAAKC,SAASJ,cAClBK,SAASN,aAClBE,cAAcK,KAAKH,SAGpBF"} \ No newline at end of file diff --git a/grade/report/user/amd/src/user.js b/grade/report/user/amd/src/user.js index 4a2f66517b9..df87e19ac3c 100644 --- a/grade/report/user/amd/src/user.js +++ b/grade/report/user/amd/src/user.js @@ -14,7 +14,7 @@ // along with Moodle. If not, see . /** - * A small modal to search users within the gradebook. + * A widget to search users within the gradebook. * * @module gradereport_user/user * @copyright 2022 Mathew May @@ -23,11 +23,12 @@ import Pending from 'core/pending'; import * as Templates from 'core/templates'; -import CustomEvents from "core/custom_interaction_events"; import * as Repository from 'core_grades/searchwidget/repository'; import * as WidgetBase from 'core_grades/searchwidget/basewidget'; import {get_string as getString} from 'core/str'; import Url from 'core/url'; +import $ from 'jquery'; +import * as Selectors from 'core_grades/searchwidget/selectors'; /** * Our entry point into starting to build the search widget. @@ -47,62 +48,59 @@ export const init = () => { * @method registerListenerEvents */ const registerListenerEvents = () => { - const events = [ - 'click', - CustomEvents.events.activate, - CustomEvents.events.keyboardActivate - ]; - CustomEvents.define(document, events); - let {bodyPromiseResolver, bodyPromise} = WidgetBase.promisesAndResolvers(); + const dropdownMenuContainer = document.querySelector(Selectors.elements.getSearchWidgetDropdownSelector('user')); - // Register events. - events.forEach((event) => { - document.addEventListener(event, async(e) => { - const trigger = e.target.closest('.userwidget'); - if (trigger) { - const courseID = trigger.dataset.courseid; - const groupId = trigger.dataset.groupid; - e.preventDefault(); + // Handle the 'shown.bs.dropdown' event (Fired when the dropdown menu is fully displayed). + $(Selectors.elements.getSearchWidgetSelector('user')).on('show.bs.dropdown', async(e) => { + const courseID = e.relatedTarget.dataset.courseid; + const groupId = e.relatedTarget.dataset.groupid; + const actionBaseUrl = Url.relativeUrl('/grade/report/user/index.php', {}, false); + // Display a loading icon in the dropdown menu container until the body promise is resolved. + await WidgetBase.showLoader(dropdownMenuContainer); - const actionBaseUrl = Url.relativeUrl('/grade/report/user/index.php', {}, false); - // If an error occurs while fetching the data, display the error within the modal. - const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => { - const errorTemplateData = { - 'errormessage': e.message - }; - bodyPromiseResolver( - await Templates.render('core_grades/searchwidget/error', errorTemplateData) - ); - }); - - // Early return if there is no module data. - if (data === []) { - return; - } - - // The HTML for the 'All users' option which will be rendered in the non-searchable content are of the widget. - const allUsersOptionName = await getString('allusersnum', 'gradereport_user', data.users.length); - const allUsersOption = await Templates.render('core_grades/searchwidget/searchitem', { - id: 0, - name: allUsersOptionName, - url: Url.relativeUrl('/grade/report/user/index.php', {id: courseID, userid: 0}, false), - }); - - WidgetBase.init( - bodyPromise, - data.users, - searchUsers(), - getString('selectauser', 'grades'), - allUsersOption - ); - } + // If an error occurs while fetching the data, display the error within the dropdown menu. + const data = await Repository.userFetch(courseID, actionBaseUrl, groupId).catch(async(e) => { + const errorTemplateData = { + 'errormessage': e.message + }; + bodyPromiseResolver( + await Templates.render('core_grades/searchwidget/error', errorTemplateData) + ); }); + + // Early return if there is no module data. + if (data === []) { + return; + } + + // The HTML for the 'All users' option which will be rendered in the non-searchable content are of the widget. + const allUsersOptionName = await getString('allusersnum', 'gradereport_user', data.users.length); + const allUsersOption = await Templates.render('gradereport_user/all_users_item', { + id: 0, + name: allUsersOptionName, + url: Url.relativeUrl('/grade/report/user/index.php', {id: courseID, userid: 0}, false), + }); + + await WidgetBase.init( + dropdownMenuContainer, + bodyPromise, + data.users, + searchUsers(), + allUsersOption + ); + + // Resolvers for passed functions in the dropdown menu creation. + bodyPromiseResolver(Templates.render( + 'core_grades/searchwidget/user/usersearch_body', {displayunsearchablecontent: true} + )); + }); + + // Handle the 'hide.bs.dropdown' event (Fired when the dropdown menu is being closed). + $(Selectors.elements.getSearchWidgetSelector('user')).on('hide.bs.dropdown', () => { + // Reset the state once the user menu dropdown is closed. + dropdownMenuContainer.innerHTML = ''; }); - // Resolvers for passed functions in the modal creation. - bodyPromiseResolver(Templates.render( - 'core_grades/searchwidget/user/usersearch_body', {displayunsearchablecontent: true} - )); }; /** diff --git a/grade/report/user/lang/en/gradereport_user.php b/grade/report/user/lang/en/gradereport_user.php index b416f71050c..63b67cc64e5 100644 --- a/grade/report/user/lang/en/gradereport_user.php +++ b/grade/report/user/lang/en/gradereport_user.php @@ -30,7 +30,7 @@ $string['gotonextreport'] = 'Go to next user report'; $string['gotopreviousreport'] = 'Go to previous user report'; $string['pluginname'] = 'User report'; $string['user:view'] = 'View your own grade report'; +$string['userreportdesc'] = 'View a user\'s grades, any feedback and the course total.'; +$string['userreports'] = 'User reports'; $string['privacy:metadata:preference:gradereport_user_view_user'] = 'Whether to view report as current user or another user in the gradebook reports'; -$string['selectuser'] = 'Select a user to view their grades'; -$string['selectuserinstructions'] = 'By selecting a user you can view the grades by activity'; $string['tablesummary'] = 'The table is arranged as a list of graded items including categories of graded items. When items are in a category they will be indicated as such.'; diff --git a/grade/report/user/renderer.php b/grade/report/user/renderer.php index cb009288639..c8d82de2dc6 100644 --- a/grade/report/user/renderer.php +++ b/grade/report/user/renderer.php @@ -127,7 +127,7 @@ class gradereport_user_renderer extends plugin_renderer_base { } $this->page->requires->js_call_amd('gradereport_user/user', 'init'); - return $this->render_from_template('gradereport_user/user_selector', $data); + return $this->render_from_template('core_grades/user_selector', $data); } /** diff --git a/grade/report/user/styles.css b/grade/report/user/styles.css index fa84f0e9299..05335c51e98 100644 --- a/grade/report/user/styles.css +++ b/grade/report/user/styles.css @@ -148,7 +148,7 @@ align-items: center; } -.path-grade-report-user .user-selector .userinitials { +.path-grade-report-user .search-widget[data-searchtype="user"] .userinitials { width: 40px; height: 40px; } diff --git a/grade/report/user/templates/all_users_item.mustache b/grade/report/user/templates/all_users_item.mustache new file mode 100644 index 00000000000..7c2d29bf2f6 --- /dev/null +++ b/grade/report/user/templates/all_users_item.mustache @@ -0,0 +1,33 @@ +{{! + This file is part of Moodle - http://moodle.org/ + + Moodle is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + Moodle is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with Moodle. If not, see . +}} +{{! + @template gradereport_user/all_users_item + + Search result line items. + + Example context (json): + { + "id": "0", + "name": "All users(10)", + "url": "http://foo.bar/gradereport/?userid=0&id=2" + } +}} + + + {{name}} + + diff --git a/grade/report/user/templates/zero_state.mustache b/grade/report/user/templates/zero_state.mustache index 69b9cb174e4..3d07c13c49f 100644 --- a/grade/report/user/templates/zero_state.mustache +++ b/grade/report/user/templates/zero_state.mustache @@ -25,7 +25,7 @@ } }}
- {{#str}}selectuser, gradereport_user{{/str}} -

{{#str}}selectuser, gradereport_user{{/str}}

-

{{#str}}selectuserinstructions, gradereport_user{{/str}}

+ +

{{#str}}userreports, gradereport_user{{/str}}

+

{{#str}}userreportdesc, gradereport_user{{/str}}

diff --git a/grade/report/user/tests/behat/groupsearch.feature b/grade/report/user/tests/behat/groupsearch.feature index d594396862f..d8e3bf9b74f 100644 --- a/grade/report/user/tests/behat/groupsearch.feature +++ b/grade/report/user/tests/behat/groupsearch.feature @@ -28,50 +28,38 @@ Feature: Group searching functionality within the user report. Scenario: A teacher can see the 'group' search widget only when group mode is enabled in the course Given I navigate to "View > User report" in the course gradebook - And ".groupwidget" "css_element" should exist + And ".search-widget[data-searchtype='group']" "css_element" should exist And I am on "Course 1" course homepage And I navigate to "Settings" in current page administration And I set the following fields to these values: | id_groupmode | No groups | And I press "Save and display" When I navigate to "View > User report" in the course gradebook - Then ".groupwidget" "css_element" should not exist + Then ".search-widget[data-searchtype='group']" "css_element" should not exist Scenario: A teacher can search for and find a group to find a user in Given I navigate to "View > User report" in the course gradebook - And I click on ".groupwidget" "css_element" - And I wait until "Select a group" "dialogue" exists - And I should see "Tutor group" in the "Select a group" "dialogue" - And I should see "Marker group" in the "Select a group" "dialogue" + And I click on ".search-widget[data-searchtype='group']" "css_element" + And I confirm "Tutor group" in "group" search within the gradebook widget exists + And I confirm "Marker group" in "group" search within the gradebook widget exists When I set the field "searchinput" to "tutor" And I wait "1" seconds - Then I should see "Tutor group" in the "Select a group" "dialogue" - And I should not see "Marker group" in the "Select a group" "dialogue" + Then I confirm "Tutor group" in "group" search within the gradebook widget exists + And I confirm "Marker group" in "group" search within the gradebook widget does not exist Scenario: A teacher can only see the group members in the 'user' search widget after selecting a group option Given I navigate to "View > User report" in the course gradebook # Confirm that all users are initially displayed in the 'user' search widget. - And I click on ".userwidget" "css_element" - And I wait until "Select a user" "dialogue" exists - And I should see "Student 1" in the "Select a user" "dialogue" - And I should see "Student 2" in the "Select a user" "dialogue" - And I click on "Close" "button" in the "Select a user" "dialogue" + And I confirm "Student 1" in "user" search within the gradebook widget exists + And I confirm "Student 2" in "user" search within the gradebook widget exists # Select a particular group from the 'group' search widget. When I click on "Default group" in the "group" search widget # Confirm that only users which are members of the selected group are displayed in the 'user' search widget. - And I click on ".userwidget" "css_element" - And I wait until "Select a user" "dialogue" exists - Then I should see "Student 1" in the "Select a user" "dialogue" - And I should not see "Student 2" in the "Select a user" "dialogue" - And I click on "Close" "button" in the "Select a user" "dialogue" + And I confirm "Student 1" in "user" search within the gradebook widget exists + And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "Tutor group" in the "group" search widget - And I click on ".userwidget" "css_element" - And I wait until "Select a user" "dialogue" exists - And I should not see "Student 1" in the "Select a user" "dialogue" - And I should not see "Student 2" in the "Select a user" "dialogue" - And I click on "Close" "button" in the "Select a user" "dialogue" + And I confirm "Student 1" in "user" search within the gradebook widget does not exist + And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "All participants" in the "group" search widget - And I click on ".userwidget" "css_element" - And I wait until "Select a user" "dialogue" exists - And I should see "Student 1" in the "Select a user" "dialogue" - And I should see "Student 2" in the "Select a user" "dialogue" + And I confirm "Student 1" in "user" search within the gradebook widget exists + And I confirm "Student 2" in "user" search within the gradebook widget exists diff --git a/grade/report/user/tests/behat/usersearch.feature b/grade/report/user/tests/behat/usersearch.feature index 40d654abbe1..59d3a77940d 100644 --- a/grade/report/user/tests/behat/usersearch.feature +++ b/grade/report/user/tests/behat/usersearch.feature @@ -21,12 +21,12 @@ Feature: Within the User report, a teacher can search for users. Scenario: A teacher can search for and find a user to view Given I navigate to "View > User report" in the course gradebook - When I click on ".userwidget" "css_element" - Then I confirm "Student 1" in "Select a user" search within the gradebook widget exists - And I confirm "Student 2" in "Select a user" search within the gradebook widget exists - And I confirm "Student 32" in "Select a user" search within the gradebook widget exists + When I click on ".search-widget[data-searchtype='user']" "css_element" + Then I confirm "Student 1" in "user" search within the gradebook widget exists + And I confirm "Student 2" in "user" search within the gradebook widget exists + And I confirm "Student 32" in "user" search within the gradebook widget exists And I set the field "searchinput" to "2" And I wait "1" seconds - And I confirm "Student 2" in "Select a user" search within the gradebook widget exists - And I confirm "Student 32" in "Select a user" search within the gradebook widget exists - And I confirm "Student 1" in "Select a user" search within the gradebook widget does not exist + And I confirm "Student 2" in "user" search within the gradebook widget exists + And I confirm "Student 32" in "user" search within the gradebook widget exists + And I confirm "Student 1" in "user" search within the gradebook widget does not exist diff --git a/grade/templates/group_selector.mustache b/grade/templates/group_selector.mustache index 7adef07653d..987d1ef912e 100644 --- a/grade/templates/group_selector.mustache +++ b/grade/templates/group_selector.mustache @@ -33,8 +33,8 @@ "selectedgroup": "Group 1" } }} -
-
+
+ +
diff --git a/grade/templates/searchwidget/loading.mustache b/grade/templates/searchwidget/loading.mustache new file mode 100644 index 00000000000..7625998f023 --- /dev/null +++ b/grade/templates/searchwidget/loading.mustache @@ -0,0 +1,27 @@ +{{! + This file is part of Moodle - http://moodle.org/ + + Moodle is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + Moodle is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with Moodle. If not, see . +}} +{{! + @template core_grades/searchwidget/loading + + This template renders the loading placeholder for the search widget. + + Example context (json): + {} +}} +
+ {{> core/loading }} +
diff --git a/grade/templates/searchwidget/searchitem.mustache b/grade/templates/searchwidget/searchitem.mustache index de0e4db5450..931d65f298f 100644 --- a/grade/templates/searchwidget/searchitem.mustache +++ b/grade/templates/searchwidget/searchitem.mustache @@ -24,25 +24,26 @@ "id": "1", "name": "Quiz 1", "url": "http://foo.bar/gradereport/?userid=25", - "fullname": "Cameron Greeve" + "fullname": "Cameron Greeve", + "active": true } }} -
+
  • {{#name}} - - + + {{name}} {{/name}} {{^name}} - - + + {{fullname}} - - {{email}} + {{/name}} -
    • + diff --git a/grade/templates/searchwidget/searchresults.mustache b/grade/templates/searchwidget/searchresults.mustache index 40d40a5c527..81fc63fa959 100644 --- a/grade/templates/searchwidget/searchresults.mustache +++ b/grade/templates/searchwidget/searchresults.mustache @@ -34,13 +34,13 @@ ] } }} -
    -
    +
    +
    +
    diff --git a/grade/templates/searchwidget/user/usersearch_body.mustache b/grade/templates/searchwidget/user/usersearch_body.mustache index 9f5be04520a..2a775f5d4e2 100644 --- a/grade/templates/searchwidget/user/usersearch_body.mustache +++ b/grade/templates/searchwidget/user/usersearch_body.mustache @@ -32,5 +32,5 @@
    {{#displayunsearchablecontent}} -
    + {{/displayunsearchablecontent}} diff --git a/grade/report/user/templates/user_selector.mustache b/grade/templates/user_selector.mustache similarity index 87% rename from grade/report/user/templates/user_selector.mustache rename to grade/templates/user_selector.mustache index 985fa0c0b50..b77d2f5e24a 100644 --- a/grade/report/user/templates/user_selector.mustache +++ b/grade/templates/user_selector.mustache @@ -15,7 +15,7 @@ along with Moodle. If not, see . }} {{! - @template gradereport_user/user_selector + @template core_grades/user_selector The user selector trigger element. @@ -38,8 +38,8 @@ } } }} -
    -
    +
    + +
    diff --git a/grade/tests/behat/behat_grade.php b/grade/tests/behat/behat_grade.php index c1f69b869e7..00c61eeeacf 100644 --- a/grade/tests/behat/behat_grade.php +++ b/grade/tests/behat/behat_grade.php @@ -426,38 +426,61 @@ class behat_grade extends behat_base { * Confirm if a value is within the search widget within the gradebook. * * Examples: - * - I confirm "User1" in "User" search within the gradebook widget exists + * - I confirm "User" in "user" search within the gradebook widget exists + * - I confirm "Group" in "group" search within the gradebook widget exists + * - I confirm "Grade item" in "grade" search within the gradebook widget exists * * @Given /^I confirm "(?P(?:[^"]|\\")*)" in "(?P(?:[^"]|\\")*)" search within the gradebook widget exists$/ * @param string $needle The value to search for. - * @param string $haystack The selector to use within the zero state. + * @param string $haystack The type of the search widget. */ public function i_confirm_in_search_within_the_gradebook_widget_exists($needle, $haystack) { - $this->execute("behat_general::wait_until_exists", [$haystack, "dialogue"]); - $this->execute("behat_general::assert_element_contains_text", [$needle, $haystack, "dialogue"]); + $triggercssselector = ".search-widget[data-searchtype='{$haystack}']"; + + // Make sure that the dropdown menu is visible. + $node = $this->find("css_element", "{$triggercssselector} .dropdown-menu"); + if (!$node->isVisible()) { + $this->execute("behat_general::i_click_on", [$triggercssselector, "css_element"]); + } + + $this->execute("behat_general::wait_until_the_page_is_ready"); + $this->execute("behat_general::assert_element_contains_text", + [$needle, "{$triggercssselector} .dropdown-menu", "css_element"]); } /** * Confirm if a value is not within the search widget within the gradebook. * * Examples: - * - I confirm "User1" in "User" search within the gradebook widget does not exist + * - I confirm "User" in "user" search within the gradebook widget does not exist + * - I confirm "Group" in "group" search within the gradebook widget does not exist + * - I confirm "Grade item" in "grade" search within the gradebook widget does not exist * * @Given /^I confirm "(?P(?:[^"]|\\")*)" in "(?P(?:[^"]|\\")*)" search within the gradebook widget does not exist$/ * @param string $needle The value to search for. - * @param string $haystack The selector to use within the zero state. + * @param string $haystack The type of the search widget. */ public function i_confirm_in_search_within_the_gradebook_widget_does_not_exist($needle, $haystack) { - $this->execute("behat_general::wait_until_exists", [$haystack, "dialogue"]); - $this->execute("behat_general::assert_element_not_contains_text", [$needle, $haystack, "dialogue"]); + $triggercssselector = ".search-widget[data-searchtype='{$haystack}']"; + + // Make sure that the dropdown menu is visible. + $node = $this->find("css_element", "{$triggercssselector} .dropdown-menu"); + if (!$node->isVisible()) { + $this->execute("behat_general::i_click_on", [$triggercssselector, "css_element"]); + } + + $this->execute("behat_general::wait_until_the_page_is_ready"); + $this->execute("behat_general::assert_element_not_contains_text", + [$needle, "{$triggercssselector} .dropdown-menu", "css_element"]); } /** * Clicks on an option from the specified search widget in the current gradebook page. * * Examples: - * - I click on "Student1" in the "user" search widget - * - I click on "Group1" in the "group" search widget + * - I click on "Student" in the "user" search widget + * - I click on "Group" in the "group" search widget + * - I click on "Grade item" in the "grade" search widget * * @Given /^I click on "(?P(?:[^"]|\\")*)" in the "(?P(?:[^"]|\\")*)" search widget$/ * @param string $needle The value to search for. @@ -466,26 +489,11 @@ class behat_grade extends behat_base { public function i_click_on_in_search_widget(string $needle, string $haystack) { $this->execute("behat_general::wait_until_the_page_is_ready"); - $triggercssselector = ''; - $dialoguetitle = ''; - - switch ($haystack) { - case 'user': - $triggercssselector = '.userwidget'; - $dialoguetitle = 'Select a user'; - break; - case 'grade': - $triggercssselector = '.gradewidget'; - $dialoguetitle = 'Select a grade item'; - break; - case 'group': - $triggercssselector = '.groupwidget'; - $dialoguetitle = 'Select a group'; - break; - } + $triggercssselector = ".search-widget[data-searchtype='{$haystack}']"; $this->execute("behat_general::i_click_on", [$triggercssselector, "css_element"]); - $this->execute("behat_general::wait_until_exists", [$dialoguetitle, "dialogue"]); - $this->execute('behat_general::i_click_on_in_the', [$needle, "link", $dialoguetitle, 'dialogue']); + $this->execute("behat_general::wait_until_the_page_is_ready"); + $this->execute('behat_general::i_click_on_in_the', + [$needle, "link", "{$triggercssselector} .dropdown-menu", "css_element"]); } } diff --git a/lib/amd/build/aria.min.js b/lib/amd/build/aria.min.js index 38718343f09..7565c92b927 100644 --- a/lib/amd/build/aria.min.js +++ b/lib/amd/build/aria.min.js @@ -1,3 +1,3 @@ -define("core/aria",["exports","./local/aria/aria-hidden","./local/aria/aria-combobox"],(function(_exports,_ariaHidden,_ariaCombobox){Object.defineProperty(_exports,"__esModule",{value:!0}),Object.defineProperty(_exports,"comboBox",{enumerable:!0,get:function(){return _ariaCombobox.comboBox}}),Object.defineProperty(_exports,"hide",{enumerable:!0,get:function(){return _ariaHidden.hide}}),Object.defineProperty(_exports,"hideSiblings",{enumerable:!0,get:function(){return _ariaHidden.hideSiblings}}),Object.defineProperty(_exports,"unhide",{enumerable:!0,get:function(){return _ariaHidden.unhide}}),Object.defineProperty(_exports,"unhideSiblings",{enumerable:!0,get:function(){return _ariaHidden.unhideSiblings}})})); +define("core/aria",["exports","./local/aria/aria-hidden"],(function(_exports,_ariaHidden){Object.defineProperty(_exports,"__esModule",{value:!0}),Object.defineProperty(_exports,"hide",{enumerable:!0,get:function(){return _ariaHidden.hide}}),Object.defineProperty(_exports,"hideSiblings",{enumerable:!0,get:function(){return _ariaHidden.hideSiblings}}),Object.defineProperty(_exports,"unhide",{enumerable:!0,get:function(){return _ariaHidden.unhide}}),Object.defineProperty(_exports,"unhideSiblings",{enumerable:!0,get:function(){return _ariaHidden.unhideSiblings}})})); //# sourceMappingURL=aria.min.js.map \ No newline at end of file diff --git a/lib/amd/build/local/aria/aria-combobox.min.js b/lib/amd/build/local/aria/aria-combobox.min.js deleted file mode 100644 index 278f1348f10..00000000000 --- a/lib/amd/build/local/aria/aria-combobox.min.js +++ /dev/null @@ -1,3 +0,0 @@ -define("core/local/aria/aria-combobox",["exports","core/key_codes"],(function(_exports,_key_codes){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.comboBox=void 0;_exports.comboBox=comboInput=>{registerEventListeners(comboInput)};const registerEventListeners=comboInput=>{document.addEventListener("keydown",(e=>{if(e.target===comboInput){let next=null;const comboResultArea=document.querySelector('[data-region="search-result-items-container"]'),resultRows=Array.from(comboResultArea.querySelectorAll('[role="row"]')),resultCells=Array.from(comboResultArea.querySelectorAll('[role="gridcell"]')),activeResultRow=comboResultArea.querySelector('.active[role="row"]'),activeResultCell=comboResultArea.querySelector('.focused-cell[role="gridcell"]');switch(e.keyCode){case _key_codes.arrowUp:if(null===activeResultRow)next=setFirstActiveRow(next,resultRows,comboInput,resultRows.length-1);else for(let i=0;i((next=resultRows[val]).setAttribute("aria-selected","true"),next.classList.add("active"),comboInput.setAttribute("aria-activedescendant",next.id),next.querySelector(".result-cell").classList.add("focused-cell"),next),nextHandler=(next,e,activeResultRow,comboInput)=>{next&&(e.preventDefault(),null!==activeResultRow&&(activeResultRow.classList.remove("active"),activeResultRow.querySelector(".result-cell").classList.remove("focused-cell")),next.classList.add("active"),next.querySelector(".result-cell").classList.add("focused-cell"),comboInput.setAttribute("aria-activedescendant",next.id))}})); - -//# sourceMappingURL=aria-combobox.min.js.map \ No newline at end of file diff --git a/lib/amd/build/local/aria/aria-combobox.min.js.map b/lib/amd/build/local/aria/aria-combobox.min.js.map deleted file mode 100644 index dbd42599c5d..00000000000 --- a/lib/amd/build/local/aria/aria-combobox.min.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"aria-combobox.min.js","sources":["../../../src/local/aria/aria-combobox.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\nimport {end, arrowLeft, arrowRight, arrowUp, arrowDown, home, enter, space} from 'core/key_codes';\n\n/**\n * ARIA helpers related to the combobox role.\n *\n * @module core/local/aria/aria-combobox.\n * @copyright 2022 Mathew May \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n/**\n * Our entry point into adding accessibility handling for comboboxes.\n *\n * @param {Element} comboInput The combobox area to add aria handling to.\n */\nexport const comboBox = (comboInput) => {\n registerEventListeners(comboInput);\n};\n\n/**\n * Event management of the provided combobox.\n *\n * @param {Element} comboInput The combobox area to add aria handling to.\n */\nconst registerEventListeners = (comboInput) => {\n document.addEventListener('keydown', (e) => {\n if (e.target === comboInput) {\n let next = null;\n const comboResultArea = document.querySelector('[data-region=\"search-result-items-container\"]');\n const resultRows = Array.from(comboResultArea.querySelectorAll('[role=\"row\"]'));\n const resultCells = Array.from(comboResultArea.querySelectorAll('[role=\"gridcell\"]'));\n const activeResultRow = comboResultArea.querySelector('.active[role=\"row\"]');\n const activeResultCell = comboResultArea.querySelector('.focused-cell[role=\"gridcell\"]');\n switch (e.keyCode) {\n case arrowUp: {\n // TODO: Handle the wrapping.\n if (activeResultRow === null) {\n next = setFirstActiveRow(next, resultRows, comboInput, resultRows.length - 1);\n } else {\n for (let i = 0; i < resultRows.length; i++) {\n if (resultRows[i].id === activeResultRow.id) {\n next = resultRows[i - 1];\n break;\n }\n }\n }\n break;\n }\n case arrowDown: {\n if (activeResultRow === null) {\n next = setFirstActiveRow(next, resultRows, comboInput, 0);\n } else {\n for (let i = 0; i < resultRows.length - 1; i++) {\n if (resultRows[i].id === activeResultRow.id) {\n next = resultRows[i + 1];\n break;\n }\n }\n }\n break;\n }\n case home: {\n next = resultRows[0];\n break;\n }\n case end: {\n next = resultRows[resultRows.length - 1];\n break;\n }\n case enter || space: {\n // Redirect the user to the appropriate link.\n // TODO: Space does not work, special handler on the cell itself?\n window.location = activeResultCell.href;\n break;\n }\n case arrowLeft: {\n if (activeResultRow === null) {\n next = setFirstActiveRow(next, resultRows, comboInput, 0);\n } else {\n for (let i = 0; i < resultCells.length; i++) {\n if (resultCells[i].id === activeResultCell.id) {\n if (resultCells[i - 1] === undefined) {\n resultCells[i].classList.remove('focused-cell');\n resultCells[resultCells.length - 1].classList.add('focused-cell');\n break;\n } else {\n resultCells[i].classList.remove('focused-cell');\n resultCells[i - 1].classList.add('focused-cell');\n break;\n }\n }\n }\n }\n break;\n }\n case arrowRight: {\n if (activeResultRow === null) {\n next = setFirstActiveRow(next, resultRows, comboInput, 0);\n } else {\n for (let i = 0; i < resultCells.length - 1; i++) {\n if (resultCells[i].id === activeResultCell.id) {\n resultCells[i].classList.remove('focused-cell');\n resultCells[i + 1].classList.add('focused-cell');\n break;\n }\n if (resultCells[i + 2] === undefined) {\n resultCells[i + 1].classList.remove('focused-cell');\n resultCells[0].classList.add('focused-cell');\n break;\n }\n }\n }\n break;\n }\n default: {\n window.console.log('nothing to see here!');\n break;\n }\n }\n // Variable next is set if we do want to act on the keypress.\n nextHandler(next, e, activeResultRow, comboInput);\n }\n });\n};\n\n/**\n * With search, we can't automatically set aria elements in the results field, so we do it here.\n *\n * @param {Element} next\n * @param {Array} resultRows\n * @param {Element} comboInput\n * @param {Number} val\n * @returns {Element}\n */\nconst setFirstActiveRow = (next, resultRows, comboInput, val) => {\n // Set first option as active.\n next = resultRows[val];\n next.setAttribute('aria-selected', 'true');\n next.classList.add('active');\n comboInput.setAttribute('aria-activedescendant', next.id);\n next.querySelector('.result-cell').classList.add('focused-cell');\n return next;\n};\n\n/**\n * Given we have a value to next set active, handle some of the basic handling.\n *\n * @param {Element} next\n * @param {Event} e\n * @param {Element} activeResultRow\n * @param {Element} comboInput\n */\nconst nextHandler = (next, e, activeResultRow, comboInput) => {\n if (next) {\n e.preventDefault();\n if (activeResultRow !== null) {\n activeResultRow.classList.remove('active');\n activeResultRow.querySelector('.result-cell').classList.remove('focused-cell');\n }\n next.classList.add('active');\n // Find whatever the first result cell is to add the class.\n next.querySelector('.result-cell').classList.add('focused-cell');\n comboInput.setAttribute('aria-activedescendant', next.id);\n }\n};\n"],"names":["comboInput","registerEventListeners","document","addEventListener","e","target","next","comboResultArea","querySelector","resultRows","Array","from","querySelectorAll","resultCells","activeResultRow","activeResultCell","keyCode","arrowUp","setFirstActiveRow","length","i","id","arrowDown","home","end","enter","space","window","location","href","arrowLeft","undefined","classList","remove","add","arrowRight","console","log","nextHandler","val","setAttribute","preventDefault"],"mappings":"sMA8ByBA,aACrBC,uBAAuBD,mBAQrBC,uBAA0BD,aAC5BE,SAASC,iBAAiB,WAAYC,OAC9BA,EAAEC,SAAWL,WAAY,KACrBM,KAAO,WACLC,gBAAkBL,SAASM,cAAc,iDACzCC,WAAaC,MAAMC,KAAKJ,gBAAgBK,iBAAiB,iBACzDC,YAAcH,MAAMC,KAAKJ,gBAAgBK,iBAAiB,sBAC1DE,gBAAkBP,gBAAgBC,cAAc,uBAChDO,iBAAmBR,gBAAgBC,cAAc,yCAC/CJ,EAAEY,cACDC,sBAEuB,OAApBH,gBACAR,KAAOY,kBAAkBZ,KAAMG,WAAYT,WAAYS,WAAWU,OAAS,YAEtE,IAAIC,EAAI,EAAGA,EAAIX,WAAWU,OAAQC,OAC/BX,WAAWW,GAAGC,KAAOP,gBAAgBO,GAAI,CACzCf,KAAOG,WAAWW,EAAI,oBAOjCE,wBACuB,OAApBR,gBACAR,KAAOY,kBAAkBZ,KAAMG,WAAYT,WAAY,YAElD,IAAIoB,EAAI,EAAGA,EAAIX,WAAWU,OAAS,EAAGC,OACnCX,WAAWW,GAAGC,KAAOP,gBAAgBO,GAAI,CACzCf,KAAOG,WAAWW,EAAI,oBAOjCG,gBACDjB,KAAOG,WAAW,cAGjBe,eACDlB,KAAOG,WAAWA,WAAWU,OAAS,cAGrCM,kBAASC,iBAGVC,OAAOC,SAAWb,iBAAiBc,gBAGlCC,wBACuB,OAApBhB,gBACAR,KAAOY,kBAAkBZ,KAAMG,WAAYT,WAAY,YAElD,IAAIoB,EAAI,EAAGA,EAAIP,YAAYM,OAAQC,OAChCP,YAAYO,GAAGC,KAAON,iBAAiBM,GAAI,SAChBU,IAAvBlB,YAAYO,EAAI,GAAkB,CAClCP,YAAYO,GAAGY,UAAUC,OAAO,gBAChCpB,YAAYA,YAAYM,OAAS,GAAGa,UAAUE,IAAI,sBAGlDrB,YAAYO,GAAGY,UAAUC,OAAO,gBAChCpB,YAAYO,EAAI,GAAGY,UAAUE,IAAI,iCAQhDC,yBACuB,OAApBrB,gBACAR,KAAOY,kBAAkBZ,KAAMG,WAAYT,WAAY,YAElD,IAAIoB,EAAI,EAAGA,EAAIP,YAAYM,OAAS,EAAGC,IAAK,IACzCP,YAAYO,GAAGC,KAAON,iBAAiBM,GAAI,CAC3CR,YAAYO,GAAGY,UAAUC,OAAO,gBAChCpB,YAAYO,EAAI,GAAGY,UAAUE,IAAI,8BAGVH,IAAvBlB,YAAYO,EAAI,GAAkB,CAClCP,YAAYO,EAAI,GAAGY,UAAUC,OAAO,gBACpCpB,YAAY,GAAGmB,UAAUE,IAAI,qCAQzCP,OAAOS,QAAQC,IAAI,wBAK3BC,YAAYhC,KAAMF,EAAGU,gBAAiBd,iBAc5CkB,kBAAoB,CAACZ,KAAMG,WAAYT,WAAYuC,QAErDjC,KAAOG,WAAW8B,MACbC,aAAa,gBAAiB,QACnClC,KAAK0B,UAAUE,IAAI,UACnBlC,WAAWwC,aAAa,wBAAyBlC,KAAKe,IACtDf,KAAKE,cAAc,gBAAgBwB,UAAUE,IAAI,gBAC1C5B,MAWLgC,YAAc,CAAChC,KAAMF,EAAGU,gBAAiBd,cACvCM,OACAF,EAAEqC,iBACsB,OAApB3B,kBACAA,gBAAgBkB,UAAUC,OAAO,UACjCnB,gBAAgBN,cAAc,gBAAgBwB,UAAUC,OAAO,iBAEnE3B,KAAK0B,UAAUE,IAAI,UAEnB5B,KAAKE,cAAc,gBAAgBwB,UAAUE,IAAI,gBACjDlC,WAAWwC,aAAa,wBAAyBlC,KAAKe"} \ No newline at end of file diff --git a/lib/amd/src/aria.js b/lib/amd/src/aria.js index d65b05b5145..baa0c1a0d45 100644 --- a/lib/amd/src/aria.js +++ b/lib/amd/src/aria.js @@ -27,6 +27,3 @@ export { hideSiblings, unhideSiblings, } from './local/aria/aria-hidden'; -export { - comboBox -} from './local/aria/aria-combobox'; diff --git a/lib/amd/src/local/aria/aria-combobox.js b/lib/amd/src/local/aria/aria-combobox.js deleted file mode 100644 index 82e23af72a8..00000000000 --- a/lib/amd/src/local/aria/aria-combobox.js +++ /dev/null @@ -1,180 +0,0 @@ -// This file is part of Moodle - http://moodle.org/ -// -// Moodle is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// Moodle is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with Moodle. If not, see . - -import {end, arrowLeft, arrowRight, arrowUp, arrowDown, home, enter, space} from 'core/key_codes'; - -/** - * ARIA helpers related to the combobox role. - * - * @module core/local/aria/aria-combobox. - * @copyright 2022 Mathew May - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - -/** - * Our entry point into adding accessibility handling for comboboxes. - * - * @param {Element} comboInput The combobox area to add aria handling to. - */ -export const comboBox = (comboInput) => { - registerEventListeners(comboInput); -}; - -/** - * Event management of the provided combobox. - * - * @param {Element} comboInput The combobox area to add aria handling to. - */ -const registerEventListeners = (comboInput) => { - document.addEventListener('keydown', (e) => { - if (e.target === comboInput) { - let next = null; - const comboResultArea = document.querySelector('[data-region="search-result-items-container"]'); - const resultRows = Array.from(comboResultArea.querySelectorAll('[role="row"]')); - const resultCells = Array.from(comboResultArea.querySelectorAll('[role="gridcell"]')); - const activeResultRow = comboResultArea.querySelector('.active[role="row"]'); - const activeResultCell = comboResultArea.querySelector('.focused-cell[role="gridcell"]'); - switch (e.keyCode) { - case arrowUp: { - // TODO: Handle the wrapping. - if (activeResultRow === null) { - next = setFirstActiveRow(next, resultRows, comboInput, resultRows.length - 1); - } else { - for (let i = 0; i < resultRows.length; i++) { - if (resultRows[i].id === activeResultRow.id) { - next = resultRows[i - 1]; - break; - } - } - } - break; - } - case arrowDown: { - if (activeResultRow === null) { - next = setFirstActiveRow(next, resultRows, comboInput, 0); - } else { - for (let i = 0; i < resultRows.length - 1; i++) { - if (resultRows[i].id === activeResultRow.id) { - next = resultRows[i + 1]; - break; - } - } - } - break; - } - case home: { - next = resultRows[0]; - break; - } - case end: { - next = resultRows[resultRows.length - 1]; - break; - } - case enter || space: { - // Redirect the user to the appropriate link. - // TODO: Space does not work, special handler on the cell itself? - window.location = activeResultCell.href; - break; - } - case arrowLeft: { - if (activeResultRow === null) { - next = setFirstActiveRow(next, resultRows, comboInput, 0); - } else { - for (let i = 0; i < resultCells.length; i++) { - if (resultCells[i].id === activeResultCell.id) { - if (resultCells[i - 1] === undefined) { - resultCells[i].classList.remove('focused-cell'); - resultCells[resultCells.length - 1].classList.add('focused-cell'); - break; - } else { - resultCells[i].classList.remove('focused-cell'); - resultCells[i - 1].classList.add('focused-cell'); - break; - } - } - } - } - break; - } - case arrowRight: { - if (activeResultRow === null) { - next = setFirstActiveRow(next, resultRows, comboInput, 0); - } else { - for (let i = 0; i < resultCells.length - 1; i++) { - if (resultCells[i].id === activeResultCell.id) { - resultCells[i].classList.remove('focused-cell'); - resultCells[i + 1].classList.add('focused-cell'); - break; - } - if (resultCells[i + 2] === undefined) { - resultCells[i + 1].classList.remove('focused-cell'); - resultCells[0].classList.add('focused-cell'); - break; - } - } - } - break; - } - default: { - window.console.log('nothing to see here!'); - break; - } - } - // Variable next is set if we do want to act on the keypress. - nextHandler(next, e, activeResultRow, comboInput); - } - }); -}; - -/** - * With search, we can't automatically set aria elements in the results field, so we do it here. - * - * @param {Element} next - * @param {Array} resultRows - * @param {Element} comboInput - * @param {Number} val - * @returns {Element} - */ -const setFirstActiveRow = (next, resultRows, comboInput, val) => { - // Set first option as active. - next = resultRows[val]; - next.setAttribute('aria-selected', 'true'); - next.classList.add('active'); - comboInput.setAttribute('aria-activedescendant', next.id); - next.querySelector('.result-cell').classList.add('focused-cell'); - return next; -}; - -/** - * Given we have a value to next set active, handle some of the basic handling. - * - * @param {Element} next - * @param {Event} e - * @param {Element} activeResultRow - * @param {Element} comboInput - */ -const nextHandler = (next, e, activeResultRow, comboInput) => { - if (next) { - e.preventDefault(); - if (activeResultRow !== null) { - activeResultRow.classList.remove('active'); - activeResultRow.querySelector('.result-cell').classList.remove('focused-cell'); - } - next.classList.add('active'); - // Find whatever the first result cell is to add the class. - next.querySelector('.result-cell').classList.add('focused-cell'); - comboInput.setAttribute('aria-activedescendant', next.id); - } -}; diff --git a/lib/templates/search_input_auto.mustache b/lib/templates/search_input_auto.mustache index 9dad3e20cc2..2d9e3fe2f82 100644 --- a/lib/templates/search_input_auto.mustache +++ b/lib/templates/search_input_auto.mustache @@ -43,6 +43,7 @@