@dolanske/vui 0.3.3 → 0.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dolanske/vui",
   "type": "module",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "private": false,
   "description": "Brother in Christ there's a new UI library ",
   "author": "dolanske",

package/src/App.vue

@@ -1,124 +1,156 @@
 <script setup lang="ts">
 import { ref } from 'vue'
 import Avatar from './components/Avatar/Avatar.vue'
+import Button from './components/Button/Button.vue'
+
 import Divider from './components/Divider/Divider.vue'
+import Dropdown from './components/Dropdown/Dropdown.vue'
+import DropdownItem from './components/Dropdown/DropdownItem.vue'
 import Flex from './components/Flex/Flex.vue'
+import Sidebar from './components/Sidebar/Sidebar.vue'
 import Tab from './components/Tabs/Tab.vue'
-
 import Tabs from './components/Tabs/Tabs.vue'
+
 import Tooltip from './components/Tooltip/Tooltip.vue'
 
 const tab = ref('components')
+const sidebarOpen = ref(false)
 </script>
 
 <template>
-  <main vaul-drawer-wrapper>
-    <Tabs v-model="tab" expand>
-      <Tab id="home" label="Home" icon="ph:house" />
-      <Tab id="components" label="Components" />
-      <Tab id="typography" label="Typography" />
-    </Tabs>
-    <div style="margin-bottom: 64px;" />
-    <div v-if="tab === 'home'">
-      home
-    </div>
+  <div class="vui-sidebar-layout">
+    <Sidebar v-model="sidebarOpen" appear floaty>
+      <template #header>
+        <img class="p-xs" style="background:white;border-radius: 16px;width:40px" src="https://dolansky.dev/backgrounds/star.svg" alt="">
+      </template>
+      <DropdownItem icon="ph:house">
+        Home
+      </DropdownItem>
+      <DropdownItem icon="ph:signpost">
+        Routing
+      </DropdownItem>
+      <template #footer>
+        <Button size="l" expand>
+          Sign out
+        </Button>
+      </template>
+    </Sidebar>
+
+    <main vaul-drawer-wrapper>
+      <Button icon="ph:sidebar-simple-bold" square @click="sidebarOpen = !sidebarOpen" />
+      <Tabs v-model="tab" expand>
+        <Tab id="home" label="Home" icon="ph:house" />
+        <Tab id="components" label="Components" />
+        <Tab id="typography" label="Typography" />
+      </Tabs>
+      <div style="margin-bottom: 64px;" />
+      <div v-if="tab === 'home'">
+        home
+      </div>
+
+      <div v-if="tab === 'components'">
+        <h1 class="mb-xl">
+          Hii
+          <span class="counter text-color-accent">129</span>
+        </h1>
+        <p>I am down</p>
 
-    <div v-if="tab === 'components'">
-      <h1 class="mb-xl">
-        Hii
-        <span class="counter text-color-accent">129</span>
-      </h1>
-      <p>I am down</p>
+        <Flex>
+          <Avatar size="s" />
+          <Avatar size="m" />
+          <Avatar size="l" />
+          <Avatar :size="80" />
+        </Flex>
 
-      <Flex>
-        <Avatar size="s" />
-        <Avatar size="m" />
-        <Avatar size="l" />
-        <Avatar :size="128" />
-      </Flex>
+        <Divider />
 
-      <Divider />
+        <Tooltip>
+          <span class="block mb-xl">Hello world</span>
+          <template #tooltip>
+            <p>
+              Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro, animi! Nobis maxime neque cumque, in a amet voluptatibus tenetur dicta eos delectus illo soluta aliquam voluptatum nulla? In, incidunt asperiores?
+            </p>
+          </template>
+        </Tooltip>
 
