Added JSDoc for src/components/*

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
This commit is contained in:
Matthew Nickson 2022-06-02 00:32:05 +01:00
parent d939d03690
commit 2b42c3c828
No known key found for this signature in database
GPG key ID: BF229DCFD4748E05
20 changed files with 152 additions and 3 deletions

View file

@ -58,6 +58,7 @@ export default {
Tag,
},
props: {
/** Should the scrollbar be shown */
scrollbar: {
type: Boolean,
},
@ -124,6 +125,7 @@ export default {
window.removeEventListener("scroll", this.onScroll);
},
methods: {
/** Called when the user scrolls */
onScroll() {
if (window.top.scrollY <= 133) {
this.windowTop = window.top.scrollY;
@ -131,9 +133,15 @@ export default {
this.windowTop = 133;
}
},
/**
* Get URL of monitor
* @param {number} id ID of monitor
* @returns {string} Relative URL of monitor
*/
monitorURL(id) {
return getMonitorRelativeURL(id);
},
/** Clear the search bar */
clearSearchText() {
this.searchText = "";
}