Slots documentation improvements

- adds missing documentation to 'KIconButton' - fixes 'menu' slot documentation not being generated for 'KButton' - uses language consistent with other slots documentation
learningequality · Sep 6, 2022 · 3ab6d61 · 3ab6d61
1 parent 652a86c
commit 3ab6d61
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/lib/buttons-and-links/KButton.vue b/lib/buttons-and-links/KButton.vue
@@ -22,9 +22,9 @@
       data-test="iconBefore"
       class="prop-icon"
     />
+    <!-- @slot Pass sub-components into the button, typically `KDropdownMenu` -->
     <slot name="menu"></slot>
-    <!-- @slot Pass sub-components into the button, which provides more flexibility -->
-    <!-- @slot no longer takes prescendence over text. Both slot and text can now be used -->
+    <!-- @slot Slot alternative to the `text` prop -->
     <slot v-if="$slots.default"></slot>
 
     <template>

diff --git a/lib/buttons-and-links/KIconButton.vue b/lib/buttons-and-links/KIconButton.vue
@@ -21,6 +21,7 @@
     </UiTooltip>
     <!-- UiIconButton used flexbox - 7px is the magic centering number -->
     <KIcon :icon="icon" :color="color" :style="iconStyles" />
+    <!-- @slot Pass sub-components into the button, typically `KDropdownMenu` -->
     <slot name="menu"></slot>
   </KButton>