From c1177d47eaa598e15e0f7c9d19364a5875cfb0eb Mon Sep 17 00:00:00 2001
From: Goutham Ponnada <sponnada@ebay.com>
Date: Thu, 9 Nov 2023 10:19:17 -0800
Subject: [PATCH] refactor(skeleton): refactor code

---
 .../ebay-skeleton-loader/examples/image.marko |  1 +
 .../examples/withContent.marko                | 29 +++++++++++
 .../ebay-skeleton-loader/index.marko          | 51 +++++++++++--------
 .../ebay-skeleton-loader/marko-tag.json       | 19 ++++++-
 .../skeleton-loader.stories.js                | 41 ++++++++++++++-
 5 files changed, 117 insertions(+), 24 deletions(-)
 create mode 100644 src/components/ebay-skeleton-loader/examples/image.marko
 create mode 100644 src/components/ebay-skeleton-loader/examples/withContent.marko

diff --git a/src/components/ebay-skeleton-loader/examples/image.marko b/src/components/ebay-skeleton-loader/examples/image.marko
new file mode 100644
index 0000000000..be8152612c
--- /dev/null
+++ b/src/components/ebay-skeleton-loader/examples/image.marko
@@ -0,0 +1 @@
+<ebay-skeleton-loader type="image" style="width:220px; height:220px" ...input/>
diff --git a/src/components/ebay-skeleton-loader/examples/withContent.marko b/src/components/ebay-skeleton-loader/examples/withContent.marko
new file mode 100644
index 0000000000..e792d8c1d1
--- /dev/null
+++ b/src/components/ebay-skeleton-loader/examples/withContent.marko
@@ -0,0 +1,29 @@
+class {
+    onCreate() {
+        this.state = {
+            isLoading: true,
+            data: null,
+        };
+    }
+    async getData() {
+        return new Promise((resolve, reject) => {
+            setTimeout(() => resolve("Button"), 2000);
+        });
+    }
+    async onMount() {
+        try {
+            this.state.data = await this.getData();
+        } catch (err) {
+            this.state.error = err;
+        } finally {
+            this.state.isLoading = false;
+        }
+    }
+}
+
+<if(state.isLoading)>
+    <ebay-skeleton-loader type="button" style="width:88px" ...input/>
+</if>
+<else>
+    <ebay-button> ${state.data} </ebay-button>
+</else>
diff --git a/src/components/ebay-skeleton-loader/index.marko b/src/components/ebay-skeleton-loader/index.marko
index f5514fe303..fdd9c855b5 100644
--- a/src/components/ebay-skeleton-loader/index.marko
+++ b/src/components/ebay-skeleton-loader/index.marko
@@ -7,9 +7,12 @@ static var ignoredAttributes = [
     "multiline",
     "count",
     "columns",
+    "isVisible",
 ];
