@fiscozen/card 0.1.6 → 1.0.0-beta.1

package/src/FzCard.vue

@@ -1,81 +1,82 @@
-<template>
-  <section :class="[sectionStaticClass, backgroundColor, textColor]">
-    <header
-      v-if="existHeader"
-      :class="[headerContainerComputedClass, borderColor]"
-      @click="toggleOpen"
-    >
-      <div :class="headerStaticClass">
-        <div class="flex flex-row gap-12 items-center">
-          <h2
-            v-if="title"
-            class="text-core-black font-medium text-2xl m-0 p-0 break-words"
-            :title="title"
-          >
-            {{ title }}
-          </h2>
-          <slot name="header"></slot>
-        </div>
-        <FzIconButton
-          v-if="collapsible"
-          :iconName="isOpen ? 'chevron-up' : 'chevron-down'"
-          variant="invisible"
-        />
-      </div>
-      <slot name="header-content"></slot>
-    </header>
-    <article
-      v-if="isAlive"
-      :class="['p-20', contentClass]"
-      v-show="showContent"
-    >
-      <slot></slot>
-    </article>
-    <footer
-      v-if="(slots.footer || atLeastOneButton) && isAlive"
-      :class="[footerStaticClass, borderColor]"
-      v-show="showContent"
-    >
-      <slot name="footer">
-        <FzIconButton
-          v-if="tertiaryAction"
-          @click="emit('fztertiary:click')"
-          :iconName="tertiaryAction.icon"
-          variant="invisible"
-        />
-        <FzButton
-          v-if="secondaryAction"
-          @click="emit('fzsecondary:click')"
-          :label="secondaryAction.label"
-          variant="secondary"
-        />
-        <FzButton
-          v-if="primaryAction"
-          @click="emit('fzprimary:click')"
-          :label="primaryAction.label"
-          variant="primary"
-        />
-      </slot>
-    </footer>
-  </section>
-</template>
-
 <script setup lang="ts">
-import { computed, onMounted, ref } from "vue";
+/**
+ * FzCard Component
+ *
+ * A flexible container used to group related content and actions. Cards can include
+ * elements like text, images or tables. It also has a set of buttons related to the
+ * content, but other can be added inside the main area.
+ *
+ * Supports multiple color variants, collapsible functionality, and customizable actions.
+ * The card can be divided into header, main content area, and footer sections.
+ *
+ * @component
+ * @example
+ * <FzCard title="Card Title" color="default">
+ *   <p>Card content goes here</p>
+ * </FzCard>
+ * 
+ * @example
+ * <FzCard 
+ *   title="Collapsible Card" 
+ *   collapsible 
+ *   :primaryAction="{ label: 'Save' }"
+ * >
+ *   <p>This card can be collapsed</p>
+ * </FzCard>
+ */
+import { computed, onMounted, ref, watch } from "vue";
 import { FzCardEvents, FzCardProps, FzCardSlots } from "./types";
 import { FzButton, FzIconButton } from "@fiscozen/button";
 
-const props = defineProps<FzCardProps>();
+const props = withDefaults(defineProps<FzCardProps>(), {
+  environment: 'frontoffice'
+});
 const emit = defineEmits<FzCardEvents>();
 const slots = defineSlots<FzCardSlots>();
 const isOpen = ref(props.defaultExpanded ?? false);
 
+/**
+ * Deprecation warning for 'aliceblue' color prop value.
+ * 
+ * Watches for 'aliceblue' color usage and logs warning once on mount or when color changes.
+ * Using watch with immediate:true ensures the warning only fires once per component instance.
+ */
+watch(
+  () => props.color === "aliceblue",
+  (isAliceblue) => {
+    if (isAliceblue) {
+      console.warn(
+        "[FzCard] The color prop value 'aliceblue' is deprecated and will be removed in a future version. " +
+        "Please use 'blue' instead. The component will automatically map 'aliceblue' to 'blue' for now."
+      );
+    }
+  },
+  { immediate: true }
+);
+
+/**
+ * Normalizes deprecated color values to their replacements.
+ * 
+ * Maps deprecated colors to their replacements:
+ * - 'aliceblue' → 'blue'
+ * 
+ * This ensures backward compatibility while encouraging migration to new values.
+ * Deprecation warnings are handled separately via watch hooks.
+ */
+const normalizedColor = computed(() => {
+  if (props.color === "aliceblue") {
+    return "blue";
+  }
+  
+  return props.color;
+});
+
 const sectionStaticClass =
   "border-1 border-solid border-grey-100 rounded flex flex-col";
 const headerStaticClass =
