@dolanske/vui 0.1.0 → 0.1.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dolanske/vui",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": false,
   "description": "Brother in Christ there's a new UI library ",
   "author": "dolanske",
@@ -11,26 +11,28 @@
     "type": "git",
     "url": "https://github.com/dolanske/vui.git"
   },
+  "keywords": ["vue", "vue3", "component"],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/vui.js"
     },
-    "./dist/style.css": {
+    "./style": {
       "import": "./dist/style.css",
       "require": "./dist/style.css",
       "default": "./dist/style.css"
     }
   },
-  "main": "dist/vuicjs",
-  "module": "dist/vui.js",
-  "browser": "dist/vui.js",
-  "unpkg": "dist/vui.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/vuicjs",
+  "module": "./dist/vui.js",
+  "browser": "./dist/vui.js",
+  "unpkg": "./dist/vui.js",
+  "types": "./dist/index.d.ts",
   "files": [
+    "./dist/*",
+    "./src/*",
     "LICENSE",
-    "README.md",
-    "dist/*"
+    "README.md"
   ],
   "scripts": {
     "dev": "vite",

package/src/App.vue

@@ -0,0 +1,162 @@
+<script setup lang="ts">
+import { ref } from 'vue'
+import Accordion from './components/Accordion/Accordion.vue'
+import Button from './components/Button/Button.vue'
+import Flex from './components/Flex/Flex.vue'
+import Input from './components/Input/Input.vue'
+import Tab from './components/Tabs/Tab.vue'
+import Tabs from './components/Tabs/Tabs.vue'
+
+const tab = ref('components')
+const value = ref('')
+</script>
+
+<template>
+  <main vaul-drawer-wrapper>
+    <Tabs v-model="tab" expand variant="filled">
+      <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'">
+      <Flex>
+        <Button variant="success">
+          Hello
+        </Button>
+        <Button variant="success" plain>
+          Hello
+        </Button>
+        <Button variant="success" active>
+          Hello
+        </Button>
+
+        {{ value }}
+
+        <Button variant="success" disabled>
+          Hello
+        </Button>
+      </Flex>
+
+      <Accordion label="Hi">
+        <Input v-model="value" />
+      </Accordion>
+    </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>
+
+      <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>
+
+      <pre data-lang="JSON">
+{
+  "type": "Feature",
+  "properties": {
+    "mag": 1.5,
+    "place": "77kmNWofSkwentna,Alaska",
+    "time": 1668256022741,
+    "updated": 1668256203692,
+    "tz": null,
+    "url": "https://earthquake.usgs.gov/earthquakes/eventpage/ak022eit4nup",
+    "detail": "https://earthquake.usgs.gov/earthquakes/feed/v1.0/detail/ak022eit4nup.geojson",
+    "felt": null,
+    "cdi": null,
+    "mmi": null,
+    "alert": null,
+    "status": "automatic",
+    "tsunami": 0,
+    "sig": 35,
+    "net": "ak",
+    "code": "022eit4nup",
+    "ids": ",ak022eit4nup,",
+    "sources": ",ak,",
+    "types": ",origin,phase-data,",
+    "nst": null,
+    "dmin": null,
+    "rms": 0.55,
+    "gap": null,
+    "magType": "ml",
+    "type": "earthquake",
+    "title": "M1.5-77kmNWofSkwentna,Alaska"
+  },
+  "geometry": {
+    "type": "Point",
+    "coordinates": [
+      -152.2722,
+      62.5489,
+      4.5
+    ]
+  },
+  "id": "ak022eit4nup"
+},
+      </pre>
+    </div>
+  </main>
+</template>

package/src/components/Accordion/Accordion.vue

@@ -0,0 +1,75 @@
+<script setup lang="ts">
+import { Icon } from '@iconify/vue'
+import { ref, useTemplateRef, watch, watchEffect } from 'vue'
+import './accordion.scss'
+
+export interface AccordionProps {
+  open?: boolean
+  label?: string
+}
+
+const props = defineProps<AccordionProps>()
+const emits = defineEmits<{
+  open: []
+  close: []
+}>()
+
+const isOpen = ref(false)
+const contentRef = useTemplateRef('content')
+const contentMaxHeight = ref(0)
+
+watchEffect(() => {
+  isOpen.value = props.open
+}, {
+  flush: 'post',
+})
+
+watch(isOpen, (value) => {
+  if (value) {
+    emits('open')
+    contentMaxHeight.value = contentRef.value?.scrollHeight || 0
+  }
+  else {
+    emits('close')
+  }
+}, {
+  flush: 'post',
+  immediate: true,
+})
+
+function open() {
+  isOpen.value = true
+}
+
+function close() {
+  isOpen.value = false
+}
+
+function toggle() {
+  isOpen.value = !isOpen.value
+}
+
+defineExpose({
+  open,
+  close,
+  toggle,
+  isOpen,
+})
+</script>
+
+<template>
+  <div class="vui-accordion" :class="{ open: isOpen }">
+    <!-- Completely custom header which needs to be styled and implemented by the developer -->
+    <slot v-if="$slots.trigger" name="trigger" :open :close :toggle :is-open />
+    <button v-else class="vui-accordion-header" @click="isOpen = !isOpen">
+      <slot name="header">
+        {{ props.label }}
+      </slot>
+      <Icon icon="ph:caret-down" />
+    </button>
+
+    <div ref="content" class="vui-accordion-content" :style="{ 'max-height': isOpen ? `${contentMaxHeight}px` : '0px' }">
+      <slot />
+    </div>
+  </div>
+</template>

package/src/components/Accordion/AccordionGroup.vue

@@ -0,0 +1,43 @@
+<script setup lang="ts">
+import type { VNode } from 'vue'
+import type { AccordionProps } from './Accordion.vue'
+import type Accordion from './Accordion.vue'
+import { useTemplateRef } from 'vue'
+// Renderless component which is used to house multiple accordions which can be triggered together in some way
+
+interface Props {
+  /**
+   * If set to true, if an accordion opens, all other close
+   */
+  single?: boolean
+}
+
+const props = defineProps<Props>()
+
+const slots = defineSlots<{
+  default: () => Array<VNode & { props: AccordionProps }>
+}>()
+
+const accordionRefs = useTemplateRef<InstanceType<typeof Accordion>[]>('accordion')
+
+function handleAccordionOpen(newIndex: number) {
+  if (!accordionRefs.value || !props.single)
+    return
+
+  accordionRefs.value.forEach((item, index) => {
+    if (index !== newIndex) {
+      item.close()
+    }
+  })
+}
+</script>
+
+<template>
+  <component
+    :is="item"
+    v-for="(item, index) of slots.default()"
+    ref="accordion"
+    :key="item"
+    @open="handleAccordionOpen(index)"
+  />
+</template>

package/src/components/Accordion/accordion.scss

@@ -0,0 +1,44 @@
+.vui-accordion {
+  width: 100%;
+  transition: var(--transition);
+  border-bottom: 1px solid var(--color-border);
+  padding-bottom: 0;
+
+  &.open {
+    padding-bottom: var(--space-m);
+
+    .vui-accordion-header svg {
+      transform: rotate(180deg);
+    }
+  }
+
+  .vui-accordion-header {
+    display: flex;
+    width: 100%;
+    justify-content: space-between;
+    align-items: center;
+    padding: var(--space-m) 0;
+    color: pointer;
+    font-size: var(--font-size-m);
+    font-weight: 500;
+    color: var(--color-text);
+
+    &:hover {
+      text-decoration: underline;
+      text-underline-offset: 4px;
+    }
+
+    svg {
+      transition: var(--transition);
+    }
+
+    // padding-bottom: var(--w);
+  }
+
+  .vui-accordion-content {
+    transition: var(--transition-slow);
+    width: 100%;
+    max-height: 0;
+    overflow: hidden;
+  }
+}

package/src/components/Alert/Alert.vue

@@ -0,0 +1,53 @@
+<script setup lang="ts">
+import { Icon } from '@iconify/vue'
+import { computed } from 'vue'
+import './alert.scss'
+
+interface Props {
+  variant?: 'neutral' | 'info' | 'success' | 'warning' | 'danger'
+  /**
+   * Override the variant's default icon
+   */
+  icon?: string
+
+  /**
+   * Setting a title and description will use slightly different styling other than slots.
+   */
+  title?: string
+  description?: string
+}
+
+const {
+  icon = 'ph:circle-light',
+  variant = 'neutral',
+  title,
+  description,
+} = defineProps<Props>()
+
+const actualIcon = computed(() => {
+  switch (variant) {
+    case 'info': return 'ph:info'
+    case 'success': return 'ph:check-circle'
+    case 'warning': return 'ph:warning'
+    case 'danger': return 'ph:warning-diamond'
+    default: return icon
+  }
+})
+</script>
+
+<template>
+  <div class="vui-alert" :class="[`vui-alert-variant-${variant}`]">
+    <Icon v-if="actualIcon" class="vui-alert-icon" :icon="actualIcon" />
+    <div v-if="$slots.default" class="vui-alert-content">
+      <slot />
+    </div>
+    <div v-else class="vui-alert-default-content">
+      <strong v-if="title">{{ title }}</strong>
+      <p v-if="description">
+        {{ description }}
+      </p>
+    </div>
+
+    <slot name="end" />
+  </div>
+</template>

package/src/components/Alert/alert.scss

@@ -0,0 +1,80 @@
+.vui-alert {
+  display: flex;
+  gap: var(--space-s);
+  border-radius: var(--border-radius-m);
+  padding: var(--space-s);
+  font-size: var(--font-size-m);
+  flex-wrap: nowrap;
+  align-items: flex-start;
+
+  svg {
+    width: 22px;
+    height: 22px;
+  }
+
+  .vui-alert-content,
+  .vui-alert-default-content {
+    flex: 1;
+  }
+
+  .vui-alert-default-content {
+    padding-top: 3px;
+
+    strong {
+      display: block;
+      font-size: var(--font-size-l);
+      font-weight: 550;
+      margin-bottom: 6px;
+    }
+
+    p {
+      font-size: var(--font-size-ms);
+      color: var(--color-text-light);
+      font-weight: 350;
+    }
+  }
+
+  .vui-alert-content {
+    font-size: var(--font-size-m);
+  }
+
+  &.vui-alert-variant-neutral {
+    border: 1px solid var(--color-border);
+
+    svg path {
+      color: var(--color-text);
+    }
+  }
+
+  &.vui-alert-variant-info {
+    border: 1px solid var(--color-border-blue);
+
+    svg path {
+      color: var(--color-text-blue);
+    }
+  }
+
+  &.vui-alert-variant-success {
+    border: 1px solid var(--color-border-green);
+
+    svg path {
+      color: var(--color-text-green);
+    }
+  }
+
+  &.vui-alert-variant-warning {
+    border: 1px solid var(--color-border-yellow);
+
+    svg path {
+      color: var(--color-text-yellow);
+    }
+  }
+
+  &.vui-alert-variant-danger {
+    border: 1px solid var(--color-border-red);
+
+    svg path {
+      color: var(--color-text-red);
+    }
+  }
+}

package/src/components/Avatar/Avatar.vue

@@ -0,0 +1,36 @@
+<script setup lang="ts">
+import type { Sizes } from '../../shared/types'
+import { Icon } from '@iconify/vue'
+import { ref } from 'vue'
+import './avatar.scss'
+
+interface Props {
+  size?: Sizes
+  url?: string
+  fallback?: string
+  icon?: string
+}
+
+const {
+  size = 'm',
+  url,
+  fallback,
+} = defineProps<Props>()
+
+const showFallback = ref(false)
+</script>
+
+<template>
+  <div
+    class="vui-avatar"
+    :class="[`vui-avatar-size-${size}`]"
+  >
+    <img v-if="url && !showFallback" :src="url" @error="showFallback = true">
+    <strong v-else>
+      <template v-if="showFallback">
+        {{ fallback }}
+      </template>
+      <Icon v-else :icon="icon ?? 'ph:user'" />
+    </strong>
+  </div>
+</template>

package/src/components/Avatar/avatar.scss

@@ -0,0 +1,46 @@
+.vui-avatar {
+  --button-size: 36px;
+
+  &.vui-avatar-size-s {
+    --button-size: 28px;
+
+    strong {
+      font-size: var(--font-size-xs);
+    }
+  }
+
+  &.vui-avatar-size-l {
+    --button-size: 48px;
+
+    strong {
+      font-size: var(--font-size-m);
+    }
+  }
+
+  width: var(--button-size);
+  height: var(--button-size);
+  border-radius: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  overflow: hidden;
+  background-color: var(--color-bg-raised);
+  font-weight: 500;
+
+  strong {
+    display: block;
+    font-size: var(--font-size-s);
+  }
+
+  img {
+    display: block;
+    height: 100%;
+    width: 100%;
+    object-position: center;
+    object-fit: cover;
+  }
+
+  img[src=''] {
+    display: none;
+  }
+}

package/src/components/Badge/Badge.vue

@@ -0,0 +1,21 @@
+<script setup lang="ts">
+import './badge.scss'
+
+interface Props {
+  variant?: 'neutral' | 'danger' | 'warning' | 'success' | 'info'
+  outline?: boolean
+  filled?: boolean
+}
+
+const {
+  variant = 'neutral',
+  outline,
+  filled,
+} = defineProps<Props>()
+</script>
+
+<template>
+  <div class="vui-badge" :class="[{ outline, filled }, `vui-badge-variant-${variant}`]">
+    <slot />
+  </div>
+</template>

package/src/components/Badge/badge.scss

@@ -0,0 +1,89 @@
+.vui-badge {
+  display: inline-flex;
+  gap: var(--space-s);
+  place-items: center;
+  height: 26px;
+  padding-inline: var(--space-s);
+  border-radius: 999px;
+  font-weight: 300;
+  font-size: var(--font-size-s);
+
+  &.filled {
+    font-weight: 500;
+  }
+
+  &.vui-badge-variant-neutral {
+    &:not(.outline) {
+      background-color: var(--color-bg-raised);
+
+      &.filled {
+        background-color: var(--color-text);
+        color: var(--color-text-invert);
+        border-color: transparent;
+      }
+    }
+
+    color: var(--color-text);
+    border: 1px solid var(--color-border);
+  }
+
+  &.vui-badge-variant-info {
+    &:not(.outline) {
+      background-color: var(--color-bg-blue-lowered);
+
+      &.filled {
+        background-color: var(--color-text-blue);
+        color: var(--color-text-invert);
+        border-color: transparent;
+      }
+    }
+
+    color: var(--color-text);
+    border: 1px solid var(--color-border-blue);
+  }
+
+  &.vui-badge-variant-success {
+    &:not(.outline) {
+      background-color: var(--color-bg-green-lowered);
+
+      &.filled {
+        background-color: var(--color-text-green);
+        color: var(--color-text-invert);
+        border-color: transparent;
+      }
+    }
+
+    color: var(--color-text);
+    border: 1px solid var(--color-border-green);
+  }
+
+  &.vui-badge-variant-warning {
+    &:not(.outline) {
+      background-color: var(--color-bg-yellow-lowered);
+
+      &.filled {
+        background-color: var(--color-text-yellow);
+        color: var(--color-text-invert);
+        border-color: transparent;
+      }
+    }
+
+    color: var(--color-text);
+    border: 1px solid var(--color-border-yellow);
+  }
+
+  &.vui-badge-variant-danger {
+    &:not(.outline) {
+      background-color: var(--color-bg-red-lowered);
+
+      &.filled {
+        background-color: var(--color-text-red);
+        color: var(--color-text-invert);
+        border-color: transparent;
+      }
+    }
+
+    color: var(--color-text);
+    border: 1px solid var(--color-border-red);
+  }
+}