-$ var size = input.size || "default";
-$ var type = input.type || "button";
+static var validTypes = ["avatar", "button", "text", "form", "image", "tile"];
+static var validSizes = ["large", "small"];
+$ var size = validSizes.includes(input.size) ? input.size : "default";
+$ var type = validTypes.includes(input.type) ? input.type : "button";
 $ var typeClass = type === "button" ? "skeleton--btn" : `skeleton--${type}`;
 $ var skeletonClass = (
     size !== "default"
@@ -19,23 +22,27 @@ $ var skeletonClass = (
         : typeClass
 );
 
-<div
-    ...processHtmlAttributes(input, ignoredAttributes)
-    class=[
-        type !== "tile" ? `skeleton ${skeletonClass}` : typeClass,
-        input.multiline && type === "text" && "skeleton--text-multiline",
-        input.class,
-    ]
-    role="img"
-    aria-label=input.a11yText || "Loading"
->
-    <if(type === "tile")>
-        <div class="skeleton-image-container">
-            <div class="skeleton skeleton--image"/>
-        </div>
-        <div class=[
-            `skeleton skeleton--text-${size !== "default" ? size : "small"}`,
-            input.multiline && "skeleton--text-multiline",
-        ]/>
-    </if>
-</div>
+<if(typeof input.isVisible === "undefined" ? true : input.isVisible)>
+    <div
+        ...processHtmlAttributes(input, ignoredAttributes)
+        class=[
+            type !== "tile" ? `skeleton ${skeletonClass}` : typeClass,
+            input.multiline && type === "text" && "skeleton--text-multiline",
+            input.class,
+        ]
+        role="img"
+        aria-label=input.a11yText || "Loading"
+    >
+        <if(type === "tile")>
+            <div class="skeleton-image-container">
+                <div class="skeleton skeleton--image"/>
+            </div>
+            <div class=[
+                `skeleton skeleton--text-${
+                    size !== "default" ? size : "small"
+                }`,
+                input.multiline && "skeleton--text-multiline",
+            ]/>
+        </if>
+    </div>
+</if>
diff --git a/src/components/ebay-skeleton-loader/marko-tag.json b/src/components/ebay-skeleton-loader/marko-tag.json
index 0967ef424b..74fa52e227 100644
--- a/src/components/ebay-skeleton-loader/marko-tag.json
+++ b/src/components/ebay-skeleton-loader/marko-tag.json
@@ -1 +1,18 @@
-{}
+{
+    "attribute-groups": ["html-attributes"],
+    "@*": {
+        "targetProperty": null,
+        "type": "expression"
+    },
+    "@html-attributes": "expression",
+    "@role": "never",
+    "@type": {
+        "enum": ["avatar", "button", "form", "text", "tile"]
+    },
+    "@size": {
+        "enum": ["default", "small", "large"]
+    },
+    "@multiline": "boolean",
+    "@isVisible": "boolean",
+    "@a11yText": "string"
+}
diff --git a/src/components/ebay-skeleton-loader/skeleton-loader.stories.js b/src/components/ebay-skeleton-loader/skeleton-loader.stories.js
index 909e8c9a81..24b1af74fa 100644
--- a/src/components/ebay-skeleton-loader/skeleton-loader.stories.js
+++ b/src/components/ebay-skeleton-loader/skeleton-loader.stories.js
@@ -12,8 +12,12 @@ import textMultilineTemplate from "./examples/text-multiline.marko";
 import textMultilineCode from "./examples/text-multiline.marko?raw";
 import formTemplate from "./examples/form.marko";
 import formCode from "./examples/form.marko?raw";
+import imageTemplate from "./examples/image.marko";
+import imageCode from "./examples/image.marko?raw";
 import tileTemplate from "./examples/tile.marko";
 import tileCode from "./examples/tile.marko?raw";
+import withContentTemplate from "./examples/withContent.marko";
+import withContentCode from "./examples/withContent.marko?raw";
 
 const Template = (args) => ({
     input: addRenderBodies(args),
@@ -33,7 +37,7 @@ export default {
     argTypes: {
         size: {
             control: { type: "select" },
-            options: ["default", "small", "large"],
+            options: ["small", "large"],
             table: {
                 defaultValue: {
                     summary: "default",
@@ -52,6 +56,15 @@ export default {
             description:
                 "If the text should be multiline. Applicable for type `text` or `tile` only",
         },
+        isVisible: {
+            control: { type: "boolean" },
+            table: {
+                defaultValue: {
+                    summary: "true",
+                },
+            },
+            description: "If set to true, the skeleton will be visible",
+        },
         a11yText: {
             control: { type: "text" },
             description: "The accessibility text for the component",
@@ -141,6 +154,19 @@ Form.parameters = {
     },
 };
 
+export const Image = (args) => ({
+    input: args,
+    component: imageTemplate,
+});
+Image.args = {};
+Image.parameters = {
+    docs: {
+        source: {
+            code: imageCode,
+        },
+    },
+};
+
 export const Tile = (args) => ({
     input: args,
     component: tileTemplate,
@@ -153,3 +179,16 @@ Tile.parameters = {
         },
     },
 };
+
+export const withContent = (args) => ({
+    input: args,
+    component: withContentTemplate,
+});
+withContent.args = {};
+withContent.parameters = {
+    docs: {
+        source: {
+            code: withContentCode,
+        },
+    },
+};