From b806b2ff190ff634bccc4f709f9129ae50f4ffed Mon Sep 17 00:00:00 2001
From: Andrea Scartabelli <andrea.scartabelli@gmail.com>
Date: Wed, 7 Aug 2024 10:24:32 +0200
Subject: [PATCH] web-wallet: Add `UsageIndicator` component

Resolves #2073
---
 .../UsageIndicator/UsageIndicator.svelte      | 76 +++++++++++++++
 .../__tests__/UsageIndicator.spec.js          | 55 +++++++++++
 .../__snapshots__/UsageIndicator.spec.js.snap | 95 +++++++++++++++++++
 web-wallet/src/lib/components/index.js        |  1 +
 .../routes/components-showcase/+page.svelte   |  2 +
 .../UsageIndicators.svelte                    | 11 +++
 web-wallet/src/style/dusk/colors.css          |  3 +-
 web-wallet/src/style/dusk/language.css        |  3 +-
 8 files changed, 244 insertions(+), 2 deletions(-)
 create mode 100644 web-wallet/src/lib/components/UsageIndicator/UsageIndicator.svelte
 create mode 100644 web-wallet/src/lib/components/__tests__/UsageIndicator.spec.js
 create mode 100644 web-wallet/src/lib/components/__tests__/__snapshots__/UsageIndicator.spec.js.snap
 create mode 100644 web-wallet/src/routes/components-showcase/UsageIndicators.svelte

