@saasmakers/ui 0.1.59 → 0.1.60

package/app/components/bases/BaseTag.vue

@@ -0,0 +1,179 @@
+<script lang="ts" setup>
+import type { BaseTag } from '../../types/bases'
+import { NuxtLinkLocale } from '#components'
+import { getIcon } from '../../composables/useIcons'
+
+const props = withDefaults(defineProps<BaseTag>(), {
+  active: false,
+  avatar: '',
+  circle: '',
+  clickable: true,
+  color: 'black',
+  draggable: false,
+  editable: false,
+  icon: undefined,
+  iconSize: undefined,
+  id: undefined,
+  isCreation: false,
+  light: true,
+  removable: false,
+  rounded: false,
+  size: 'base',
+  text: '',
+  to: undefined,
+  truncate: false,
+  uppercase: true,
+})
+
+const emit = defineEmits<{
+  click: [event: MouseEvent, id?: number | string]
+  close: [event: MouseEvent, id?: number | string]
+  inputBlur: [event: FocusEvent, name: string, id?: number | string]
+  inputSubmit: [event: KeyboardEvent, name: string, id?: number | string]
+  remove: [event: MouseEvent, id?: number | string]
+}>()
+
+const hovered = ref(false)
+
+const form = reactive({ name: '' })
+
+onBeforeMount(() => {
+  if (!props.isCreation) {
+    initializeFormForExistingTag()
+  }
+})
+
+function initializeFormForExistingTag() {
+  form.name = String(props.text)?.substring(1)
+}
+
+function onClick(event: MouseEvent) {
+  if (!props.removable) {
+    emit('click', event, props.id)
+  }
+}
+
+function onInputBlur(event: FocusEvent) {
+  emit('inputBlur', event, form.name.trim(), props.id)
+}
+
+function onInputSubmit(event: KeyboardEvent) {
+  emit('inputSubmit', event, form.name.trim(), props.id)
+}
+
+function onMouseEnter() {
+  hovered.value = true
+}
+
+function onMouseLeave() {
+  hovered.value = false
+}
+
+function onRemove(event: MouseEvent) {
+  emit('remove', event, props.id)
+}
+</script>
+
+<template>
+  <span
+    class="flex select-none"
+    @click.stop="onClick"
+    @mouseenter="onMouseEnter"
+    @mouseleave="onMouseLeave"
+  >
+    <component
+      :is="to ? NuxtLinkLocale : 'span'"
+      class="inline-flex items-center border font-medium"
+      :class="{
+        'cursor-pointer': clickable,
+        'rounded-md': !rounded,
+        'rounded-full': rounded,
+        'uppercase': uppercase,
+
+        'border-gray-200 dark:border-gray-800 bg-gray-200 dark:bg-gray-800 text-gray-800 dark:text-gray-200': (color === 'black' && light && !active) || removable,
+        'border-gray-900 dark:border-gray-100 bg-gray-900 dark:bg-gray-100 text-white dark:text-black': color === 'black' && (!light || active),
+        'border-gray-700 dark:border-gray-300 bg-gray-100 dark:bg-gray-900 text-gray-700 dark:text-gray-300': color === 'gray' && light && !active,
+        'border-gray-800 dark:border-gray-200 bg-gray-800 dark:bg-gray-200 text-white dark:text-black': color === 'gray' && (!light || active),
+        'border-green-700 dark:border-green-300 bg-green-100 dark:bg-green-900 text-green-700 dark:text-green-300': color === 'green' && light && !active,
+        'border-green-800 dark:border-green-200 bg-green-800 dark:bg-green-200 text-white dark:text-black': color === 'green' && (!light || active),
+        'border-indigo-700 dark:border-indigo-300 bg-indigo-100 dark:bg-indigo-900 text-indigo-700 dark:text-indigo-300': color === 'indigo' && light && !active,
+        'border-indigo-800 dark:border-indigo-200 bg-indigo-800 dark:bg-indigo-200 text-white dark:text-black': color === 'indigo' && (!light || active),
+        'border-orange-700 dark:border-orange-300 bg-white dark:bg-gray-900 text-orange-700 dark:text-orange-300': color === 'orange' && light && !active,
+        'border-orange-800 dark:border-orange-200 bg-orange-800 dark:bg-orange-200 text-white dark:text-black': color === 'orange' && (!light || active),
+        'border-red-700 dark:border-red-300 bg-white dark:bg-gray-900 text-red-700 dark:text-red-300': color === 'red' && light && !active,
+        'border-red-800 dark:border-red-200 bg-red-800 dark:bg-red-200 text-white dark:text-black': color === 'red' && (!light || active),
+        'border-gray-300 dark:border-gray-700 bg-white dark:bg-gray-900 text-gray-800 dark:text-gray-200': color === 'white' && light && !active,
+        'border-white dark:border-gray-900 text-white dark:text-black': color === 'white' && (!light || active),
+        'border-dashed border-gray-400 dark:border-gray-600 bg-white dark:bg-gray-900 text-gray-800 dark:text-gray-200': color === 'white' && light && !active,
+
+        'py-1.5 px-2.5 text-2xs': size === 'sm',
+        'py-2 px-3 text-xs': size === 'base',
+      }"
+      :to="to"
+    >
+      <BaseIcon
+        v-if="draggable"
+        class="js-drag-handle mr-2 cursor-move"
+        clickable
+        color="gray"
+        :icon="getIcon('drag')"
+      />
+
+      <span
+        v-if="avatar || circle || icon"
+        class="mr-1 flex items-center text-center"
+        :class="{
+          'h-2.5 w-2.5': size === 'sm' || iconSize === 2.5,
+          'h-3 w-3': size === 'base' || iconSize === 3,
+          'h-3.5 w-3.5': iconSize === 3.5,
+          'h-4 w-4': iconSize === 4,
+        }"
+      >
+        <BaseAvatar
+          v-if="avatar"
+          class="h-full w-full"
+          rounded="sm"
+          :shadow="false"
+          :src="avatar"
+        />
+
+        <BaseIcon
+          v-else-if="icon"
+          class="h-full w-full"
+          :icon="icon"
+        />
+      </span>
+
+      <span
+        v-if="$slots.left"
+        class="mr-1"
+      >
+        <slot name="left" />
+      </span>
+
+      <BaseText
+        v-if="!editable"
+        class="whitespace-nowrap outline-none"
+        :class="{ truncate }"
+        :text="text"
+      />
+
+      <FieldInput
+        v-else
+        v-model="form.name"
+        border="none"
+        class="w-16"
+        size="sm"
+        @blur="onInputBlur"
+        @submit="onInputSubmit"
+      />
+
+      <BaseIcon
+        v-if="removable"
+        class="ml-1.5 text-red-700 dark:text-red-300 hover:text-black dark:hover:text-white"
+        :icon="getIcon('closeCircle')"
+        @click.prevent.stop="onRemove"
+      />
+    </component>
+  </span>
+</template>