-      <Tooltip>
-        <span cl>Hello world</span>
-        <template #tooltip>
-          <p>
-            Lorem ipsum dolor sit amet consectetur adipisicing elit. Porro, animi! Nobis maxime neque cumque, in a amet voluptatibus tenetur dicta eos delectus illo soluta aliquam voluptatum nulla? In, incidunt asperiores?
-          </p>
-        </template>
-      </Tooltip>
-    </div>
-    <div v-else-if="tab === 'typography'" class="typeset" :style="{ maxWidth: '688px', margin: 'auto' }">
-      <h1>The Joke Tax Chronicles</h1>
-      <p>Once upon a time, in a far-off land, there <code>was a very lazy</code> king who spent all day lounging on his throne. One day, his advisors came to him with a problem: the kingdom was running out of money</p>
-      <h2>The King's Plan</h2>
-      <p>The king thought long and hard, and finally came up with <a href="#">a brilliant plan</a>: he would tax the jokes in the kingdom.</p>
-      <blockquote>"After all," he said, "everyone enjoys a good joke, so it's only fair that they should pay for the privilege."</blockquote>
-      <h3>The Joke Tax</h3>
-      <p>The king's subjects were not amused. They grumbled and complained, but the king was firm:</p>
-      <ul class="ul">
-        <li>
-          I am an item
-          <ul>
-            <li>1st level of puns: 5 gold coins</li>
-            <li>2nd level of jokes: 10 gold coins</li>
-            <li>
-              3rd level of one-liners : 20 gold coins
-              <ul>
-                <li>1st level of puns: 5 gold coins</li>
-                <li>2nd level of jokes: 10 gold coins</li>
-                <li>3rd level of one-liners : 20 gold coins</li>
-              </ul>
-            </li>
-          </ul>
-        </li>
-        <li>2nd level of jokes: 10 gold coins</li>
-        <li>3rd level of one-liners : 20 gold coins</li>
-      </ul>
-      <p>As a result, people stopped telling jokes, and the kingdom fell into a gloom. But there was one person who refused to let the king's foolishness get him down: a court jester named Jokester.</p>
+        <Dropdown>
+          <template #trigger="{ toggle }">
+            <Button aria-label="Dropdown menu trigger" square icon="ph:x" @click="toggle" />
+          </template>
+          <DropdownItem>Hiiii</DropdownItem>
+        </Dropdown>
+      </div>
+      <div v-else-if="tab === 'typography'" class="typeset" :style="{ maxWidth: '688px', margin: 'auto' }">
+        <h1>The Joke Tax Chronicles</h1>
+        <p>Once upon a time, in a far-off land, there <code>was a very lazy</code> king who spent all day lounging on his throne. One day, his advisors came to him with a problem: the kingdom was running out of money</p>
+        <h2>The King's Plan</h2>
+        <p>The king thought long and hard, and finally came up with <a href="#">a brilliant plan</a>: he would tax the jokes in the kingdom.</p>
+        <blockquote>"After all," he said, "everyone enjoys a good joke, so it's only fair that they should pay for the privilege."</blockquote>
+        <h3>The Joke Tax</h3>
+        <p>The king's subjects were not amused. They grumbled and complained, but the king was firm:</p>
+        <ul class="ul">
+          <li>
+            I am an item
+            <ul>
+              <li>1st level of puns: 5 gold coins</li>
+              <li>2nd level of jokes: 10 gold coins</li>
+              <li>
+                3rd level of one-liners : 20 gold coins
+                <ul>
+                  <li>1st level of puns: 5 gold coins</li>
+                  <li>2nd level of jokes: 10 gold coins</li>
+                  <li>3rd level of one-liners : 20 gold coins</li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>2nd level of jokes: 10 gold coins</li>
+          <li>3rd level of one-liners : 20 gold coins</li>
+        </ul>
+        <p>As a result, people stopped telling jokes, and the kingdom fell into a gloom. But there was one person who refused to let the king's foolishness get him down: a court jester named Jokester.</p>
 
