From 1d3a18128db82dd33e9910b06e4e7982781496f1 Mon Sep 17 00:00:00 2001 From: Eduardo Morales Date: Fri, 26 Jan 2024 09:10:12 -0600 Subject: [PATCH] enh: added comments on NcHeaderMenu for NcVue documentation Signed-off-by: Eduardo Morales --- .../NcAppNavigationToggle/NcAppNavigationToggle.vue | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/components/NcAppNavigationToggle/NcAppNavigationToggle.vue b/src/components/NcAppNavigationToggle/NcAppNavigationToggle.vue index e9b8b0c370..d87eccc964 100644 --- a/src/components/NcAppNavigationToggle/NcAppNavigationToggle.vue +++ b/src/components/NcAppNavigationToggle/NcAppNavigationToggle.vue @@ -55,6 +55,11 @@ export default { }, props: { + /** + * Tracks whether the toggle has been clicked or not. + * If it has been clicked, switches between the different MenuIcons + * and emits a boolean indicating its opened status + */ open: { type: Boolean, required: true, @@ -69,6 +74,10 @@ export default { }, }, methods: { + /** + * Once the toggle has been clicked, emits the toggle status + * so parent components can gauge the status of the navigation button + */ toggleNavigation() { this.$emit('update:open', !this.open) },