From f5b1ef5a87b9b148562d316430c7fbed74ea1573 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 5 Mar 2024 12:36:33 +0000 Subject: [PATCH] deploy: c804851f13e99f0088d62154e5d9b4def6e07c86 --- 404.html | 2 +- ...16459.d0489dc0.js => 2ba16459.812feaeb.js} | 2 +- ...ba500.42e7a868.js => 479ba500.82a55cca.js} | 2 +- ...c1546.4214ab45.js => 6acc1546.cff3540f.js} | 2 +- ...n.2c404d24.js => runtime~main.cb0d5eec.js} | 2 +- docs.html | 2 +- docs/core.html | 2 +- docs/core/modules.html | 16 +++++------ docs/eslint-config.html | 2 +- docs/react.html | 2 +- docs/react/modules.html | 2 +- docs/react/modules/components.html | 8 +++--- docs/react/modules/hooks.html | 28 +++++++++---------- docs/stylelint-config.html | 2 +- index.html | 2 +- 15 files changed, 38 insertions(+), 38 deletions(-) rename assets/js/{2ba16459.d0489dc0.js => 2ba16459.812feaeb.js} (97%) rename assets/js/{479ba500.42e7a868.js => 479ba500.82a55cca.js} (94%) rename assets/js/{6acc1546.4214ab45.js => 6acc1546.cff3540f.js} (96%) rename assets/js/{runtime~main.2c404d24.js => runtime~main.cb0d5eec.js} (95%) diff --git a/404.html b/404.html index 5a6ae8a..87da145 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ 페이지를 찾을 수 없습니다. | @nf-team/frontend-libraries - + diff --git a/assets/js/2ba16459.d0489dc0.js b/assets/js/2ba16459.812feaeb.js similarity index 97% rename from assets/js/2ba16459.d0489dc0.js rename to assets/js/2ba16459.812feaeb.js index ec67f61..53c5795 100644 --- a/assets/js/2ba16459.d0489dc0.js +++ b/assets/js/2ba16459.812feaeb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{5026:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>o});var l=t(2322),r=t(5392);const s={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"react/modules/components",title:"Module: components",description:"Functions",source:"@site/docs/react/modules/components.md",sourceDirName:"react/modules",slug:"/react/modules/components",permalink:"/frontend-libraries/docs/react/modules/components",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/react/modules"},next:{title:"hooks",permalink:"/frontend-libraries/docs/react/modules/hooks"}},c={},o=[{value:"Functions",id:"functions",level:2},{value:"ClientOnly",id:"clientonly",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"DelayRenderComponent",id:"delayrendercomponent",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"GlobalPortal",id:"globalportal",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"clientonly",children:"ClientOnly"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"ClientOnly"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Object"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,l.jsx)(n.code,{children:"children?"})]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"ReactNode"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\uc5ec mount\uac00 \ub41c \uacbd\uc6b0, Component\ub97c render\ud574\uc90d\ub2c8\ub2e4.\nmount\ub418\uc9c0 \uc54a\uc740 \uacbd\uc6b0\uc5d0\ub294 Component\ub97c render\ud574\uc8fc\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0\ub9cc \ud574\ub2f9 Component\ub97c \ubcf4\uc5ec\uc8fc\uace0 \uc2f6\uc744\ub54c \uc0ac\uc6a9\ud569\ub2c8\ub2e4.\n(SSR \ud658\uacbd\uc5d0\uc11c Hydration \uc624\ub958\ub85c \uc778\ud574\uc11c \uc5d0\ub7ec\uac00 \ubc1c\uc0dd\ud558\ub294 \ubb38\uc81c\ub97c \ud574\uacb0\ud569\ub2c8\ub2e4.)"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/components/ClientOnly.tsx#L22",children:"packages/react/src/components/ClientOnly.tsx:22"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"delayrendercomponent",children:"DelayRenderComponent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"DelayRenderComponent"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/components/DelayRenderComponent.tsx#L12",children:"packages/react/src/components/DelayRenderComponent.tsx:12"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"globalportal",children:"GlobalPortal"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"GlobalPortal"}),"(",(0,l.jsx)(n.code,{children:"elementId"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"elementId"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc758 DOM \uc678\ubd80\uc5d0 \uc874\uc7ac\ud558\ub294 DOM \ub178\ub4dc\uc5d0 \ub80c\ub354\ub9c1 \ud560 \uc218 \uc788\uac8c \ud574\uc8fc\ub294\n",(0,l.jsx)(n.code,{children:"ReactDOM.createPortal"}),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,l.jsx)(n.code,{children:"overflow: hidden"}),", ",(0,l.jsx)(n.code,{children:"z-index"}),"\uc640 \uac19\uc740 \uc2a4\ud0c0\uc77c\uc774 \uc788\uc744 \ub54c \ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uc5d0 \uc758\uc874\uc801\uc774\uc9c0 \uc54a\uc544\uc57c\ud558\ub294 \uacbd\uc6b0 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-html",metastring:'title="html"',children:'
\n'})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",metastring:'title="tsx"',children:'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n'})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/components/GlobalPortal.tsx#L34",children:"packages/react/src/components/GlobalPortal.tsx:34"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},5392:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>d});var l=t(2784);const r={},s=l.createContext(r);function d(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{5026:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>o});var l=t(2322),r=t(5392);const s={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"react/modules/components",title:"Module: components",description:"Functions",source:"@site/docs/react/modules/components.md",sourceDirName:"react/modules",slug:"/react/modules/components",permalink:"/frontend-libraries/docs/react/modules/components",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/react/modules"},next:{title:"hooks",permalink:"/frontend-libraries/docs/react/modules/hooks"}},c={},o=[{value:"Functions",id:"functions",level:2},{value:"ClientOnly",id:"clientonly",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"DelayRenderComponent",id:"delayrendercomponent",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"GlobalPortal",id:"globalportal",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"clientonly",children:"ClientOnly"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"ClientOnly"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Object"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,l.jsx)(n.code,{children:"children?"})]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"ReactNode"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\uc5ec mount\uac00 \ub41c \uacbd\uc6b0, Component\ub97c render\ud574\uc90d\ub2c8\ub2e4.\nmount\ub418\uc9c0 \uc54a\uc740 \uacbd\uc6b0\uc5d0\ub294 Component\ub97c render\ud574\uc8fc\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0\ub9cc \ud574\ub2f9 Component\ub97c \ubcf4\uc5ec\uc8fc\uace0 \uc2f6\uc744\ub54c \uc0ac\uc6a9\ud569\ub2c8\ub2e4.\n(SSR \ud658\uacbd\uc5d0\uc11c Hydration \uc624\ub958\ub85c \uc778\ud574\uc11c \uc5d0\ub7ec\uac00 \ubc1c\uc0dd\ud558\ub294 \ubb38\uc81c\ub97c \ud574\uacb0\ud569\ub2c8\ub2e4.)"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/components/ClientOnly.tsx#L22",children:"packages/react/src/components/ClientOnly.tsx:22"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"delayrendercomponent",children:"DelayRenderComponent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"DelayRenderComponent"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/components/DelayRenderComponent.tsx#L12",children:"packages/react/src/components/DelayRenderComponent.tsx:12"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"globalportal",children:"GlobalPortal"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"GlobalPortal"}),"(",(0,l.jsx)(n.code,{children:"elementId"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"elementId"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc758 DOM \uc678\ubd80\uc5d0 \uc874\uc7ac\ud558\ub294 DOM \ub178\ub4dc\uc5d0 \ub80c\ub354\ub9c1 \ud560 \uc218 \uc788\uac8c \ud574\uc8fc\ub294\n",(0,l.jsx)(n.code,{children:"ReactDOM.createPortal"}),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,l.jsx)(n.code,{children:"overflow: hidden"}),", ",(0,l.jsx)(n.code,{children:"z-index"}),"\uc640 \uac19\uc740 \uc2a4\ud0c0\uc77c\uc774 \uc788\uc744 \ub54c \ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uc5d0 \uc758\uc874\uc801\uc774\uc9c0 \uc54a\uc544\uc57c\ud558\ub294 \uacbd\uc6b0 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-html",metastring:'title="html"',children:'
\n'})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",metastring:'title="tsx"',children:'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n'})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/components/GlobalPortal.tsx#L34",children:"packages/react/src/components/GlobalPortal.tsx:34"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},5392:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>d});var l=t(2784);const r={},s=l.createContext(r);function d(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/479ba500.42e7a868.js b/assets/js/479ba500.82a55cca.js similarity index 94% rename from assets/js/479ba500.42e7a868.js rename to assets/js/479ba500.82a55cca.js index a05ac55..e655bbf 100644 --- a/assets/js/479ba500.42e7a868.js +++ b/assets/js/479ba500.82a55cca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{1944:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var r=l(2322),s=l(5392);const t={id:"modules",title:"@nf-team/core - v2.0.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"core/modules",title:"@nf-team/core - v2.0.2",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.0.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/core/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/react/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"checkEmpty",id:"checkempty",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"checkNumber",id:"checknumber",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"emptyAThenB",id:"emptyathenb",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"generateArrayOfNumber",id:"generatearrayofnumber",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isEmpty",id:"isempty",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"removeNullable",id:"removenullable",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"trueOrFalse",id:"trueorfalse",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"checkempty",children:"checkEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L44",children:"utils.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"checknumber",children:"checkNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkNumber"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"number"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L26",children:"utils.ts:26"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"emptyathenb",children:"emptyAThenB"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"emptyAThenB"}),"(",(0,r.jsx)(n.code,{children:"b"}),", ",(0,r.jsx)(n.code,{children:"a?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"b"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"a?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L34",children:"utils.ts:34"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generatearrayofnumber",children:"generateArrayOfNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"generateArrayOfNumber"}),"(",(0,r.jsx)(n.code,{children:"length"}),"): ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"length"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"number"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L64",children:"utils.ts:64"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isempty",children:"isEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"isEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L52",children:"utils.ts:52"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removenullable",children:"removeNullable"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"removeNullable"}),"(",(0,r.jsx)(n.code,{children:"value?"}),", ",(0,r.jsx)(n.code,{children:"replacementValue?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"undefined"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"replacementValue?"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.jsx)(n.code,{children:"null"})," \ub610\ub294 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Description"})})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"null"}),"\uc774\ub098 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \ube48\ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud558\uac70\ub098 \uc0c8\ub85c\uc6b4 \ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud569\ub2c8\ub2e4. (\uc624\ub85c\uc9c0 ",(0,r.jsx)(n.code,{children:"string"})," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"console.log(result); // 'newValue';\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L14",children:"utils.ts:14"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"trueorfalse",children:"trueOrFalse"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"trueOrFalse"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"boolean"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/core/src/utils.ts#L36",children:"utils.ts:36"})})]})}function x(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},5392:(e,n,l)=>{l.d(n,{Z:()=>d,a:()=>i});var r=l(2784);const s={},t=r.createContext(s);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{1944:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var r=l(2322),s=l(5392);const t={id:"modules",title:"@nf-team/core - v2.0.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"core/modules",title:"@nf-team/core - v2.0.2",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.0.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/core/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/react/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"checkEmpty",id:"checkempty",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"checkNumber",id:"checknumber",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"emptyAThenB",id:"emptyathenb",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"generateArrayOfNumber",id:"generatearrayofnumber",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isEmpty",id:"isempty",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"removeNullable",id:"removenullable",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"trueOrFalse",id:"trueorfalse",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function x(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"checkempty",children:"checkEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L44",children:"utils.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"checknumber",children:"checkNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkNumber"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"number"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L26",children:"utils.ts:26"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"emptyathenb",children:"emptyAThenB"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"emptyAThenB"}),"(",(0,r.jsx)(n.code,{children:"b"}),", ",(0,r.jsx)(n.code,{children:"a?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"b"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"a?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L34",children:"utils.ts:34"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generatearrayofnumber",children:"generateArrayOfNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"generateArrayOfNumber"}),"(",(0,r.jsx)(n.code,{children:"length"}),"): ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"length"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"number"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L64",children:"utils.ts:64"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isempty",children:"isEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"isEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L52",children:"utils.ts:52"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removenullable",children:"removeNullable"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"removeNullable"}),"(",(0,r.jsx)(n.code,{children:"value?"}),", ",(0,r.jsx)(n.code,{children:"replacementValue?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"undefined"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"replacementValue?"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.jsx)(n.code,{children:"null"})," \ub610\ub294 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Description"})})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"null"}),"\uc774\ub098 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \ube48\ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud558\uac70\ub098 \uc0c8\ub85c\uc6b4 \ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud569\ub2c8\ub2e4. (\uc624\ub85c\uc9c0 ",(0,r.jsx)(n.code,{children:"string"})," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"console.log(result); // 'newValue';\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L14",children:"utils.ts:14"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"trueorfalse",children:"trueOrFalse"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"trueOrFalse"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"boolean"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/core/src/utils.ts#L36",children:"utils.ts:36"})})]})}function a(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}},5392:(e,n,l)=>{l.d(n,{Z:()=>d,a:()=>i});var r=l(2784);const s={},t=r.createContext(s);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6acc1546.4214ab45.js b/assets/js/6acc1546.cff3540f.js similarity index 96% rename from assets/js/6acc1546.4214ab45.js rename to assets/js/6acc1546.cff3540f.js index 7db71f8..e5ff760 100644 --- a/assets/js/6acc1546.4214ab45.js +++ b/assets/js/6acc1546.cff3540f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{7710:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>d,metadata:()=>r,toc:()=>h});var l=s(2322),t=s(5392);const d={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,r={id:"react/modules/hooks",title:"Module: hooks",description:"Functions",source:"@site/docs/react/modules/hooks.md",sourceDirName:"react/modules",slug:"/react/modules/hooks",permalink:"/frontend-libraries/docs/react/modules/hooks",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"},next:{title:"@nf-team/eslint-config",permalink:"/frontend-libraries/docs/eslint-config/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"useActionKeyEvent",id:"useactionkeyevent",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"useBoolean",id:"useboolean",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useDebounce",id:"usedebounce",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useEffectOnce",id:"useeffectonce",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useGeolocation",id:"usegeolocation",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useThrottleCallback",id:"usethrottlecallback",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-10",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"useactionkeyevent",children:"useActionKeyEvent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"targetKeys"}),", ",(0,l.jsx)(n.code,{children:"callback?"}),"): ",(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Element"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetKeys"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"string"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback?"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,l.jsx)(n.code,{children:"event"}),": ",(0,l.jsx)(n.code,{children:"KeyboardEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),">, ...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useActionKeyEvent.ts#L6",children:"packages/react/src/hooks/useActionKeyEvent.ts:6"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useboolean",children:"useBoolean"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useBoolean"}),"(",(0,l.jsx)(n.code,{children:"initialValue?"}),"): [",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"initialValue"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"boolean"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"false"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ucd08\uae30\uac12\uc744 \uc138\ud305"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"boolean"})," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,l.jsx)(n.code,{children:"useState"}),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useBoolean.ts#L13",children:"packages/react/src/hooks/useBoolean.ts:13"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usedebounce",children:"useDebounce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useDebounce"}),"<",(0,l.jsx)(n.code,{children:"T"}),">(",(0,l.jsx)(n.code,{children:"value"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"T"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(n.tbody,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"value"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useDebounce.ts#L3",children:"packages/react/src/hooks/useDebounce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useeffectonce",children:"useEffectOnce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useEffectOnce"}),"(",(0,l.jsx)(n.code,{children:"effect"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useEffectOnce.ts#L3",children:"packages/react/src/hooks/useEffectOnce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usegeolocation",children:"useGeolocation"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useGeolocation"}),"(): [",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useGeolocation.ts#L15",children:"packages/react/src/hooks/useGeolocation.ts:15"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisfirstrender",children:"useIsFirstRender"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsFirstRender"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useIsFirstRender.ts#L3",children:"packages/react/src/hooks/useIsFirstRender.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useismounted",children:"useIsMounted"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsMounted"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0 \uc5b4\ub5a4 \ub3d9\uc791\uc744 \uc2e4\ud589\ud558\uae30 \uc704\ud574\uc11c \uc0ac\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useIsMounted.ts#L18",children:"packages/react/src/hooks/useIsMounted.ts:18"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisomorphiclayouteffect",children:"useIsomorphicLayoutEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsomorphicLayoutEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.p,{children:"Accepts a function that contains imperative, possibly effectful code."}),"\n",(0,l.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"Imperative function that can return a cleanup function"})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"If present, effect will only activate if the values in the list change."})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Version"})})}),"\n",(0,l.jsx)(n.p,{children:"16.8.0"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"See"})})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://react.dev/reference/react/useEffect",children:"https://react.dev/reference/react/useEffect"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:"node_modules/@types/react/index.d.ts:1095"}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"uselessthenscrolly",children:"useLessThenScrollY"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useLessThenScrollY"}),"(",(0,l.jsx)(n.code,{children:"targetScrollY?"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetScrollY"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"0"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"200"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useLessThenScrollY.ts#L5",children:"packages/react/src/hooks/useLessThenScrollY.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useresizeviewportheight",children:"useResizeViewportHeight"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useResizeViewportHeight"}),"(): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\uc2a4\ud06c\ub864\uc744 \ud3ec\ud568\ud55c window\uc758 \ub192\uc774\ub97c \uac00\uc838\uc640 window \ud06c\uae30\ub97c resize\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\ubaa8\ubc14\uc77c \ud658\uacbd\uc758 \uc6f9\ubdf0\uc5d0\uc11c \ub514\ubc14\uc774\uc2a4 \ubc0f \ube0c\ub77c\uc6b0\uc800 \ud658\uacbd\uc5d0 \ub530\ub77c \ud06c\uae30\uac00 \ub2ec\ub77c\uc838 \ubd88\ud544\uc694\ud55c \uc2a4\ud06c\ub864\uc774 \uc0dd\uae38 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc774\ub54c \uc774 hook\uc744 \uc0ac\uc6a9\ud558\uba74 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useResizeViewportHeight.ts#L17",children:"packages/react/src/hooks/useResizeViewportHeight.ts:17"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usethrottlecallback",children:"useThrottleCallback"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useThrottleCallback"}),"<",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"dependencyList"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): (...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"dependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"fn"})}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 (",(0,l.jsx)(n.code,{children:"...args"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"...args"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})})]})})]}),"\n",(0,l.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useThrottleCallback.ts#L3",children:"packages/react/src/hooks/useThrottleCallback.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usetimeout",children:"useTimeout"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useTimeout"}),"(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"number"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useTimeout.ts#L5",children:"packages/react/src/hooks/useTimeout.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useunmount",children:"useUnmount"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUnmount"}),"(",(0,l.jsx)(n.code,{children:"fn"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"fn"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useUnmount.ts#L5",children:"packages/react/src/hooks/useUnmount.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useupdateeffect",children:"useUpdateEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUpdateEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/7255da2/packages/react/src/hooks/useUpdateEffect.ts#L5",children:"packages/react/src/hooks/useUpdateEffect.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},5392:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var l=s(2784);const t={},d=l.createContext(t);function i(e){const n=l.useContext(d);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),l.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{7710:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>d,metadata:()=>r,toc:()=>h});var l=s(2322),t=s(5392);const d={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,r={id:"react/modules/hooks",title:"Module: hooks",description:"Functions",source:"@site/docs/react/modules/hooks.md",sourceDirName:"react/modules",slug:"/react/modules/hooks",permalink:"/frontend-libraries/docs/react/modules/hooks",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"},next:{title:"@nf-team/eslint-config",permalink:"/frontend-libraries/docs/eslint-config/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"useActionKeyEvent",id:"useactionkeyevent",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"useBoolean",id:"useboolean",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useDebounce",id:"usedebounce",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useEffectOnce",id:"useeffectonce",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useGeolocation",id:"usegeolocation",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useThrottleCallback",id:"usethrottlecallback",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-10",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"useactionkeyevent",children:"useActionKeyEvent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"targetKeys"}),", ",(0,l.jsx)(n.code,{children:"callback?"}),"): ",(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Element"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetKeys"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"string"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback?"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,l.jsx)(n.code,{children:"event"}),": ",(0,l.jsx)(n.code,{children:"KeyboardEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),">, ...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useActionKeyEvent.ts#L6",children:"packages/react/src/hooks/useActionKeyEvent.ts:6"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useboolean",children:"useBoolean"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useBoolean"}),"(",(0,l.jsx)(n.code,{children:"initialValue?"}),"): [",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"initialValue"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"boolean"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"false"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ucd08\uae30\uac12\uc744 \uc138\ud305"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"boolean"})," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,l.jsx)(n.code,{children:"useState"}),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useBoolean.ts#L13",children:"packages/react/src/hooks/useBoolean.ts:13"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usedebounce",children:"useDebounce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useDebounce"}),"<",(0,l.jsx)(n.code,{children:"T"}),">(",(0,l.jsx)(n.code,{children:"value"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"T"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(n.tbody,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"value"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useDebounce.ts#L3",children:"packages/react/src/hooks/useDebounce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useeffectonce",children:"useEffectOnce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useEffectOnce"}),"(",(0,l.jsx)(n.code,{children:"effect"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useEffectOnce.ts#L3",children:"packages/react/src/hooks/useEffectOnce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usegeolocation",children:"useGeolocation"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useGeolocation"}),"(): [",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useGeolocation.ts#L15",children:"packages/react/src/hooks/useGeolocation.ts:15"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisfirstrender",children:"useIsFirstRender"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsFirstRender"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useIsFirstRender.ts#L3",children:"packages/react/src/hooks/useIsFirstRender.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useismounted",children:"useIsMounted"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsMounted"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0 \uc5b4\ub5a4 \ub3d9\uc791\uc744 \uc2e4\ud589\ud558\uae30 \uc704\ud574\uc11c \uc0ac\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useIsMounted.ts#L18",children:"packages/react/src/hooks/useIsMounted.ts:18"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisomorphiclayouteffect",children:"useIsomorphicLayoutEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsomorphicLayoutEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.p,{children:"Accepts a function that contains imperative, possibly effectful code."}),"\n",(0,l.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"Imperative function that can return a cleanup function"})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"If present, effect will only activate if the values in the list change."})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Version"})})}),"\n",(0,l.jsx)(n.p,{children:"16.8.0"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"See"})})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://react.dev/reference/react/useEffect",children:"https://react.dev/reference/react/useEffect"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:"node_modules/@types/react/index.d.ts:1095"}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"uselessthenscrolly",children:"useLessThenScrollY"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useLessThenScrollY"}),"(",(0,l.jsx)(n.code,{children:"targetScrollY?"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetScrollY"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"0"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"200"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useLessThenScrollY.ts#L5",children:"packages/react/src/hooks/useLessThenScrollY.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useresizeviewportheight",children:"useResizeViewportHeight"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useResizeViewportHeight"}),"(): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\uc2a4\ud06c\ub864\uc744 \ud3ec\ud568\ud55c window\uc758 \ub192\uc774\ub97c \uac00\uc838\uc640 window \ud06c\uae30\ub97c resize\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\ubaa8\ubc14\uc77c \ud658\uacbd\uc758 \uc6f9\ubdf0\uc5d0\uc11c \ub514\ubc14\uc774\uc2a4 \ubc0f \ube0c\ub77c\uc6b0\uc800 \ud658\uacbd\uc5d0 \ub530\ub77c \ud06c\uae30\uac00 \ub2ec\ub77c\uc838 \ubd88\ud544\uc694\ud55c \uc2a4\ud06c\ub864\uc774 \uc0dd\uae38 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc774\ub54c \uc774 hook\uc744 \uc0ac\uc6a9\ud558\uba74 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useResizeViewportHeight.ts#L17",children:"packages/react/src/hooks/useResizeViewportHeight.ts:17"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usethrottlecallback",children:"useThrottleCallback"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useThrottleCallback"}),"<",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"dependencyList"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): (...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"dependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"fn"})}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 (",(0,l.jsx)(n.code,{children:"...args"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"...args"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})})]})})]}),"\n",(0,l.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useThrottleCallback.ts#L3",children:"packages/react/src/hooks/useThrottleCallback.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usetimeout",children:"useTimeout"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useTimeout"}),"(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"number"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useTimeout.ts#L5",children:"packages/react/src/hooks/useTimeout.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useunmount",children:"useUnmount"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUnmount"}),"(",(0,l.jsx)(n.code,{children:"fn"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"fn"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useUnmount.ts#L5",children:"packages/react/src/hooks/useUnmount.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useupdateeffect",children:"useUpdateEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUpdateEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/c804851/packages/react/src/hooks/useUpdateEffect.ts#L5",children:"packages/react/src/hooks/useUpdateEffect.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},5392:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var l=s(2784);const t={},d=l.createContext(t);function i(e){const n=l.useContext(d);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),l.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.2c404d24.js b/assets/js/runtime~main.cb0d5eec.js similarity index 95% rename from assets/js/runtime~main.2c404d24.js rename to assets/js/runtime~main.cb0d5eec.js index dd1ac23..67b98de 100644 --- a/assets/js/runtime~main.2c404d24.js +++ b/assets/js/runtime~main.cb0d5eec.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,n={},c={};function i(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=c,e=[],i.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u=o)&&Object.keys(i.O).every((e=>i.O[e](r[f])))?r.splice(f--,1):(c=!1,o0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(o,n),o},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({53:"935f2afb",60:"43ddbc45",109:"18c3d7cc",167:"8e5c7888",237:"1df93b7f",247:"479ba500",368:"a94703ab",428:"50539457",518:"a7bd4aaa",661:"5e95c892",724:"5192520c",767:"6acc1546",781:"49f38925",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b"}[e]||e)+"."+{12:"1e5120d1",53:"d97d5b12",60:"3c568afc",109:"4a9f8afd",167:"01136a5c",237:"09121bb9",247:"42e7a868",368:"07354bf2",428:"1d605fc4",518:"d4067009",661:"7536b1c5",724:"8a35dcbd",767:"4214ab45",781:"803139e7",857:"2cdec3fd",862:"d0489dc0",918:"f7090e26",971:"9ae03480"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",i.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var c,f;if(void 0!==r)for(var d=document.getElementsByTagName("script"),u=0;u{c.onerror=c.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(r))),t)return t(r)},b=setTimeout(s.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=s.bind(null,c.onerror),c.onload=s.bind(null,c.onload),f&&document.head.appendChild(c)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/frontend-libraries/",i.gca=function(e){return e={17896441:"918",50539457:"428","935f2afb":"53","43ddbc45":"60","18c3d7cc":"109","8e5c7888":"167","1df93b7f":"237","479ba500":"247",a94703ab:"368",a7bd4aaa:"518","5e95c892":"661","5192520c":"724","6acc1546":"767","49f38925":"781","35c8f0ed":"857","2ba16459":"862",c377a04b:"971"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var a=i.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=i.p+i.u(t),c=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",c.name="ChunkLoadError",c.type=o,c.request=n,a[1](c)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],c=r[1],f=r[2],d=0;if(n.some((t=>0!==e[t]))){for(a in c)i.o(c,a)&&(i.m[a]=c[a]);if(f)var u=f(i)}for(t&&t(r);d{"use strict";var e,t,r,a,o,n={},c={};function i(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=c,e=[],i.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u=o)&&Object.keys(i.O).every((e=>i.O[e](r[f])))?r.splice(f--,1):(c=!1,o0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(o,n),o},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({53:"935f2afb",60:"43ddbc45",109:"18c3d7cc",167:"8e5c7888",237:"1df93b7f",247:"479ba500",368:"a94703ab",428:"50539457",518:"a7bd4aaa",661:"5e95c892",724:"5192520c",767:"6acc1546",781:"49f38925",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b"}[e]||e)+"."+{12:"1e5120d1",53:"d97d5b12",60:"3c568afc",109:"4a9f8afd",167:"01136a5c",237:"09121bb9",247:"82a55cca",368:"07354bf2",428:"1d605fc4",518:"d4067009",661:"7536b1c5",724:"8a35dcbd",767:"cff3540f",781:"803139e7",857:"2cdec3fd",862:"812feaeb",918:"f7090e26",971:"9ae03480"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",i.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var c,f;if(void 0!==r)for(var d=document.getElementsByTagName("script"),u=0;u{c.onerror=c.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(r))),t)return t(r)},b=setTimeout(s.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=s.bind(null,c.onerror),c.onload=s.bind(null,c.onload),f&&document.head.appendChild(c)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/frontend-libraries/",i.gca=function(e){return e={17896441:"918",50539457:"428","935f2afb":"53","43ddbc45":"60","18c3d7cc":"109","8e5c7888":"167","1df93b7f":"237","479ba500":"247",a94703ab:"368",a7bd4aaa:"518","5e95c892":"661","5192520c":"724","6acc1546":"767","49f38925":"781","35c8f0ed":"857","2ba16459":"862",c377a04b:"971"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var a=i.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=i.p+i.u(t),c=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",c.name="ChunkLoadError",c.type=o,c.request=n,a[1](c)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],c=r[1],f=r[2],d=0;if(n.some((t=>0!==e[t]))){for(a in c)i.o(c,a)&&(i.m[a]=c[a]);if(f)var u=f(i)}for(t&&t(r);d Intro | @nf-team/frontend-libraries - + diff --git a/docs/core.html b/docs/core.html index 61d41d5..0a01120 100644 --- a/docs/core.html +++ b/docs/core.html @@ -4,7 +4,7 @@ @nf-team/core | @nf-team/frontend-libraries - + diff --git a/docs/core/modules.html b/docs/core/modules.html index 34645df..3be5ae1 100644 --- a/docs/core/modules.html +++ b/docs/core/modules.html @@ -4,7 +4,7 @@ @nf-team/core - v2.0.2 | @nf-team/frontend-libraries - + @@ -18,7 +18,7 @@

ParametersReturns​

T[]

Defined in​

-

utils.ts:44

+

utils.ts:44

checkNumber​

▸ checkNumber(value?): number

@@ -27,7 +27,7 @@

ParametersReturns​

number

Defined in​

-

utils.ts:26

+

utils.ts:26

emptyAThenB​

▸ emptyAThenB(b, a?): string

@@ -36,7 +36,7 @@

ParametersReturns​

string

Defined in​

-

utils.ts:34

+

utils.ts:34

generateArrayOfNumber​

▸ generateArrayOfNumber(length): number[]

@@ -45,7 +45,7 @@

ParametersReturns​

number[]

Defined in​

-

utils.ts:64

+

utils.ts:64

isEmpty​

▸ isEmpty<T>(value?): boolean

@@ -56,7 +56,7 @@

ParametersReturns​

boolean

Defined in​

-

utils.ts:52

+

utils.ts:52

removeNullable​

▸ removeNullable(value?, replacementValue?): string

@@ -70,7 +70,7 @@

Returns
console.log(result); // 'newValue';

Defined in​

-

utils.ts:14

+

utils.ts:14

trueOrFalse​

▸ trueOrFalse(value?): boolean

@@ -79,6 +79,6 @@

ParametersReturns​

boolean

Defined in​

-

utils.ts:36

+

utils.ts:36

\ No newline at end of file diff --git a/docs/eslint-config.html b/docs/eslint-config.html index ed156ab..fa709cc 100644 --- a/docs/eslint-config.html +++ b/docs/eslint-config.html @@ -4,7 +4,7 @@ @nf-team/eslint-config | @nf-team/frontend-libraries - + diff --git a/docs/react.html b/docs/react.html index 3edb947..f3f3a0a 100644 --- a/docs/react.html +++ b/docs/react.html @@ -4,7 +4,7 @@ @nf-team/react | @nf-team/frontend-libraries - + diff --git a/docs/react/modules.html b/docs/react/modules.html index 21089ea..b314683 100644 --- a/docs/react/modules.html +++ b/docs/react/modules.html @@ -4,7 +4,7 @@ @nf-team/react - v2.5.0 | @nf-team/frontend-libraries - + diff --git a/docs/react/modules/components.html b/docs/react/modules/components.html index f0f23d9..73bf933 100644 --- a/docs/react/modules/components.html +++ b/docs/react/modules/components.html @@ -4,7 +4,7 @@ Module: components | @nf-team/frontend-libraries - + @@ -23,7 +23,7 @@

Returns
function ClintOnlyComponent() {
 return (
   <ClientOnly>
     <div>Render only client environment</div>
   </ClientOnly>
 );
}

Defined in​

-

packages/react/src/components/ClientOnly.tsx:22

+

packages/react/src/components/ClientOnly.tsx:22

DelayRenderComponent​

▸ DelayRenderComponent(«destructured»): null | Element

@@ -32,7 +32,7 @@

ParametersReturns​

null | Element

Defined in​

-

packages/react/src/components/DelayRenderComponent.tsx:12

+

packages/react/src/components/DelayRenderComponent.tsx:12

GlobalPortal​

▸ GlobalPortal(elementId): null | ReactPortal

@@ -49,6 +49,6 @@

Returns
html
<div id="portal-container" />
tsx
function SampleComponent() {

 return (
   <GlobalPortal elementId="portal-container">
     <div>Render component</div>
   </GlobalPortal>
 );
}

Defined in​

-

packages/react/src/components/GlobalPortal.tsx:34

+

packages/react/src/components/GlobalPortal.tsx:34

\ No newline at end of file diff --git a/docs/react/modules/hooks.html b/docs/react/modules/hooks.html index ee7a21a..8442344 100644 --- a/docs/react/modules/hooks.html +++ b/docs/react/modules/hooks.html @@ -4,7 +4,7 @@ Module: hooks | @nf-team/frontend-libraries - + @@ -18,7 +18,7 @@

ParametersReturns​

ActionKeyEvent<T, U>

Defined in​

-

packages/react/src/hooks/useActionKeyEvent.ts:6

+

packages/react/src/hooks/useActionKeyEvent.ts:6

useBoolean​

▸ useBoolean(initialValue?): [boolean, () => void, () => void, (nextValue?: boolean) => void]

@@ -31,7 +31,7 @@

Returns
const [isOpen, openModal, closeModal, toggleModal] = useBoolean();

Defined in​

-

packages/react/src/hooks/useBoolean.ts:13

+

packages/react/src/hooks/useBoolean.ts:13

useDebounce​

▸ useDebounce<T>(value, delay?): T

@@ -42,7 +42,7 @@

ParametersReturns​

T

Defined in​

-

packages/react/src/hooks/useDebounce.ts:3

+

packages/react/src/hooks/useDebounce.ts:3

useEffectOnce​

▸ useEffectOnce(effect): void

@@ -51,21 +51,21 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useEffectOnce.ts:3

+

packages/react/src/hooks/useEffectOnce.ts:3

useGeolocation​

▸ useGeolocation(): [GeoLocation, () => void]

Returns​

[GeoLocation, () => void]

Defined in​

-

packages/react/src/hooks/useGeolocation.ts:15

+

packages/react/src/hooks/useGeolocation.ts:15

useIsFirstRender​

▸ useIsFirstRender(): boolean

Returns​

boolean

Defined in​

-

packages/react/src/hooks/useIsFirstRender.ts:3

+

packages/react/src/hooks/useIsFirstRender.ts:3

useIsMounted​

▸ useIsMounted(): boolean

@@ -77,7 +77,7 @@

Returns
const isMounted = useIsMounted();

useEffect(() => {
  if (isMounted) {
    return;
  }
}, [isMounted]);

Defined in​

-

packages/react/src/hooks/useIsMounted.ts:18

+

packages/react/src/hooks/useIsMounted.ts:18

useIsomorphicLayoutEffect​

▸ useIsomorphicLayoutEffect(effect, deps?): void

@@ -100,7 +100,7 @@

ParametersReturns​

boolean

Defined in​

-

packages/react/src/hooks/useLessThenScrollY.ts:5

+

packages/react/src/hooks/useLessThenScrollY.ts:5

useResizeViewportHeight​

▸ useResizeViewportHeight(): void

@@ -112,7 +112,7 @@

Returns
function SampleComponent() {
  useResizeViewportHeight();

  return <div>sample text</div>
}

Defined in​

-

packages/react/src/hooks/useResizeViewportHeight.ts:17

+

packages/react/src/hooks/useResizeViewportHeight.ts:17

useThrottleCallback​

▸ useThrottleCallback<U>(callback, dependencyList, delay): (...args: U) => void

@@ -128,7 +128,7 @@
ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useThrottleCallback.ts:3

+

packages/react/src/hooks/useThrottleCallback.ts:3

useTimeout​

▸ useTimeout(callback, delay): void

@@ -137,7 +137,7 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useTimeout.ts:5

+

packages/react/src/hooks/useTimeout.ts:5

useUnmount​

▸ useUnmount(fn): void

@@ -146,7 +146,7 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useUnmount.ts:5

+

packages/react/src/hooks/useUnmount.ts:5

useUpdateEffect​

▸ useUpdateEffect(effect, deps?): void

@@ -155,6 +155,6 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useUpdateEffect.ts:5

+

packages/react/src/hooks/useUpdateEffect.ts:5

\ No newline at end of file diff --git a/docs/stylelint-config.html b/docs/stylelint-config.html index 7b9a2e9..f791e40 100644 --- a/docs/stylelint-config.html +++ b/docs/stylelint-config.html @@ -4,7 +4,7 @@ @nf-team/stylelint-config | @nf-team/frontend-libraries - + diff --git a/index.html b/index.html index 39421e8..4d6dc44 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ @nf-team/frontend-libraries | @nf-team/frontend-libraries - +