-      <figure>
-        <img src="https://i.imgur.com/6WQYrfN.jpeg" alt="">
-        <figcaption>Woah look at these mountains</figcaption>
-      </figure>
+        <figure>
+          <img src="https://i.imgur.com/6WQYrfN.jpeg" alt="">
+          <figcaption>Woah look at these mountains</figcaption>
+        </figure>
 
-      <h3>Jokester's Revolt</h3>
-      <p>Jokester began sneaking into the castle in the middle of the night and leaving jokes all over the place: under the king's pillow, in his soup, even in the royal toilet. The king was furious, but he couldn't seem to stop Jokester.</p>
-      <hr>
-      <p>And then, one day, the people of the kingdom discovered that the jokes left by Jokester were so funny that they couldn't help but laugh. And once they started laughing, they couldn't stop.</p>
-      <ol>
-        <li>But the kind was stupid</li>
-        <li>He was ratioed 5 times</li>
-      </ol>
-      <h3>The People's Rebellion</h3>
-      <p>The people of the kingdom, feeling uplifted by the laughter, started to tell jokes and puns again, and soon the entire kingdom was in on the joke.</p>
+        <h3>Jokester's Revolt</h3>
+        <p>Jokester began sneaking into the castle in the middle of the night and leaving jokes all over the place: under the king's pillow, in his soup, even in the royal toilet. The king was furious, but he couldn't seem to stop Jokester.</p>
+        <hr>
+        <p>And then, one day, the people of the kingdom discovered that the jokes left by Jokester were so funny that they couldn't help but laugh. And once they started laughing, they couldn't stop.</p>
+        <ol>
+          <li>But the kind was stupid</li>
+          <li>He was ratioed 5 times</li>
+        </ol>
+        <h3>The People's Rebellion</h3>
+        <p>The people of the kingdom, feeling uplifted by the laughter, started to tell jokes and puns again, and soon the entire kingdom was in on the joke.</p>
 
-      <table>
-        <thead>
-          <tr>
-            <th>King's Treasury</th>
-            <th>People's happiness</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <td>Empty</td>
-            <td>And then, one day, the people of the kingdom discovered that the jokes left by Jokester were so funny that they couldn't help but laugh. And once they started laughing, they couldn't stop.</td>
-          </tr>
-          <tr>
-            <td>Modest</td>
-            <td>Satisfied</td>
-          </tr>
-          <tr>
-            <td>Full</td>
-            <td>Ecstatic</td>
-          </tr>
-        </tbody>
-      </table>
-      <p>The king, seeing how much happier his subjects were, realized the error of his ways and repealed the joke tax. Jokester was declared a hero, and the kingdom lived happily ever after.</p>
-      <p>The moral of the story is: never <code>underestimate</code> the power of a good laugh and always be careful of bad ideas.</p>
+        <table>
+          <thead>
+            <tr>
+              <th>King's Treasury</th>
+              <th>People's happiness</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td>Empty</td>
+              <td>And then, one day, the people of the kingdom discovered that the jokes left by Jokester were so funny that they couldn't help but laugh. And once they started laughing, they couldn't stop.</td>
+            </tr>
+            <tr>
+              <td>Modest</td>
+              <td>Satisfied</td>
+            </tr>
+            <tr>
+              <td>Full</td>
+              <td>Ecstatic</td>
+            </tr>
+          </tbody>
+        </table>
+        <p>The king, seeing how much happier his subjects were, realized the error of his ways and repealed the joke tax. Jokester was declared a hero, and the kingdom lived happily ever after.</p>
+        <p>The moral of the story is: never <code>underestimate</code> the power of a good laugh and always be careful of bad ideas.</p>
 
-      <pre data-lang="JSON">
+        <pre data-lang="JSON">
 {
   "type": "Feature",
   "properties": {
@@ -160,6 +192,7 @@ const tab = ref('components')
   "id": "ak022eit4nup"
 },
       </pre>
-    </div>
-  </main>
+      </div>
+    </main>
+  </div>
 </template>

package/src/components/Avatar/Avatar.vue

@@ -11,12 +11,14 @@ interface Props {
   url?: string
   fallback?: string
   icon?: string
+  alt?: string
 }
 
 const {
   size = Size.m,
   url,
   fallback,
+  alt = 'avatar',
 } = defineProps<Props>()
 
 const showFallback = ref(false)
@@ -32,7 +34,12 @@ const showFallback = ref(false)
       }),
     }"
   >
