@antify/ui-module 1.5.0 → 1.5.1

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "ui-module",
   "configKey": "uiModule",
-  "version": "1.5.0"
+  "version": "1.5.1"
 }

package/dist/runtime/components/AntTooltip.vue

@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import {computed, onMounted, ref} from 'vue';
+import {computed, onMounted, ref, getCurrentInstance} from 'vue';
 import {handleEnumValidation} from '../handler';
 import {InputColorType, Position} from '../enums';
 import {classesToObjectSyntax} from '../utils';
@@ -10,11 +10,13 @@ const props = withDefaults(defineProps<{
 	tooltipClasses?: string | Record<string, boolean>
 	colorType?: InputColorType
 	expanded?: boolean
+	delay?: number
 }>(), {
 	position: Position.left,
 	tooltipClasses: '',
 	colorType: InputColorType.base,
-	expanded: false
+	expanded: false,
+	delay: 800
 });
 const visible = ref(false);
 const _tooltipClasses = computed(() => ({
@@ -73,43 +75,53 @@ const arrowSvgPathClasses = computed(() => {
 
 	return {[variants[props.colorType]]: true};
 });
+const timeout = ref<number | undefined>();
+const clickLock = ref(false);
+const uuid = ref(getCurrentInstance()?.uid)
 
 onMounted(() => {
 	handleEnumValidation(props.position, Position, 'Position')
 	handleEnumValidation(props.colorType, InputColorType, 'colorType')
 });
 
-/**
- * To prevent a fliggering ux, add a delay on hover and leaving the hover target,
- * before showing the tooltip content.
- */
-const delayVisible = ref(visible.value);
-
 function onMouseOver() {
-	delayVisible.value = true;
+	if (visible.value || clickLock.value) {
+		return;
+	}
 
-	setTimeout(() => {
-		if (delayVisible.value) {
-			visible.value = true
-		}
-	}, 300)
+	timeout.value = setTimeout(() => visible.value = true, props.delay) as unknown as number
 }
 
 function onMouseLeave() {
-	delayVisible.value = false
+	clearTimeout(timeout.value)
+
 	visible.value = false
+	clickLock.value = false
+}
+
+function onClick() {
+	clearTimeout(timeout.value)
+
+	visible.value = false
+	clickLock.value = true
 }
 </script>
 
 <template>
   <div
+    :key="uuid"
     class="relative justify-center items-center"
     :class="{'flex w-full': props.expanded, 'inline-flex': !props.expanded}"
     data-e2e="tooltip"
-    @mouseover="onMouseOver"
-    @mouseleave="onMouseLeave"
+    @mouseover="() => onMouseOver()"
+    @mouseleave="() => onMouseLeave()"
   >
-    <slot />
+    <div
+      class="w-full"
+      @click="() => onClick()"
+    >
+      <slot />
+    </div>
 
     <div
       v-if="visible && hasSlotContent($slots.content)"

package/dist/runtime/components/__stories/AntTooltip.stories.d.ts

@@ -8,4 +8,4 @@ export declare const Docs: Story;
  * Make sure, no tooltip get shown if no content is provided.
  */
 export declare const WithoutContent: Story;
-export declare const Expanded: Story;
+export declare const Summary: Story;

package/dist/runtime/components/__stories/AntTooltip.stories.mjs

@@ -1,11 +1,15 @@
 import AntTooltip from "../AntTooltip.vue";
-import AntButton from "../buttons/AntButton.vue";
+import AntFormGroup from "../form/AntFormGroup.vue";
+import AntFormGroupLabel from "../form/AntFormGroupLabel.vue";
 import { Position } from "../../enums/Position.enum.mjs";
 import { InputColorType } from "../../enums/index.mjs";
+import { expect, userEvent, waitFor, within } from "@storybook/test";
 const meta = {
   title: "Components/Tooltip",
   component: AntTooltip,
-  parameters: { controls: { sort: "requiredFirst" } },
+  parameters: {
+    controls: { sort: "requiredFirst" }
+  },
   argTypes: {
     position: {
       control: { type: "select" },
@@ -20,46 +24,194 @@ const meta = {
 export default meta;
 export const Docs = {
   render: (args) => ({
-    components: { AntTooltip, AntButton },
+    components: { AntTooltip },
     setup() {
       return { args };
     },
     template: `
 			<div class="p-32 flex justify-center items-center">
 				<AntTooltip v-bind="args">
-					<template #content>Lorem ipsum dolor sit amet <br/> foo</template>
+					<template #content>Lorem ipsum dolor sit <br/>amet</template>
 					<template #default>
-						<AntButton readonly filled expanded>Hover me</AntButton>
+						<div class="box">Hover me</div>
 					</template>
 				</AntTooltip>
 			</div>
 		`
   }),
+  play: async ({ canvasElement, step }) => {
+    const canvas = within(canvasElement);
+    const target = canvas.getByText("Hover me");
+    function queryTooltip() {
+      return canvas.queryByText("Lorem ipsum dolor sit amet");
+    }
+    await step("Hover over the target and expect showing the tooltip", async () => {
+      await userEvent.hover(target);
+      await waitFor(() => expect(queryTooltip()).toBeInTheDocument(), { timeout: 600 });
+    });
+    await step("Leave hover state and expect not showing the tooltip anymore", async () => {
+      await userEvent.unhover(target);
+      expect(queryTooltip()).not.toBeInTheDocument();
+    });
+    await step("Hover over the target, wait until the tooltip is visible, click the target and expect not showing the tooltip", async () => {
+      await userEvent.hover(target);
+      await waitFor(() => expect(queryTooltip()).toBeInTheDocument(), { timeout: 600 });
+      await userEvent.click(target);
+      expect(queryTooltip()).not.toBeInTheDocument();
+    });
+    await step("Hover over the target, click it while delay and expect not showing the tooltip", async () => {
+      await userEvent.hover(target);
+      await waitFor(() => expect(queryTooltip()).not.toBeInTheDocument(), { timeout: 200 });
+      await userEvent.click(target);
+      expect(queryTooltip()).not.toBeInTheDocument();
+    });
+  },
   args: {
+    delay: 600,
     position: Position.top
   }
 };
 export const WithoutContent = {
   render: (args) => ({
-    components: { AntTooltip, AntButton },
+    components: { AntTooltip },
     setup() {
       return { args };
     },
     template: `
 			<div class="p-32 flex justify-center items-center">
 				<AntTooltip v-bind="args">
-					<AntButton readonly filled expanded>Hover me</AntButton>
+					<div class="box">Hover me</div>
 
 					<template #content></template>
 				</AntTooltip>
 			</div>
-    `
+		`
   }),
+  play: async ({ canvasElement, step }) => {
+    const canvas = within(canvasElement);
+    await step("Hover over the target and expect not showing the tooltip", async () => {
+      await userEvent.hover(canvas.getByText("Hover me"));
+      await waitFor(() => expect(
+        canvas.queryByText(
+          "Lorem ipsum dolor sit amet"
+        )
+      ).not.toBeInTheDocument());
+    });
+  },
   args: {}
 };
-export const Expanded = {
-  render: Docs.render,
-  args: {
-    expanded: true
+export const Summary = {
+  render: (args) => ({
+    components: {
+      AntTooltip,
+      AntFormGroup,
+      AntFormGroupLabel
+    },
+    setup() {
+      return { args, Position, InputColorType };
+    },
+    template: `
+			<AntFormGroup>
+				<AntFormGroupLabel>Position</AntFormGroupLabel>
+				<AntFormGroup direction="row" class="gap-x-32 py-16 dashed">
+					<AntTooltip :position="Position.top">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.right">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.left">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+				</AntFormGroup>
+
+				<AntFormGroupLabel>Color type</AntFormGroupLabel>
+				<AntFormGroup direction="row" class="pb-16 dashed">
+					<AntTooltip :position="Position.bottom" :color-type="InputColorType.base">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom" :color-type="InputColorType.info">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom" :color-type="InputColorType.success">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom" :color-type="InputColorType.warning">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom" :color-type="InputColorType.danger">
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+				</AntFormGroup>
+
+				<AntFormGroupLabel>Expanded</AntFormGroupLabel>
+				<AntFormGroup class="p-32 dashed gap-y-16">
+					<AntTooltip :position="Position.top" expanded>
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.right" expanded>
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.bottom" expanded>
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+
+					<AntTooltip :position="Position.left" expanded>
+						<div class="box">Hover me</div>
+
+						<template #content>Lorem</template>
+					</AntTooltip>
+				</AntFormGroup>
+			</AntFormGroup>
+		`
+  }),
+  parameters: {
+    chromatic: { disableSnapshot: false }
+  },
+  play: async ({ canvasElement, step }) => {
+    const canvas = within(canvasElement);
+    await step("Hover over the targets and expect showing the tooltips", async () => {
+      const targets = canvas.getAllByText("Hover me");
+      await Promise.all(targets.map(async (target) => {
+        await userEvent.hover(target);
+      }));
+      await waitFor(() => expect(canvas.queryAllByText("Lorem")).toHaveLength(targets.length));
+    });
   }
 };

package/dist/runtime/components/buttons/AntActionButton.vue

@@ -3,16 +3,14 @@
  * This button is used for everything what is the primary
  * action like save, confirm, create, etc.
  */
-import {Grouped} from '../../enums/Grouped.enum';
-import {Size} from '../../enums/Size.enum';
-import {ColorType, InputColorType} from '../../enums/ColorType.enum';
-import {Position} from '../../enums/Position.enum';
+import {Position, ColorType, InputColorType, Size, Grouped} from '../../enums';
 import AntButton from './AntButton.vue';
-import AntTooltip from '../AntTooltip.vue';
 import type {IconDefinition} from '@fortawesome/free-solid-svg-icons';
+import {computed, useSlots} from 'vue';
+import {hasSlotContent} from '../../utils';
 
 defineEmits(['click', 'blur']);
-withDefaults(
+const props = withDefaults(
 	defineProps<{
 		iconLeft?: IconDefinition;
 		iconRight?: IconDefinition;
@@ -24,45 +22,50 @@ withDefaults(
 		expanded?: boolean;
 		filled?: boolean;
 		hasPermission?: boolean;
-		invalidPermissionTooltipPosition?: Position;
+		tooltipPosition?: Position;
+		tooltipColorType?: InputColorType;
+		tooltipDelay?: number;
 	}>(), {
 		colorType: ColorType.primary,
 		hasPermission: true,
 		filled: true
 	}
 )
+const slots = useSlots();
+const hasTooltip = computed(() => !props.skeleton && !props.disabled && props.hasPermission && hasSlotContent(slots['tooltipContent']));
+const hasPermissionTooltip = computed(() => !props.skeleton && !props.disabled && !props.hasPermission && hasSlotContent(slots['invalidPermissionTooltipContent']));
 </script>
 
 <template>
-  <AntTooltip
+  <AntButton
+    :icon-left="iconLeft"
+    :icon-right="iconRight"
+    :size="size"
+    :disabled="disabled || !hasPermission"
+    :grouped="grouped"
+    :skeleton="skeleton"
     :expanded="expanded"
-    :position="invalidPermissionTooltipPosition"
-    :color-type="InputColorType.info"
+    :color-type="colorType"
+    :filled="filled"
+    :tooltip-position="tooltipPosition"
+    :tooltip-color-type="hasPermissionTooltip ? InputColorType.info : tooltipColorType"
+    :tooltip-delay="hasPermissionTooltip ? 300 : tooltipDelay"
+    data-e2e="action-button"
+    @click="$emit('click')"
+    @blur="$emit('blur')"
   >
-    <slot name="button">
-      <AntButton
-        :icon-left="iconLeft"
-        :icon-right="iconRight"
-        :size="size"
-        :disabled="disabled || !hasPermission"
-        :grouped="grouped"
-        :skeleton="skeleton"
-        :expanded="expanded"
-        :color-type="colorType"
-        :filled="filled"
-        data-e2e="action-button"
-        @click="$emit('click')"
-        @blur="$emit('blur')"
-      >
-        <slot />
-      </AntButton>
-    </slot>
+    <slot />
 
-    <template
-      v-if="!hasPermission && !skeleton"
-      #content
-    >
-      <slot name="invalidPermissionTooltipContent" />
+    <template #tooltip-content>
+      <slot
+        v-if="hasTooltip"
+        name="tooltipContent"
+      />
+
+      <slot
+        v-if="hasPermissionTooltip"
+        name="invalidPermissionTooltipContent"
+      />
     </template>
-  </AntTooltip>
+  </AntButton>
 </template>

package/dist/runtime/components/buttons/AntButton.vue

@@ -7,9 +7,10 @@ import AntSpinner from '../AntSpinner.vue';
 import {Grouped} from '../../enums/Grouped.enum';
 import {Size} from '../../enums/Size.enum';
 import {handleEnumValidation} from '../../handler';
-import {ColorType} from '../../enums';
+import {ColorType, InputColorType, Position} from '../../enums';
 import {ButtonType} from './__types';
 import AntIcon from '../AntIcon.vue';
+import AntTooltip from '../AntTooltip.vue';
 import {IconSize} from '../__types/AntIcon.types';
 
 defineEmits(['click', 'blur']);
@@ -30,6 +31,9 @@ const props = withDefaults(defineProps<{
 	submit?: boolean;
 	outlined?: boolean;
 	noFocus?: boolean;
+	tooltipPosition?: Position;
+	tooltipColorType?: InputColorType;
+	tooltipDelay?: number;
 }>(), {
 	colorType: ColorType.base,
 	disabled: false,
@@ -43,6 +47,9 @@ const props = withDefaults(defineProps<{
 	submit: false,
 	outlined: true,
 	noFocus: false,
+	tooltipPosition: Position.bottom,
+	tooltipColorType: InputColorType.base,
+	tooltipDelay: 800
 });
 
 const hasAction = computed(() => (props.skeleton || props.readonly || props.disabled))
@@ -178,50 +185,63 @@ onMounted(() => {
       absolute
     />
 
-    <component
-      :is="is"
-      :class="classes"
-      :type="type"
-      :to="to"
-      :disabled="disabled || undefined"
-      :tabindex="noFocus || hasAction ? '-1' : '0'"
-      @click="() => !props.readonly ? $emit('click') : null"
-      @blur="() => !props.readonly ? $emit('blur') : null"
+    <AntTooltip
+      :expanded="expanded"
+      :position="tooltipPosition"
+      :color-type="tooltipColorType"
+      :delay="tooltipDelay"
     >
-      <AntSpinner
-        v-if="spinner"
-        :size="size"
-        :color-type="colorType"
-        :inverted="!filled"
-      />
+      <template #default>
+        <component
+          :is="is"
+          :class="classes"
+          :type="type"
+          :to="to"
+          :disabled="disabled || undefined"
+          :tabindex="noFocus || hasAction ? '-1' : '0'"
+          @click="() => !props.readonly ? $emit('click') : null"
+          @blur="() => !props.readonly ? $emit('blur') : null"
+        >
+          <AntSpinner
+            v-if="spinner"
+            :size="size"
+            :color-type="colorType"
+            :inverted="!filled"
+          />
 
-      <slot
-        v-if="!spinner"
-        name="icon-left"
-      >
-        <AntIcon
-          v-if="iconLeft"
-          :icon="iconLeft"
-          :size="size as unknown as IconSize"
-          :color="iconColor"
-        />
-      </slot>
+          <slot
+            v-if="!spinner"
+            name="icon-left"
+          >
+            <AntIcon
+              v-if="iconLeft"
+              :icon="iconLeft"
+              :size="size as unknown as IconSize"
+              :color="iconColor"
+            />
+          </slot>
 
-      <slot
-        v-if="!spinner"
-      />
+          <slot
+            v-if="!spinner"
+          />
 
-      <slot
-        v-if="!spinner"
-        name="icon-right"
-      >
-        <AntIcon
-          v-if="iconRight"
-          :icon="iconRight"
-          :size="size as unknown as IconSize"
-          :color="iconColor"
-        />
-      </slot>
-    </component>
+          <slot
+            v-if="!spinner"
+            name="icon-right"
+          >
+            <AntIcon
+              v-if="iconRight"
+              :icon="iconRight"
+              :size="size as unknown as IconSize"
+              :color="iconColor"
+            />
+          </slot>
+        </component>
+      </template>
+
+      <template #content>
+        <slot name="tooltip-content" />
+      </template>
+    </AntTooltip>
   </div>
 </template>

package/dist/runtime/components/buttons/AntCreateButton.vue

@@ -1,19 +1,20 @@
 <script lang="ts" setup>
-import {Grouped} from '../../enums/Grouped.enum';
-import {Size} from '../../enums/Size.enum';
 import AntActionButton from './AntActionButton.vue';
-import {Position} from '../../enums';
+import {Position, Size, Grouped, ColorType} from '../../enums';
+import {faPlus} from '@fortawesome/free-solid-svg-icons';
 
 defineEmits(['click', 'blur']);
 withDefaults(defineProps<{
+	iconVariant?: boolean;
 	size?: Size;
 	disabled?: boolean;
 	grouped?: Grouped;
 	skeleton?: boolean;
 	expanded?: boolean;
 	canCreate?: boolean;
-	invalidPermissionTooltipPosition?: Position;
+	tooltipPosition?: Position;
 }>(), {
+	iconVariant: false,
 	canCreate: true
 });
 </script>
@@ -21,22 +22,33 @@ withDefaults(defineProps<{
 <template>
   <AntActionButton
     :filled="false"
+    :color-type="ColorType.primary"
     :size="size"
     :disabled="disabled"
+    :icon-left="iconVariant ? faPlus : undefined"
     :grouped="grouped"
     :skeleton="skeleton"
     :expanded="expanded"
     :has-permission="canCreate"
-    :invalid-permission-tooltip-position="invalidPermissionTooltipPosition"
+    :tooltip-position="tooltipPosition"
     data-e2e="create-button"
     @click="$emit('click')"
     @blur="$emit('blur')"
   >
-    <template #default>Create</template>
+    <template
+      v-if="!iconVariant"
+      #default
+    >
+      Create
+    </template>
 
     <template #invalidPermissionTooltipContent>
       You have no permission to create new entries.<br>
       Please contact your administrator.
     </template>
+
+    <template #tooltipContent>
+      Create new entry
+    </template>
   </AntActionButton>
 </template>

package/dist/runtime/components/buttons/AntDeleteButton.vue

@@ -1,9 +1,6 @@
 <script lang="ts" setup>
-import {Grouped} from '../../enums/Grouped.enum';
-import {Size} from '../../enums/Size.enum';
-import {ColorType} from '../../enums/ColorType.enum';
 import AntActionButton from './AntActionButton.vue';
-import {Position} from '../../enums';
+import {Position, Size, Grouped, ColorType} from '../../enums';
 import {faTrash} from '@fortawesome/free-solid-svg-icons';
 
 defineEmits(['click', 'blur']);
@@ -15,25 +12,25 @@ withDefaults(defineProps<{
 	skeleton?: boolean;
 	expanded?: boolean;
 	canDelete?: boolean;
-	invalidPermissionTooltipPosition?: Position;
+	tooltipPosition?: Position;
 }>(), {
 	iconVariant: false,
 	canDelete: true
-})
+});
 </script>
 
 <template>
   <AntActionButton
-    :icon-left="iconVariant ? faTrash : undefined"
     :filled="false"
+    :color-type="ColorType.danger"
     :size="size"
     :disabled="disabled"
+    :icon-left="iconVariant ? faTrash : undefined"
     :grouped="grouped"
     :skeleton="skeleton"
     :expanded="expanded"
-    :color-type="ColorType.danger"
     :has-permission="canDelete"
-    :invalid-permission-tooltip-position="invalidPermissionTooltipPosition"
+    :tooltip-position="tooltipPosition"
     data-e2e="delete-button"
     @click="$emit('click')"
     @blur="$emit('blur')"
@@ -46,8 +43,12 @@ withDefaults(defineProps<{
     </template>
 
     <template #invalidPermissionTooltipContent>
-      You have no permission to delete this entry.<br>
+      You have no permission to delete entries.<br>
       Please contact your administrator.
     </template>
+
+    <template #tooltipContent>
+      Delete entry
+    </template>
   </AntActionButton>
 </template>