-  "h-64 border-solid p-16 flex flex-row justify-between";
+  "border-solid pt-16 px-16 flex flex-row justify-between";
 const footerStaticClass =
-  "h-64 border-t-1 border-solid p-16 flex justify-end gap-8 items-center";
+  "border-solid pt-0 px-16 pb-16 flex justify-end gap-12 items-center";
 
 const showContent = computed(() => isOpen.value || !props.collapsible);
 const isAlive = computed(() => props.alwaysAlive || showContent.value);
@@ -83,49 +84,58 @@ const existHeader = computed(
   () => props.title || slots["header"] || slots["header-content"],
 );
 const headerContainerComputedClass = computed(() => [
-  showContent.value ? "border-b-1" : "border-b-0",
   props.collapsible ? "cursor-pointer" : "",
 ]);
 
 const backgroundColor = computed(() => {
-  switch (props.color) {
+  switch (normalizedColor.value) {
     case "blue":
-      return "bg-blue-500";
-    case "aliceblue":
       return "bg-background-alice-blue";
     case "orange":
       return "bg-background-seashell";
     case "purple":
       return "bg-background-pale-purple";
+    case "grey":
+      return "bg-background-white-smoke";
     default:
       return "bg-core-white";
   }
 });
 
 const textColor = computed(() => {
-  switch (props.color) {
-    case "blue":
-      return "text-core-white";
-    default:
-      return "text-core-black";
-  }
+  // Note: Based on Figma designs, all color variants use black text
+  // The blue-500 background variant was previously using white text but
+  // the new alice-blue background uses black text
+  return "text-core-black";
 });
 
 const borderColor = computed(() => {
-  switch (props.color) {
+  switch (normalizedColor.value) {
     case "blue":
-      return "border-blue-500";
-    case "aliceblue":
       return "border-background-alice-blue";
     case "orange":
       return "border-orange-200";
     case "purple":
       return "border-purple-200";
+    case "grey":
+      return "border-grey-200";
     default:
       return "border-grey-100";
   }
 });
 
+const borderWidth = computed(() => {
+  switch (normalizedColor.value) {
+    case "blue":
+    case "orange":
+    case "purple":
+    case "grey":
+      return "border-0";
+    default:
+      return "border-1";
+  }
+});
+
 const atLeastOneButton = computed(
   () =>
     props.primaryAction !== undefined ||
@@ -155,3 +165,78 @@ defineExpose({
   toggleOpen,
 });
 </script>
+
+<template>
+  <section :class="[sectionStaticClass, backgroundColor, textColor, borderColor, {'pb-16': !showContent}]">
+    <header
+      v-if="existHeader"
+      :class="[headerContainerComputedClass]"
+      @click="toggleOpen"
+    >
+      <div :class="headerStaticClass">
+        <div class="flex flex-row gap-12 items-center">
+          <h2
+            v-if="title"
+            class="text-core-black font-medium text-xl m-0 p-0 break-words"
+            :title="title"
+          >
+            {{ title }}
+          </h2>
+          <slot name="header"></slot>
+        </div>
+        <div class="flex flex-row gap-8 items-center">
+          <FzIconButton
+            v-if="hasInfoIcon"
+            iconName="circle-question"
+            variant="invisible"
+            :environment="environment"
+            @click.stop="emit('fzcard:click-info')"
+          />
+          <FzIconButton
+            v-if="collapsible"
+            :iconName="isOpen ? 'chevron-up' : 'chevron-down'"
+            variant="invisible"
+            :environment="environment"
+          />
+        </div>
+      </div>
+      <slot name="header-content"></slot>
+    </header>
+    <article
+      v-if="isAlive"
+      :class="['p-16', contentClass]"
+      v-show="showContent"
+    >
+      <slot></slot>
+    </article>
+    <footer
+      v-if="(slots.footer || atLeastOneButton) && isAlive"
+      :class="[footerStaticClass]"
+      v-show="showContent"
+    >
+      <slot name="footer">
+        <FzIconButton
+          v-if="tertiaryAction"
+          @click="emit('fztertiary:click')"
+          :iconName="tertiaryAction.icon"
+          variant="invisible"
+          :environment="environment"
+        />
+        <FzButton
+          v-if="secondaryAction"
+          @click="emit('fzsecondary:click')"
+          :label="secondaryAction.label"
+          variant="secondary"
+          :environment="environment"
+        />
+        <FzButton
+          v-if="primaryAction"
+          @click="emit('fzprimary:click')"
+          :label="primaryAction.label"
+          variant="primary"
+          :environment="environment"
+        />
+      </slot>
+    </footer>
+  </section>
+</template>