-    <img v-if="url && !showFallback" :src="url" @error="showFallback = true">
+    <img
+      v-if="url && !showFallback"
+      :alt
+      :src="url"
+      @error="showFallback = true"
+    >
     <strong v-else>
       <template v-if="showFallback">
         {{ fallback }}

package/src/components/Dropdown/Dropdown.vue

@@ -73,13 +73,10 @@ const w = computed(() => expand ? `${anchorWidth.value}px` : 'initial')
   <div
     ref="anchor"
     class="vui-dropdown-trigger-wrap"
-    :style="{
-      minWidth: mW,
-      width: w,
-    }"
     role="button"
     :aria-expanded="showMenu"
     :aria-haspopup="true"
+    name="Dropdown menu"
   >
     <slot name="trigger" :open :is-open="showMenu" :close :toggle />
   </div>
@@ -91,6 +88,10 @@ const w = computed(() => expand ? `${anchorWidth.value}px` : 'initial')
       :anchor="anchorRef"
       class="vui-dropdown"
       :placement
+      :style="{
+        minWidth: mW,
+        width: w,
+      }"
     >
       <slot :open :close :toggle :is-open="showMenu" />
     </Popout>

package/src/components/Dropdown/DropdownItem.vue

@@ -4,6 +4,7 @@ import { Icon } from '@iconify/vue'
 interface Props {
   disabled?: boolean
   icon?: string
+  iconEnd?: string
 }
 
 const props = defineProps<Props>()
@@ -13,9 +14,7 @@ const props = defineProps<Props>()
   <button class="vui-dropdown-item" :class="{ disabled }">
     <!-- This should always be here to offset items which dont have icons -->
     <div class="vui-dropdown-item-icon">
-      <Transition name="fade" appear>
-        <Icon v-if="props.icon" :icon="props.icon" />
-      </Transition>
+      <Icon v-if="props.icon" :icon="props.icon" />
     </div>
 
     <div class="vui-dropdown-item-slot">
@@ -25,5 +24,9 @@ const props = defineProps<Props>()
     <div class="vui-dropdown-item-hint">
       <slot name="hint" />
     </div>
+
+    <div v-if="props.iconEnd" class="vui-dropdown-item-icon">
+      <Icon :icon="props.iconEnd" />
+    </div>
   </button>
 </template>

package/src/components/Dropdown/dropdown.scss

