docs(Repo): documentation across a majority of the repo (#170)

* feat(Repo): base for documentation set * docs(Repo): documentation for multiple files across the repo * fix(Volume): merge conflict fixed * docs(Repo): more documentation across a few files Co-authored-by: Jason Panay <[email protected]> Co-authored-by: Jason Panay <[email protected]> Co-authored-by: Matt Wisniewski <[email protected]>
Satellite-im · Oct 12, 2021 · aaca63c · aaca63c
1 parent c61fae2
commit aaca63c
Show file tree

Hide file tree

Showing 86 changed files with 1,579 additions and 57 deletions.
diff --git a/components/interactables/Chip/Chip.vue b/components/interactables/Chip/Chip.vue
@@ -26,6 +26,10 @@ export default Vue.extend({
     }
   },
   methods: {
+    /**
+     * @method hide
+     * @description Hides chip element
+     */
     hide() {
       this.show = false
     },

diff --git a/components/interactables/ContextMenu/ContextMenu.vue b/components/interactables/ContextMenu/ContextMenu.vue
@@ -27,13 +27,29 @@ export default Vue.extend({
     ...mapState(['settings', 'ui']),
   },
   methods: {
+    /**
+     * @method close
+     * @description Closes context menu by setting toggleContextMenu in state to false
+     */
     close() {
       this.$store.commit('toggleContextMenu', false)
     },
+    /**
+     * @method handle
+     * @description Executes callback function and closes the ContextMenu component
+     * @param func Function to execute
+     * @example @click="handle(item.func)"
+     */
     handle(func: any) {
       func()
       this.close()
     },
+    /**
+     * @method handleOverflow
+     * @description Ensures contextMenu is positioned correctly by calculating if the div overflows the page and respositioning as needed.
+     * Corrects position by commiting an adjusted position to setContextMenuPosition in state
+     * @example
+     */
     handleOverflow() {
       const contextMenu = this.$refs.contextMenu as HTMLElement
       const position = this.ui.contextMenuPosition

diff --git a/components/interactables/Input/Input.vue b/components/interactables/Input/Input.vue
@@ -80,9 +80,17 @@ export default Vue.extend({
     }
   },
   methods: {
+    /**
+     * @method update
+     * @description Emits the update event with updated internalText string
+     */
     update() {
       this.$emit('update', this.internalText)
     },
+    /**
+     * @method clearSearch
+     * @description Sets internalText in data to an empty string
+     */
     clearSearch() {
       this.internalText = ''
     },

diff --git a/components/interactables/InputGroup/InputGroup.vue b/components/interactables/InputGroup/InputGroup.vue
@@ -117,6 +117,10 @@ export default Vue.extend({
     }
   },
   methods: {
+    /**
+     * @method update
+     * @description Emits the update event with updated internalText string
+     */
     update() {
       this.$emit('update', this.$data.internalText)
     },

diff --git a/components/interactables/QuickProfile/QuickProfile.vue b/components/interactables/QuickProfile/QuickProfile.vue
@@ -18,9 +18,18 @@ export default Vue.extend({
     ...mapState(['ui']),
   },
   methods: {
+    /**
+     * @method close
+     * @description Closes quickProfile by commiting quickProfile false to state
+     */
     close() {
       this.$store.commit('quickProfile', false)
     },
+    /**
+     * @method close
+     * @description Ensures quickProfile is positioned correctly by calculating if the div overflows the page and respositioning as needed.
+     * Corrects position by commiting an adjusted position to setQuickProfilePosition in state
+     */
     handleOverflow() {
       if (this.$device.isDesktop) {
         const quickProfile = this.$refs.quickProfile as HTMLElement