diff --git a/web-wallet/src/lib/components/UsageIndicator/UsageIndicator.svelte b/web-wallet/src/lib/components/UsageIndicator/UsageIndicator.svelte
new file mode 100644
index 0000000000..f57762995f
--- /dev/null
+++ b/web-wallet/src/lib/components/UsageIndicator/UsageIndicator.svelte
@@ -0,0 +1,76 @@
+<svelte:options immutable={true} />
+
+<script>
+  import { mdiShieldLock, mdiShieldLockOpenOutline } from "@mdi/js";
+
+  import { makeClassName } from "$lib/dusk/string";
+  import { Icon } from "$lib/dusk/components";
+
+  /** @type {string | undefined} */
+  export let className = undefined;
+
+  /** @type {number} */
+  export let value;
+
+  $: classes = makeClassName(["usage-indicator", className]);
+  $: valueToShow = +value.toFixed(2);
+  $: shieldedText = `You have put ${valueToShow}% of your funds in your shielded account`;
+  $: unshieldedText = `You have put ${+(100 - valueToShow).toFixed(2)}% of your funds in your unshielded account`;
+</script>
+
+<div class={classes}>
+  <Icon
+    className="usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text={shieldedText}
+    path={mdiShieldLock}
+  />
+  <div
+    aria-valuemax="100"
+    aria-valuemin="0"
+    aria-valuenow={valueToShow}
+    aria-valuetext={shieldedText}
+    class="usage-indicator__meter"
+    role="meter"
+  >
+    <div
+      aria-hidden="true"
+      class="usage-indicator__meter-bar"
+      style:width={`${valueToShow}%`}
+    ></div>
+  </div>
+  <Icon
+    className="usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text={unshieldedText}
+    path={mdiShieldLockOpenOutline}
+  />
+</div>
+
+<style lang="postcss">
+  :global {
+    .usage-indicator {
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      gap: var(--small-gap);
+    }
+
+    .usage-indicator__icon {
+      cursor: help;
+    }
+
+    .usage-indicator__meter {
+      flex: 1;
+      height: 1rem;
+      background-color: var(--success-color);
+      overflow: hidden;
+      border-radius: var(--control-border-radius-size);
+    }
+
+    .usage-indicator__meter-bar {
+      background-color: var(--success-color-variant-dark);
+      height: 100%;
+    }
+  }
+</style>
diff --git a/web-wallet/src/lib/components/__tests__/UsageIndicator.spec.js b/web-wallet/src/lib/components/__tests__/UsageIndicator.spec.js
new file mode 100644
index 0000000000..125db40d1f
--- /dev/null
+++ b/web-wallet/src/lib/components/__tests__/UsageIndicator.spec.js
@@ -0,0 +1,55 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { cleanup, getAllByRole, render } from "@testing-library/svelte";
+
+import { UsageIndicator } from "..";
+
+const getPercentages = () =>
+  getAllByRole(document.body, "graphics-symbol").map((el) =>
+    Number(
+      el
+        .getAttribute("data-tooltip-text")
+        ?.replace(/^.*?(\d+(\.\d+)?)%.*?$/, "$1")
+    )
+  );
+
+describe("UsageIndicator", () => {
+  const baseProps = {
+    value: 45,
+  };
+  const baseOptions = {
+    props: baseProps,
+    target: document.body,
+  };
+
+  afterEach(cleanup);
+
+  it("should render the `UsageIndicator` component and react to value changes", async () => {
+    const { container, rerender } = render(UsageIndicator, baseOptions);
+
+    expect(getPercentages()).toStrictEqual([45, 55]);
+    expect(container.firstChild).toMatchSnapshot();
+
+    await rerender({ value: 80 });
+
+    expect(getPercentages()).toStrictEqual([80, 20]);
+    expect(container.firstChild).toMatchSnapshot();
+  });
+
+  it("should accept additional class names", () => {
+    const props = { ...baseProps, className: "foo bar" };
+    const { container } = render(UsageIndicator, { ...baseOptions, props });
+
+    expect(container.firstChild).toHaveClass("usage-indicator foo bar");
+  });
+
+  it("should round decimal values at two decimals", async () => {
+    const props = { ...baseProps, value: 45.7687 };
+    const { rerender } = render(UsageIndicator, { ...baseOptions, props });
+
+    expect(getPercentages()).toStrictEqual([45.77, 54.23]);
+
+    await rerender({ value: 0.005 });
+
+    expect(getPercentages()).toStrictEqual([0.01, 99.99]);
+  });
+});
diff --git a/web-wallet/src/lib/components/__tests__/__snapshots__/UsageIndicator.spec.js.snap b/web-wallet/src/lib/components/__tests__/__snapshots__/UsageIndicator.spec.js.snap
new file mode 100644
index 0000000000..414a59a9b8
--- /dev/null
+++ b/web-wallet/src/lib/components/__tests__/__snapshots__/UsageIndicator.spec.js.snap
@@ -0,0 +1,95 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`UsageIndicator > should render the \`UsageIndicator\` component and react to value changes 1`] = `
+<div
+  class="usage-indicator"
+>
+  <svg
+    class="dusk-icon dusk-icon--size--default usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text="You have put 45% of your funds in your shielded account"
+    role="graphics-symbol"
+    viewBox="0 0 24 24"
+  >
+    <path
+      d="M12,1L3,5V11C3,16.55 6.84,21.74 12,23C17.16,21.74 21,16.55 21,11V5L12,1M12,7C13.4,7 14.8,8.1 14.8,9.5V11C15.4,11 16,11.6 16,12.3V15.8C16,16.4 15.4,17 14.7,17H9.2C8.6,17 8,16.4 8,15.7V12.2C8,11.6 8.6,11 9.2,11V9.5C9.2,8.1 10.6,7 12,7M12,8.2C11.2,8.2 10.5,8.7 10.5,9.5V11H13.5V9.5C13.5,8.7 12.8,8.2 12,8.2Z"
+    />
+  </svg>
+  
+   
+  <div
+    aria-valuemax="100"
+    aria-valuemin="0"
+    aria-valuenow="45"
+    aria-valuetext="You have put 45% of your funds in your shielded account"
+    class="usage-indicator__meter"
+    role="meter"
+  >
+    <div
+      aria-hidden="true"
+      class="usage-indicator__meter-bar"
+      style="width: 45%;"
+    />
+  </div>
+   
+  <svg
+    class="dusk-icon dusk-icon--size--default usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text="You have put 55% of your funds in your unshielded account"
+    role="graphics-symbol"
+    viewBox="0 0 24 24"
+  >
+    <path
+      d="M21 11C21 16.5 17.2 21.7 12 23C6.8 21.7 3 16.5 3 11V5L12 1L21 5V11M12 21C15.8 20 19 15.5 19 11.2V6.3L12 3.2L5 6.3V11.2C5 15.5 8.2 20 12 21M14.8 11H10.5V8.5C10.5 7.7 11.2 7.2 12 7.2S13.5 7.7 13.5 8.5V9H14.8V8.5C14.8 7.1 13.4 6 12 6S9.2 7.1 9.2 8.5V11C8.6 11 8 11.6 8 12.2V15.7C8 16.4 8.6 17 9.2 17H14.7C15.4 17 16 16.4 16 15.8V12.3C16 11.6 15.4 11 14.8 11Z"
+    />
+  </svg>
+  
+</div>
+`;
+
+exports[`UsageIndicator > should render the \`UsageIndicator\` component and react to value changes 2`] = `
+<div
+  class="usage-indicator"
+>
+  <svg
+    class="dusk-icon dusk-icon--size--default usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text="You have put 80% of your funds in your shielded account"
+    role="graphics-symbol"
+    viewBox="0 0 24 24"
+  >
+    <path
+      d="M12,1L3,5V11C3,16.55 6.84,21.74 12,23C17.16,21.74 21,16.55 21,11V5L12,1M12,7C13.4,7 14.8,8.1 14.8,9.5V11C15.4,11 16,11.6 16,12.3V15.8C16,16.4 15.4,17 14.7,17H9.2C8.6,17 8,16.4 8,15.7V12.2C8,11.6 8.6,11 9.2,11V9.5C9.2,8.1 10.6,7 12,7M12,8.2C11.2,8.2 10.5,8.7 10.5,9.5V11H13.5V9.5C13.5,8.7 12.8,8.2 12,8.2Z"
+    />
+  </svg>
+  
+   
+  <div
+    aria-valuemax="100"
+    aria-valuemin="0"
+    aria-valuenow="80"
+    aria-valuetext="You have put 80% of your funds in your shielded account"
+    class="usage-indicator__meter"
+    role="meter"
+  >
+    <div
+      aria-hidden="true"
+      class="usage-indicator__meter-bar"
+      style="width: 80%;"
+    />
+  </div>
+   
+  <svg
+    class="dusk-icon dusk-icon--size--default usage-indicator__icon"
+    data-tooltip-id="main-tooltip"
+    data-tooltip-text="You have put 20% of your funds in your unshielded account"
+    role="graphics-symbol"
+    viewBox="0 0 24 24"
+  >
+    <path
+      d="M21 11C21 16.5 17.2 21.7 12 23C6.8 21.7 3 16.5 3 11V5L12 1L21 5V11M12 21C15.8 20 19 15.5 19 11.2V6.3L12 3.2L5 6.3V11.2C5 15.5 8.2 20 12 21M14.8 11H10.5V8.5C10.5 7.7 11.2 7.2 12 7.2S13.5 7.7 13.5 8.5V9H14.8V8.5C14.8 7.1 13.4 6 12 6S9.2 7.1 9.2 8.5V11C8.6 11 8 11.6 8 12.2V15.7C8 16.4 8.6 17 9.2 17H14.7C15.4 17 16 16.4 16 15.8V12.3C16 11.6 15.4 11 14.8 11Z"
+    />
+  </svg>
+  
+</div>
+`;
diff --git a/web-wallet/src/lib/components/index.js b/web-wallet/src/lib/components/index.js
index bcdeb2ddde..8acf0b5a4a 100644
--- a/web-wallet/src/lib/components/index.js
+++ b/web-wallet/src/lib/components/index.js
@@ -15,3 +15,4 @@ export { default as Send } from "./Send/Send.svelte";
 export { default as ScanQR } from "./ScanQR/ScanQR.svelte";
 export { default as Stake } from "./Stake/Stake.svelte";
 export { default as Transactions } from "./Transactions/Transactions.svelte";