@@ -1,5 +1,6 @@
 .vui-dropdown-trigger-wrap {
-  display: inline-block;
+  // display: inline-block;
+  width: fit-content;
 }
 
 .vui-dropdown {
@@ -16,6 +17,7 @@
   width: fit-content;
   gap: var(--space-xs);
   width: 100%;
+  // TODO: make button-height variable global and use it here and everywhere else
   height: 34px;
   border-radius: var(--border-radius-m);
   font-size: var(--font-size-s);

package/src/components/Flex/Flex.vue

@@ -1,6 +1,7 @@
 <script setup lang="ts">
 import type { Space } from '../../shared/types'
 import { computed } from 'vue'
+import { formatUnitValue } from '../../shared/helpers'
 
 export interface FlexProps {
   inline?: boolean
@@ -34,7 +35,10 @@ export interface FlexProps {
 const props = defineProps<FlexProps>()
 
 // Flex gap
-const ag = computed(() => `var(--space-${props.gap})`)
+const ag = computed(() => typeof props.gap === 'number'
+  ? formatUnitValue(props.gap)
+  : `var(--space-${props.gap})`,
+)
 
 // Flex direction
 const ad = computed(() => {

package/src/components/Grid/Grid.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import type { Space } from '../../shared/types'
 import { computed } from 'vue'
-import { createArray } from '../../shared/helpers'
+import { createArray, formatUnitValue } from '../../shared/helpers'
 
 /**
  * This component is not meant for complex grids
@@ -17,7 +17,10 @@ interface Props {
 
 const props = defineProps<Props>()
 
-const ag = computed(() => `var(--space-${props.gap})`)
+const ag = computed(() => typeof props.gap === 'number'
+  ? formatUnitValue(props.gap)
+  : `var(--space-${props.gap})`,
+)
 
 const aTC = computed(() => {
   if (typeof props.columns === 'number') {

package/src/components/Popout/Popout.vue

@@ -1,6 +1,6 @@
 <script setup lang='ts'>
 import type { Placement, PopoutMaybeElement } from '../../shared/types'
-import { autoPlacement, offset, useFloating } from '@floating-ui/vue'
+import { autoPlacement, offset, shift, useFloating } from '@floating-ui/vue'
 import { toRef, useTemplateRef } from 'vue'
 import './popout.scss'
 
@@ -28,6 +28,9 @@ const { floatingStyles } = useFloating(anchorRef, popoutRef, {
   middleware: [
     ...(props.placement ? [] : [autoPlacement()]),
     offset(props.offset),
+    shift({
+      padding: 8,
+    }),
   ],
 })
 </script>

package/src/components/Sidebar/Sidebar.vue

@@ -0,0 +1,85 @@
+<script setup lang='ts'>
+import { useCssVar, useMouse } from '@vueuse/core'
+import { computed, useSlots, useTemplateRef, watch } from 'vue'
+import './sidebar.scss'
+
+const props = withDefaults(defineProps<Props>(), {
+  width: 224,
+  mini: false,
+})
+
+interface Props {
+  width?: number
+  /**
+   * Controls wether the sidebar is displayed in full size, or a small version
+   */
+  mini?: boolean
+  /**
+   * Allow sidebar showing up, when user hovers at very left of the screen. The
+   * sidebar will apear over content, not pushing anything over
+   */
+  appear?: boolean
+  /**
+   * Add edges of background around sidebar
+   */
+  floaty?: boolean
+}
+
+const sidebar = useTemplateRef('sidebar')
+const open = defineModel<boolean>()
+const slots = useSlots()
+const offset = useCssVar('--vui-sidebar-float-offset', sidebar, {
+  initialValue: '8px',
+})
+
+const width = computed(() => {
+  if (props.mini)
+    return `65px`
+  if (!props.floaty)
+    return `${props.width}px`
+  return `calc(${props.width}px - ${offset.value})`
+})
+
+const slotProps = computed(() => ({
+  mini: props.mini,
+  floaty: props.floaty,
+  width: props.width,
+  open,
+}))
+
+const { x } = useMouse()
+
+let appearActive = true
+watch(x, (pos) => {
+  if (!props.appear)
+    return
+
+  if (pos < 20 && !open.value) {
+    open.value = true
+    appearActive = true
+  }
+  else if (appearActive && pos > props.width) {
+    open.value = false
+    appearActive = false
+  }
+})
+</script>
+
+<template>
+  <div class="vui-sidebar-outer" :style="{ width }" :class="{ open }">
+    <aside ref="sidebar" class="vui-sidebar" :class="{ open, floaty: props.floaty, mini: props.mini }" :style="{ width: `${props.mini ? 65 : props.width}px` }">
+      <div v-if="slots.header" class="vui-sidebar-header">
+        <slot name="header" v-bind="slotProps" />
+      </div>
+      <div class="vui-sidebar-content">
+        <div class="vui-sidebar-content-wrap">
+          <slot v-bind="slotProps" />
+        </div>
+      </div>
+
+      <div v-if="slots.footer" class="vui-sidebar-footer">
+        <slot name="footer" v-bind="slotProps" />
+      </div>
+    </aside>
+  </div>
+</template>

package/src/components/Sidebar/sidebar.scss

@@ -0,0 +1,123 @@
+// TODO: flesh out better
+.vui-sidebar-layout {
+  display: flex;
+  flex-wrap: nowrap;
+  gap: 32px;
+  position: relative;
+
+  main {
+    flex: 1;
+    padding: 2rem;
+  }
+
+  .vui-sidebar-outer {
+    transition: var(--transition-slow);
+
+    &:not(.open) {
+      width: 0px !important;
+    }
+  }
+}
+
+.vui-sidebar {
+  --vui-sidebar-float-offset: 8px;
+  display: flex;
+  flex-direction: column;
+  gap: var(--space-sm);
+  height: 100vh;
+  width: 224px;
+  position: fixed;
+  top: 0;
+  z-index: 50;
+  background-color: var(--color-bg);
+  border-right: 1px solid var(--color-border);
+  transition: var(--transition-slow);
+  transform: translateX(-100%);
+  will-change: transform;
+
+  &.open {
+    transform: translateX(0);
+
+    &.floaty {
+      transform: translateX(0);
+    }
+  }
+
+  &.floaty {
+    top: var(--vui-sidebar-float-offset);
+    left: var(--vui-sidebar-float-offset);
+    bottom: var(--vui-sidebar-float-offset);
+    height: calc(100vh - calc(var(--vui-sidebar-float-offset) * 2));
+    border-radius: var(--border-radius-m);
+    border: 1px solid var(--color-border);
+    transform: translateX(calc(-100% - calc(var(--vui-sidebar-float-offset) * 2)));
+    box-shadow: var(--box-shadow);
+  }
+
+  .vui-sidebar-header,
+  .vui-sidebar-footer,
+  .vui-sidebar-content .vui-sidebar-content-wrap {
+    padding: var(--space-s);
+  }
+
+  .vui-sidebar-header:not(:only-child) {
+    padding-bottom: 0;
+  }
+
+  .vui-sidebar-footer:not(:only-child) {
+    padding-top: 0;
+  }
+
+  .vui-sidebar-content {
+    flex: 1;
+    position: relative;
+
+    .vui-sidebar-content-wrap {
+      position: absolute;
+      inset: 0;
+      overflow-y: auto;
+    }
+  }
+
+  // Note: elements in sidebar (& mini) should have a slight modification
+
+  // Accordion
+  // Does not have a border under content
+  .vui-accordion {
+    border-bottom: 0;
+  }
+
+  // DropdownItems (sidebar items
+  // Should have a bit less spacing between slots
+  .vui-dropdown-item {
+    padding-inline: var(--space-xs);
+  }
+
+  &.mini {
+    .vui-dropdown-item .vui-dropdown-item-icon {
+      width: 20px;
+      height: 20px;
+    }
+
+    .vui-dropdown-item,
+    .vui-button {
+      --button-height: 40px;
+      width: var(--button-height) !important;
+      height: var(--button-height) !important;
+      justify-content: center;
+      align-items: center;
+
+      svg {
+        width: 20px;
+        height: 20px;
+      }
+
+      .vui-dropdown-item-slot,
+      .vui-dropdown-item-hint,
+      .vui-button-slot-end,
+      .vui-button-slot-start {
+        display: none;
+      }
+    }
+  }
+}

package/src/components/Tabs/Tabs.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import type { TabProps } from './Tab.vue'
-import { useEventListener } from '@vueuse/core'
+import { useResizeObserver } from '@vueuse/core'
 import { onMounted, useTemplateRef, type VNode, watch } from 'vue'
 import './tabs.scss'
 
@@ -42,7 +42,7 @@ function computeUnderlinePosition() {
 }
 
 onMounted(() => {
-  useEventListener(window, 'resize', computeUnderlinePosition)
+  useResizeObserver(tabsRef, computeUnderlinePosition)
 
   watch(
     [active, () => expand],