package/app/components/bases/BaseTags.vue

@@ -0,0 +1,238 @@
+<script lang="ts" setup>
+import type { BaseTags } from '../../types/bases'
+
+const props = withDefaults(defineProps<BaseTags>(), {
+  active: false,
+  clickable: true,
+  draggable: false,
+  editable: false,
+  hasBack: false,
+  hasCreation: false,
+  maxTags: Number.POSITIVE_INFINITY,
+  removable: false,
+  selectable: false,
+  selectableUnique: false,
+  size: 'base',
+  tags: () => [],
+  value: () => [],
+  wrap: false,
+})
+
+const emit = defineEmits<{
+  'attach': [event: MouseEvent, tagId?: number | string]
+  'back': [event: MouseEvent]
+  'click': [event: MouseEvent]
+  'create': [event: MouseEvent, name: string]
+  'detach': [event: MouseEvent, tagId?: number | string]
+  'remove': [event: MouseEvent, tagId?: number | string]
+  'update': [event: MouseEvent, name: string, tagId?: number | string]
+  'update:modelValue': [value: (number | string)[]]
+}>()
+
+const keyForTagCreation = ref(Date.now())
+const keyForTagUpdate = ref(Date.now())
+const root = ref<HTMLDivElement>()
+const showingAllTags = ref(false)
+const showingTagCreationField = ref(false)
+
+const { t } = useI18n()
+
+const sortedTags = computed({
+  get() {
+    return props.tags
+      .slice()
+      .filter((_tag, tagIndex) => tagIndex < props.maxTags || showingAllTags.value)
+      .sort((tagA, tagB) => (tagA.order! < tagB.order! ? -1 : 0))
+  },
+
+  set(tags) {
+    const suiteForTags = tags
+      .map((tag, order) => ({
+        id: tag.id,
+        order,
+      }))
+      .map(tag => ({
+        id: tag.id,
+        order: tag.order,
+      }))
+
+    return suiteForTags
+  },
+})
+
+function onCreateTag(event: MouseEvent, name: string) {
+  showingTagCreationField.value = false
+  keyForTagCreation.value = Date.now()
+
+  emit('create', event, name)
+}
+
+function onGoBack(event: MouseEvent) {
+  emit('back', event)
+}
+
+function onShowTagField() {
+  if (!showingTagCreationField.value) {
+    showingTagCreationField.value = true
+
+    // Focus contenteditable
+    nextTick(() => {
+      const element = root.value?.querySelector<HTMLInputElement>('input[type="text"]')
+
+      element?.focus()
+    })
+  }
+}
+
+function onShowAllTags() {
+  showingAllTags.value = true
+}
+
+function onTagClick(event: MouseEvent, tagId?: number | string) {
+  if (props.selectable && tagId) {
+    let value = [...props.value]
+
+    if (value.includes(tagId)) {
+      value.splice(value.indexOf(tagId), 1)
+      emit('detach', event, tagId)
+    }
+    else if (props.selectableUnique) {
+      value = [tagId]
+      emit('attach', event, tagId)
+    }
+    else {
+      value.push(tagId)
+      emit('attach', event, tagId)
+    }
+
+    emit('update:modelValue', value)
+  }
+}
+
+function onUpdateTag(event: MouseEvent, name: string, tagId?: number | string) {
+  if (name) {
+    emit('update', event, name, tagId)
+  }
+
+  else {
+    keyForTagUpdate.value = Date.now()
+  }
+}
+
+function onRemoveTag(event: MouseEvent, tagId?: number | string) {
+  emit('remove', event, tagId)
+}
+</script>
+
+<template>
+  <div
+    ref="root"
+    class="flex items-center"
+    :class="{
+      'flex-wrap': wrap,
+      'w-full overflow-x-auto': !wrap,
+
+      '-mt-0.75 -ml-0.75': size === 'sm',
+      '-mt-1 -ml-1': size === 'base',
+    }"
+  >
+    <BaseTag
+      v-if="hasBack"
+      key="BaseTagToGoBack"
+      :class="{
+        'm-0.75': size === 'sm',
+        'm-1': size === 'base',
+      }"
+      color="indigo"
+      :icon="getIcon('back')"
+      :size="size"
+      :text="t('globals.cancel')"
+      @click="onGoBack"
+    />
+
+    <BaseTag
+      v-if="hasCreation"
+      :key="keyForTagCreation"
+      :class="{
+        'm-0.75': size === 'sm',
+        'm-1': size === 'base',
+      }"
+      color="indigo"
+      :editable="showingTagCreationField"
+      :icon="showingTagCreationField ? getIcon('tags') : getIcon('plus')"
+      is-creation
+      :light="false"
+      :size="size"
+      :text="showingTagCreationField ? '' : t('newTag')"
+      @click="onShowTagField"
+      @input:blur="onCreateTag"
+      @input:submit="onCreateTag"
+    />
+
+    <div class="flex items-center">
+      <span
+        v-for="(tag, tagIndex) in sortedTags"
+        :key="tag.id ? `${tag.id}_${tag.order}_${keyForTagUpdate}` : tagIndex"
+        class="flex flex-wrap items-center"
+        :class="{
+          'm-0.75': size === 'sm',
+          'm-1': size === 'base',
+        }"
+      >
+        <template v-if="tag">
+          <BaseTag
+            :id="tag.id || tagIndex"
+            :key="`${tag.id}_${tagIndex}`"
+            :active="tag.id && value.includes(tag.id) || tag.active"
+            :avatar="tag.avatar"
+            :circle="tag.circle"
+            :clickable="clickable"
+            :color="tag.color"
+            :draggable="draggable"
+            :editable="editable"
+            :icon="tag.icon"
+            :icon-size="tag.iconSize"
+            :light="tag.light"
+            :removable="removable"
+            :size="size"
+            :text="tag.text"
+            :to="tag.to"
+            @click="onTagClick"
+            @input:blur="onUpdateTag"
+            @input:submit="onUpdateTag"
+            @remove="onRemoveTag"
+          />
+        </template>
+      </span>
+    </div>
+
+    <BaseTag
+      v-if="tags.length > maxTags && !showingAllTags"
+      key="showMore"
+      :class="{
+        'm-0.75': size === 'sm',
+        'm-1': size === 'base',
+      }"
+      :size="size"
+      :text="t('showMore', { value: tags.length - maxTags })"
+      @click="onShowAllTags"
+    />
+  </div>
+</template>
+
+  <i18n lang="json">
+  {
+    "en": {
+      "newTag": "New tag",
+      "showMore": "& {value} other | & {value} others"
+    },
+    "fr": {
+      "newTag": "Nouveau tag",
+      "showMore": "& {value} autre | & {value} autres"
+    },
+    "ja": {
+      "newTag": "新しいタグ",
+      "showMore": "& {value} その他 | & {value} その他"
+    }
+  }
+  </i18n>

