Add comments

linz · Oct 7, 2024 · ec6f2ac · ec6f2ac
1 parent a8a0e35
commit ec6f2ac
Showing 1 changed file with 28 additions and 19 deletions.
diff --git a/packages/landing/src/components/feature.updates.tsx b/packages/landing/src/components/feature.updates.tsx
@@ -27,10 +27,16 @@ type FeatureUpdatesState = {
   showModal: boolean;
 };
 
+/**
+ * FeatureUpdates is a re-implementation of @linzjs/lui -> LuiUpdatesSplashModal module,
+ * This use to enable a one off pop up screen for introduce new feature of the recent release.
+ *
+ */
 export class FeatureUpdates extends Component<FeatureUpdatesProps, FeatureUpdatesState> {
   constructor(props: FeatureUpdatesProps) {
     super(props);
     const currentVersion = window.localStorage.getItem(this.props.id);
+
     this.state = {
       showModal: this.props.enabled && this.props.releaseVersion.trim() !== currentVersion,
     };
@@ -85,25 +91,6 @@ export class FeatureUpdates extends Component<FeatureUpdatesProps, FeatureUpdate
     );
   }
 
-  WhatsNewIcon(): ReactNode {
-    return (
-      <span
-        className={'LuiIcon LuiIcon--md lui-feature-title-icon '}
-        data-icon={'ic_whats_new_updates'}
-        aria-label={'whats_new_icon'}
-      >
-        <img src="assets/whats_new_updates.svg" alt="whats_new_icon" className="LuiIcon__image" />
-      </span>
-    );
-  }
-  ClearIcon(): ReactNode {
-    return (
-      <span className="LuiIcon LuiIcon--md LuiIcon--interactive" data-icon="ic_clear" aria-label="cross_icon">
-        <img src="/assets/clear.svg" alt="cross_icon" />
-      </span>
-    );
-  }
-
   FeatureImages(bigImage: string, smallImage: string): ReactNode {
     return (
       <div className="lui-feature-img">
@@ -128,4 +115,26 @@ export class FeatureUpdates extends Component<FeatureUpdatesProps, FeatureUpdate
       </div>
     );
   }
+
+  // @linzjs/lui whats_new_icon re-implementation
+  WhatsNewIcon(): ReactNode {
+    return (
+      <span
+        className={'LuiIcon LuiIcon--md lui-feature-title-icon '}
+        data-icon={'ic_whats_new_updates'}
+        aria-label={'whats_new_icon'}
+      >
+        <img src="assets/whats_new_updates.svg" alt="whats_new_icon" className="LuiIcon__image" />
+      </span>
+    );
+  }
+
+  // @linzjs/lui cross_icon re-implementation
+  ClearIcon(): ReactNode {
+    return (
+      <span className="LuiIcon LuiIcon--md LuiIcon--interactive" data-icon="ic_clear" aria-label="cross_icon">
+        <img src="/assets/clear.svg" alt="cross_icon" />
+      </span>
+    );
+  }
 }