+export { default as UsageIndicator } from "./UsageIndicator/UsageIndicator.svelte";
diff --git a/web-wallet/src/routes/components-showcase/+page.svelte b/web-wallet/src/routes/components-showcase/+page.svelte
index b991bf8dcd..719188735c 100644
--- a/web-wallet/src/routes/components-showcase/+page.svelte
+++ b/web-wallet/src/routes/components-showcase/+page.svelte
@@ -18,6 +18,7 @@
   import Throbbers from "./Throbbers.svelte";
   import Toasts from "./Toasts.svelte";
   import Tooltips from "./Tooltips.svelte";
+  import UsageIndicators from "./UsageIndicators.svelte";
   import Wizards from "./Wizards.svelte";
 
   /** @type {Record<string, import("svelte").ComponentType>} */
@@ -37,6 +38,7 @@
     Throbbers: Throbbers,
     Toasts: Toasts,
     Tooltips: Tooltips,
+    "Usage Indicators": UsageIndicators,
     Wizards: Wizards,
   };
 
diff --git a/web-wallet/src/routes/components-showcase/UsageIndicators.svelte b/web-wallet/src/routes/components-showcase/UsageIndicators.svelte
new file mode 100644
index 0000000000..635a089fcb
--- /dev/null
+++ b/web-wallet/src/routes/components-showcase/UsageIndicators.svelte
@@ -0,0 +1,11 @@
+<svelte:options immutable={true} />
+
+<script>
+  import { UsageIndicator } from "$lib/components";
+</script>
+
+<section>
+  <div style="width: 60%">
+    <UsageIndicator value={45} />
+  </div>
+</section>
diff --git a/web-wallet/src/style/dusk/colors.css b/web-wallet/src/style/dusk/colors.css
index 9359f710fe..4d4df38788 100644
--- a/web-wallet/src/style/dusk/colors.css
+++ b/web-wallet/src/style/dusk/colors.css
@@ -23,7 +23,8 @@
 
   /* Status */
 
-  --success: #16db93;
+  --success-500: #16db93;
+  --success-700: #0f9363;
   --warning: #ffcf23;
   --error: #ed254e;
   --info: #71b1ff;
diff --git a/web-wallet/src/style/dusk/language.css b/web-wallet/src/style/dusk/language.css
index 390f98c736..00c49de720 100644
--- a/web-wallet/src/style/dusk/language.css
+++ b/web-wallet/src/style/dusk/language.css
@@ -12,7 +12,8 @@
   --danger-color: var(--error);
   --error-color: var(--error);
   --info-color: var(--info);
-  --success-color: var(--success);
+  --success-color: var(--success-500);
+  --success-color-variant-dark: var(--success-700);
   --warning-color: var(--warning);
 
   --on-background-color: var(--smokey-black);