Add comments for example of hook

synapsecns · Mar 15, 2024 · 7ad2a5c · 7ad2a5c
1 parent 6ade432
commit 7ad2a5c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/synapse-interface/components/Maintenance/Events/example/EcotoneForkUpgrade.tsx b/packages/synapse-interface/components/Maintenance/Events/example/EcotoneForkUpgrade.tsx
@@ -76,12 +76,19 @@ export const EcotoneForkWarningMessage = () => {
 
 /**
  * Example of how to use hook:
+ * import { useEcotoneForkCountdownProgress } = '@/components/Maintenance/Events/EcotoneForkUpgrade'
  *
  * const {
     isEcotoneForkUpgradePending,
     isCurrentChainDisabled: isEcotoneUpgradeChainsDisabled,
     EcotoneForkCountdownProgressBar,
   } = useEcotoneForkCountdownProgress()
+
+  In JSX, render the component:
+
+    <div>
+      {EcotoneForkCountdownProgressBar}
+    </div>
  */
 export const useEcotoneForkCountdownProgress = () => {
   const { fromChainId, toChainId } = useBridgeState()