package/app/composables/useIcons.ts

@@ -12,12 +12,16 @@ const icons = {
   arrowDown: 'solar:alt-arrow-down-bold',
   arrowRight: 'solar:alt-arrow-right-bold',
   arrowUp: 'solar:alt-arrow-up-bold',
+  back: 'hugeicons:arrow-turn-backward',
   checkCircle: 'hugeicons:checkmark-circle-02',
   close: 'hugeicons:cancel-01',
   closeCircle: 'hugeicons:cancel-circle',
   default: 'hugeicons:help-circle',
+  drag: 'mdi:drag-horizontal-variant',
   exclamationCircle: 'hugeicons:alert-circle',
   infoCircle: 'hugeicons:information-circle',
+  plus: 'hugeicons:add-01',
+  tags: 'hugeicons:tags',
 } as const
 
 export function getIcon(attribute: keyof typeof icons) {

package/app/types/bases.d.ts

@@ -262,6 +262,48 @@ export interface BaseSpinner {
   uppercase?: boolean
 }
 
+export interface BaseTag {
+  active?: boolean
+  avatar?: string
+  circle?: string
+  clickable?: boolean
+  color?: BaseColor
+  draggable?: boolean
+  editable?: boolean
+  icon?: BaseIconValue
+  iconSize?: number
+  id?: number
+  isCreation?: boolean
+  light?: boolean
+  order?: number
+  removable?: boolean
+  rounded?: boolean
+  size?: BaseTagSize
+  text: BaseTextText
+  to?: RouteLocationNamedI18n
+  truncate?: boolean
+  uppercase?: boolean
+}
+
+export type BaseTagSize = 'base' | 'sm'
+
+export interface BaseTags {
+  active?: boolean
+  clickable?: boolean
+  draggable?: boolean
+  editable?: boolean
+  hasBack?: boolean
+  hasCreation?: boolean
+  maxTags?: number
+  removable?: boolean
+  selectable?: boolean
+  selectableUnique?: boolean
+  size?: BaseTagSize
+  tags: BaseTag[]
+  value?: (number | string)[]
+  wrap?: boolean
+}
+
 export interface BaseText {
   background?: BaseTextBackground
   bold?: boolean

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@saasmakers/ui",
   "type": "module",
-  "version": "0.1.59",
+  "version": "0.1.60",
   "private": false,
   "description": "Reusable Nuxt UI components for SaaS Makers projects",
   "license": "MIT",