Merge pull request #25 from PunitSoniME/feat/23-add-since-version

feat(documentation): hook available since added
PunitSoniME · Jul 31, 2024 · 7f848c6 · 7f848c6
2 parents b0c45d6 + 7d618d6
commit 7f848c6
Show file tree

Hide file tree

Showing 57 changed files with 121 additions and 14 deletions.
diff --git a/example/src/common/Documentation.tsx b/example/src/common/Documentation.tsx
@@ -4,13 +4,20 @@ import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs';
 const Title = lazy(() => import('@/common/Details/Title'));
 const CodeSample = lazy(() => import('@/common/CodeSample'));
 
-export default function Documentation({ hook, info, usage, children }: any) {
+export default function Documentation({ hook, info, usage, version, children }: any) {
     const [activeTab, setActiveTab] = useState('docs');
 
     return (
         <>
             <Suspense fallback={<></>}>
-                <Title>{hook}</Title>
+                <div className='flex items-center gap-3'>
+                    <Title>{hook}</Title>
+                    {
+                        version
+                            ? <code className='text-primary text-sm'>since v{version}</code>
+                            : ""
+                    }
+                </div>
             </Suspense>
 
             <Suspense fallback={<>Loading Code Block</>}>

diff --git a/example/src/hooks/useArray/index.tsx b/example/src/hooks/useArray/index.tsx
@@ -2,7 +2,6 @@ import { lazy, Suspense } from 'react';
 import { packageName } from '@/lib/utils';
 import Demo from './Demo';
 
-
 const Documentation = lazy(() => import('@/common/Documentation'));
 
 const hook = 'useArray';
@@ -35,10 +34,9 @@ export default function ArrayComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
-
                 <Demo />
-
             </Documentation>
         </Suspense>
     )

diff --git a/example/src/hooks/useAsync/index.tsx b/example/src/hooks/useAsync/index.tsx
@@ -31,6 +31,7 @@ export default function AsyncComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.1.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useAsyncLoop/index.tsx b/example/src/hooks/useAsyncLoop/index.tsx
@@ -24,16 +24,15 @@ const { loading, value, error } = ${hook}(CALLBACK_FUNCTION, [DEPENDENCIES]);
 
 export default function AsyncLoopComponent() {
 
-
     return (
         <Suspense fallback={<></>}>
 
             <Documentation
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.0"
             >
-
                 <Demo />
             </Documentation>
 

diff --git a/example/src/hooks/useClickOutside/index.tsx b/example/src/hooks/useClickOutside/index.tsx
@@ -18,14 +18,14 @@ const ref = ${hook}(CALLBACK_FUNCTION);
 
 export default function ClickOutsideComponent() {
 
-
     return (
         <Suspense fallback={<></>}>
 
             <Documentation
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.12.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useColorBlend/index.tsx b/example/src/hooks/useColorBlend/index.tsx
@@ -29,6 +29,7 @@ export default function ColorBlendComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.6.0"
             >
 
                 <Demo />

diff --git a/example/src/hooks/useColorScheme/index.tsx b/example/src/hooks/useColorScheme/index.tsx
@@ -17,14 +17,14 @@ const colorScheme = ${hook}();
 
 export default function ColorSchemeComponent() {
 
-
     return (
         <Suspense fallback={<></>}>
 
             <Documentation
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.12.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useCopyToClipboard/index.tsx b/example/src/hooks/useCopyToClipboard/index.tsx
@@ -26,6 +26,7 @@ export default function CopyToClipboardComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.0"
             >
                 <Demo />
 

diff --git a/example/src/hooks/useDebounce/index.tsx b/example/src/hooks/useDebounce/index.tsx
@@ -27,6 +27,7 @@ export default function UseDebounceComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useEventListener/index.tsx b/example/src/hooks/useEventListener/index.tsx
@@ -26,6 +26,7 @@ export default function EventListenerComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.2.0"
             >
                 <Demo />
 

diff --git a/example/src/hooks/useFetch/index.tsx b/example/src/hooks/useFetch/index.tsx
@@ -32,6 +32,7 @@ export default function FetchComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.2.0"
             >
 
                 <Demo />

diff --git a/example/src/hooks/useGeolocation/index.tsx b/example/src/hooks/useGeolocation/index.tsx
@@ -29,9 +29,9 @@ export default function GeoLocationComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.0"
             >
                 <Demo />
-
             </Documentation>
 
         </Suspense>

diff --git a/example/src/hooks/useGroupByFirstLetter/index.tsx b/example/src/hooks/useGroupByFirstLetter/index.tsx
@@ -25,6 +25,7 @@ export default function GroupByFirstLetterComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.6.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useHash/index.tsx b/example/src/hooks/useHash/index.tsx
@@ -26,6 +26,7 @@ export default function HashComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.10.1"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useIsAppOffline/index.tsx b/example/src/hooks/useIsAppOffline/index.tsx
@@ -24,6 +24,7 @@ export default function IsAppOfflineComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.2.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/usePrevious/index.tsx b/example/src/hooks/usePrevious/index.tsx
@@ -28,6 +28,7 @@ export default function PreviousComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useProvidersTree/index.tsx b/example/src/hooks/useProvidersTree/index.tsx
@@ -32,6 +32,7 @@ export default function ProvidersTreeComponent() {
                     hook={hook}
                     info={info}
                     usage={usage}
+                    version="1.11.0"
                 >
                     <Demo />
                 </Documentation>

diff --git a/example/src/hooks/useScript/index.tsx b/example/src/hooks/useScript/index.tsx
@@ -29,6 +29,7 @@ export default function ScriptComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.2.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useScrollToTop/index.tsx b/example/src/hooks/useScrollToTop/index.tsx
@@ -25,6 +25,7 @@ export default function ScrollToTopComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.7.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useSpeech/index.tsx b/example/src/hooks/useSpeech/index.tsx
@@ -30,6 +30,7 @@ export default function SpeechComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.10.1"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useStateJson/index.tsx b/example/src/hooks/useStateJson/index.tsx
@@ -31,6 +31,7 @@ export default function StateJsonComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.5"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useStateWithHistory/index.tsx b/example/src/hooks/useStateWithHistory/index.tsx
@@ -30,6 +30,7 @@ export default function StateWithHistoryComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useStorage/index.tsx b/example/src/hooks/useStorage/index.tsx
@@ -35,6 +35,7 @@ export default function StorageComponent() {
                 hook={`${sessionStorageHook}, ${localStorageHook}`}
                 info={info}
                 usage={usage}
+                version="1.0.7"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useSubdomain/index.tsx b/example/src/hooks/useSubdomain/index.tsx
@@ -25,6 +25,7 @@ export default function SubdomainComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.3"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useTimeout/index.tsx b/example/src/hooks/useTimeout/index.tsx
@@ -31,6 +31,7 @@ export default function TimeoutComponent({ defaultTimeout }: any) {
                     hook={hook}
                     info={info}
                     usage={usage}
+                    version="1.0.0"
                 >
                     <Demo defaultTimeout={defaultTimeout} />
                 </Documentation>

diff --git a/example/src/hooks/useToggle/index.tsx b/example/src/hooks/useToggle/index.tsx
@@ -29,6 +29,7 @@ export default function ToggleComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useUpdateEffect/index.tsx b/example/src/hooks/useUpdateEffect/index.tsx
@@ -26,6 +26,7 @@ export default function UpdateEffectComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.0.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useWindowDimensions/index.tsx b/example/src/hooks/useWindowDimensions/index.tsx
@@ -32,6 +32,7 @@ export default function WindowDimensionsComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.3.0"
             >
                 <Demo />
             </Documentation>

diff --git a/example/src/hooks/useWindowFocus/index.tsx b/example/src/hooks/useWindowFocus/index.tsx
@@ -25,6 +25,7 @@ export default function WindowFocusComponent() {
                 hook={hook}
                 info={info}
                 usage={usage}
+                version="1.5.0"
             >
                 <Demo />
             </Documentation>

diff --git a/src/useArray/index.tsx b/src/useArray/index.tsx
@@ -1,5 +1,8 @@
 import { useState } from 'react';
 
+/**
+ * @since 1.0.0
+ */
 export default function useArray<T>(defaultValue: T[]) {
   const [array, setArray] = useState(defaultValue);
 

diff --git a/src/useAsync/index.tsx b/src/useAsync/index.tsx
@@ -1,5 +1,8 @@
 import { useEffect, useCallback, useState } from 'react';
 
+/**
+ * @since 1.1.0
+ */
 export default function useAsync(callback: Function, dependencies: any = []) {
   const [loading, setLoading] = useState(true);
   const [error, setError] = useState();

diff --git a/src/useAsyncLoop/index.tsx b/src/useAsyncLoop/index.tsx
@@ -1,3 +1,6 @@
+/**
+ * @since 1.5.0
+ */
 export default function useAsyncLoop() {
   const executeLoop = async (data: any[], func: Function) => {
     await Promise.all(

diff --git a/src/useClickOutside/index.tsx b/src/useClickOutside/index.tsx
@@ -2,6 +2,9 @@ import { useEffect, useRef } from 'react';
 
 const DEFAULT_EVENTS = ['mouseup', 'touchend'];
 
+/**
+ * @since 1.12.0
+ */
 export default function useClickOutside(
   callback: Function,
   events?: string[] | null | undefined

diff --git a/src/useColorBlend/index.tsx b/src/useColorBlend/index.tsx
@@ -1,6 +1,5 @@
-/*
- * rgbA, rebB - Array of integer or string values
- * Values must be between 0 to 255
+/**
+ * @since 1.6.0
  */
 export default function useColorBlend(rgbA: number[], rgbB: number[]) {
   const colorChannelMixer = (colorA: number, colorB: number) => {

diff --git a/src/useColorScheme/index.tsx b/src/useColorScheme/index.tsx
@@ -1,5 +1,8 @@
 import { useEffect, useState } from 'react';
 
+/**
+ * @since 1.12.0
+ */
 export default function useColorScheme() {
   const isDarkMode =
     window.matchMedia &&

diff --git a/src/useCopyToClipboard/index.tsx b/src/useCopyToClipboard/index.tsx
@@ -1,4 +1,7 @@
 /*  eslint-disable */
+/**
+ * @since 1.5.0
+ */
 export default function useCopyToClipboard() {
   const copyToClipboard = async (textToCopy: string) => {
     return new Promise(async (resolve, reject) => {

diff --git a/src/useDebounce/index.tsx b/src/useDebounce/index.tsx
@@ -1,6 +1,9 @@
 import { useEffect } from 'react';
 import useTimeout from '../useTimeout';
 
+/**
+ * @since 1.5.0
+ */
 export default function useDebounce(
   callback: Function,
   delay: number,

diff --git a/src/useEventListener/index.tsx b/src/useEventListener/index.tsx
@@ -1,5 +1,8 @@
 import { useEffect, useRef } from 'react';
 
+/**
+ * @since 1.2.0
+ */
 export default function useEventListener(
   eventType: any,
   callback: Function,

diff --git a/src/useFetch/index.tsx b/src/useFetch/index.tsx
@@ -4,6 +4,9 @@ const DEFAULT_OPTIONS = {
   headers: { 'Content-Type': 'application/json' },
 };
 
+/**
+ * @since 1.2.0
+ */
 export default function useFetch(
   url: string,
   options = {},

diff --git a/src/useGeolocation/index.tsx b/src/useGeolocation/index.tsx
@@ -1,5 +1,8 @@
 import { useEffect, useState } from 'react';
 
+/**
+ * @since 1.5.0
+ */
 export default function useGeolocation(options: PositionOptions = {}) {
   const [loading, setLoading] = useState(true);
   const [error, setError] = useState<any>();

diff --git a/src/useGroupByFirstLetter/index.tsx b/src/useGroupByFirstLetter/index.tsx
@@ -1,3 +1,6 @@
+/**
+ * @since 1.6.0
+ */
 export default function useGroupByFirstLetter() {
   const groupByFirstLetter = (data: any[], propertyName: any) => {
     const groupByData = data.reduce((r, e) => {