From 205fcb303cb89c9208c0925eb929649a35451ea8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 28 Oct 2023 14:02:04 +0000 Subject: [PATCH] deploy: 1903b2b645af510ec96f0853ba54278568497d19 --- 404.html | 4 ++-- .../js/{2ba16459.7629a0e8.js => 2ba16459.8f8c263c.js} | 2 +- .../js/{479ba500.181c37ea.js => 479ba500.bcb7e24a.js} | 2 +- .../js/{5192520c.545c1313.js => 5192520c.cde62ce1.js} | 2 +- .../js/{6acc1546.58b6fef8.js => 6acc1546.048ff41f.js} | 2 +- .../js/{935f2afb.5a276b38.js => 935f2afb.8251ab23.js} | 2 +- ...ntime~main.21b9a777.js => runtime~main.fd14fb54.js} | 2 +- docs.html | 4 ++-- docs/core.html | 4 ++-- docs/core/modules.html | 6 +++--- docs/eslint-config.html | 4 ++-- docs/react.html | 4 ++-- docs/react/modules.html | 8 ++++---- docs/react/modules/components.html | 8 ++++---- docs/react/modules/hooks.html | 10 +++++----- index.html | 4 ++-- 16 files changed, 34 insertions(+), 34 deletions(-) rename assets/js/{2ba16459.7629a0e8.js => 2ba16459.8f8c263c.js} (98%) rename assets/js/{479ba500.181c37ea.js => 479ba500.bcb7e24a.js} (84%) rename assets/js/{5192520c.545c1313.js => 5192520c.cde62ce1.js} (94%) rename assets/js/{6acc1546.58b6fef8.js => 6acc1546.048ff41f.js} (90%) rename assets/js/{935f2afb.5a276b38.js => 935f2afb.8251ab23.js} (97%) rename assets/js/{runtime~main.21b9a777.js => runtime~main.fd14fb54.js} (74%) diff --git a/404.html b/404.html index 73ae3d0..bd83308 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ 페이지를 찾을 수 없습니다. | @nf-team/frontend-libraries - +
본문으로 건너뛰기

페이지를 찾을 수 없습니다.

원하는 페이지를 찾을 수 없습니다.

사이트 관리자에게 링크가 깨진 것을 알려주세요.

- + \ No newline at end of file diff --git a/assets/js/2ba16459.7629a0e8.js b/assets/js/2ba16459.8f8c263c.js similarity index 98% rename from assets/js/2ba16459.7629a0e8.js rename to assets/js/2ba16459.8f8c263c.js index e00278b..bd102ed 100644 --- a/assets/js/2ba16459.7629a0e8.js +++ b/assets/js/2ba16459.8f8c263c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{876:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var r=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),s=d(n),u=a,k=s["".concat(p,".").concat(u)]||s[u]||c[u]||l;return n?r.createElement(k,o(o({ref:t},m),{},{components:n})):r.createElement(k,o({ref:t},m))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:a,o[1]=i;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var r=n(7896),a=(n(2784),n(876));const l={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},o=void 0,i={unversionedId:"react/modules/components",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,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"}},p={},d=[{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}],m={toc:d},s="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(s,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"functions"},"Functions"),(0,a.kt)("h3",{id:"clientonly"},"ClientOnly"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"ClientOnly"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactElement")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"null")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,a.kt)("p",null,"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,a.kt)("br",null),"\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.)"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n")),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},"\u203a\xa0",(0,a.kt)("inlineCode",{parentName:"td"},"children?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ReactNode"))))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ReactElement")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"null")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/components/ClientOnly.tsx#L22"},"packages/react/src/components/ClientOnly.tsx:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"delayrendercomponent"},"DelayRenderComponent"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"DelayRenderComponent"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Element")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Props"),">")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Element")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/components/DelayRenderComponent.tsx#L12"},"packages/react/src/components/DelayRenderComponent.tsx:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"globalportal"},"GlobalPortal"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"GlobalPortal"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"elementId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactPortal")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,a.kt)("p",null,"\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,a.kt)("inlineCode",{parentName:"p"},"ReactDOM.createPortal"),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,a.kt)("br",null),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,a.kt)("inlineCode",{parentName:"p"},"overflow: hidden"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"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."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-html",metastring:'title="html"',title:'"html"'},'
\n')),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx",metastring:'title="tsx"',title:'"tsx"'},'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n')),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"elementId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Props"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactPortal")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/components/GlobalPortal.tsx#L34"},"packages/react/src/components/GlobalPortal.tsx:34")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{876:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var r=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),s=d(n),u=a,k=s["".concat(p,".").concat(u)]||s[u]||c[u]||l;return n?r.createElement(k,o(o({ref:t},m),{},{components:n})):r.createElement(k,o({ref:t},m))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:a,o[1]=i;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var r=n(7896),a=(n(2784),n(876));const l={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},o=void 0,i={unversionedId:"react/modules/components",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,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"}},p={},d=[{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}],m={toc:d},s="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(s,(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"functions"},"Functions"),(0,a.kt)("h3",{id:"clientonly"},"ClientOnly"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"ClientOnly"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactElement")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"null")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,a.kt)("p",null,"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,a.kt)("br",null),"\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.)"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx"},"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n")),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},"\u203a\xa0",(0,a.kt)("inlineCode",{parentName:"td"},"children?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ReactNode"))))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ReactElement")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"null")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/components/ClientOnly.tsx#L22"},"packages/react/src/components/ClientOnly.tsx:22")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"delayrendercomponent"},"DelayRenderComponent"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"DelayRenderComponent"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Element")),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Props"),">")))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Element")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/components/DelayRenderComponent.tsx#L12"},"packages/react/src/components/DelayRenderComponent.tsx:12")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"globalportal"},"GlobalPortal"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"GlobalPortal"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"elementId"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactPortal")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,a.kt)("p",null,"\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,a.kt)("inlineCode",{parentName:"p"},"ReactDOM.createPortal"),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,a.kt)("br",null),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,a.kt)("inlineCode",{parentName:"p"},"overflow: hidden"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"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."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-html",metastring:'title="html"',title:'"html"'},'
\n')),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-tsx",metastring:'title="tsx"',title:'"tsx"'},'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n')),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"elementId")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Props"),">"),(0,a.kt)("td",{parentName:"tr",align:"left"},"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12")))),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactPortal")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/components/GlobalPortal.tsx#L34"},"packages/react/src/components/GlobalPortal.tsx:34")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/479ba500.181c37ea.js b/assets/js/479ba500.bcb7e24a.js similarity index 84% rename from assets/js/479ba500.181c37ea.js rename to assets/js/479ba500.bcb7e24a.js index 9cc416b..ed229f4 100644 --- a/assets/js/479ba500.181c37ea.js +++ b/assets/js/479ba500.bcb7e24a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{876:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>N});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),m=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},o=function(e){var t=m(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},s=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),k=m(a),s=r,N=k["".concat(d,".").concat(s)]||k[s]||u[s]||l;return a?n.createElement(N,i(i({ref:t},o),{},{components:a})):n.createElement(N,i({ref:t},o))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=s;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[k]="string"==typeof e?e:r,i[1]=p;for(var m=2;m{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>p,toc:()=>m});var n=a(7896),r=(a(2784),a(876));const l={id:"modules",title:"@nf-team/core - v2.0.1",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,p={unversionedId:"core/modules",id:"core/modules",title:"@nf-team/core - v2.0.1",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.0.1",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/"}},d={},m=[{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}],o={toc:m},k="wrapper";function u(e){let{components:t,...a}=e;return(0,r.kt)(k,(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"checkempty"},"checkEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkEmpty"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L44"},"utils.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checknumber"},"checkNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkNumber"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L26"},"utils.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emptyathenb"},"emptyAThenB"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emptyAThenB"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"b"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"a?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"b")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"a?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L34"},"utils.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generatearrayofnumber"},"generateArrayOfNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateArrayOfNumber"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"length"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"length")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L64"},"utils.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isempty"},"isEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isEmpty"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L52"},"utils.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removenullable"},"removeNullable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeNullable"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"replacementValue?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null"),"\uc774\ub098 ",(0,r.kt)("inlineCode",{parentName:"p"},"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.kt)("inlineCode",{parentName:"p"},"string")," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"console.log(result); // 'newValue';\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"replacementValue?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," \ub610\ub294 ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined"),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L14"},"utils.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"trueorfalse"},"trueOrFalse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"trueOrFalse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/core/src/utils.ts#L36"},"utils.ts:36")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{876:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>N});var a=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),m=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},o=function(e){var t=m(e.components);return a.createElement(d.Provider,{value:t},e.children)},k="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),k=m(n),s=r,N=k["".concat(d,".").concat(s)]||k[s]||u[s]||l;return n?a.createElement(N,i(i({ref:t},o),{},{components:n})):a.createElement(N,i({ref:t},o))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=s;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[k]="string"==typeof e?e:r,i[1]=p;for(var m=2;m{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>p,toc:()=>m});var a=n(7896),r=(n(2784),n(876));const l={id:"modules",title:"@nf-team/core - v2.0.1",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,p={unversionedId:"core/modules",id:"core/modules",title:"@nf-team/core - v2.0.1",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.0.1",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/"}},d={},m=[{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}],o={toc:m},k="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(k,(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"checkempty"},"checkEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkEmpty"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L44"},"utils.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checknumber"},"checkNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkNumber"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L26"},"utils.ts:26")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emptyathenb"},"emptyAThenB"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emptyAThenB"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"b"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"a?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"b")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"a?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L34"},"utils.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"generatearrayofnumber"},"generateArrayOfNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"generateArrayOfNumber"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"length"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"length")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L64"},"utils.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isempty"},"isEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isEmpty"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L52"},"utils.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removenullable"},"removeNullable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeNullable"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"replacementValue?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null"),"\uc774\ub098 ",(0,r.kt)("inlineCode",{parentName:"p"},"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.kt)("inlineCode",{parentName:"p"},"string")," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"console.log(result); // 'newValue';\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"replacementValue?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," \ub610\ub294 ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined"),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L14"},"utils.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"trueorfalse"},"trueOrFalse"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"trueOrFalse"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"value?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/core/src/utils.ts#L36"},"utils.ts:36")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5192520c.545c1313.js b/assets/js/5192520c.cde62ce1.js similarity index 94% rename from assets/js/5192520c.545c1313.js rename to assets/js/5192520c.cde62ce1.js index b4eaef2..17151ed 100644 --- a/assets/js/5192520c.545c1313.js +++ b/assets/js/5192520c.cde62ce1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[724],{876:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var n=r(2784);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=n.createContext({}),s=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},u=function(e){var t=s(e.components);return n.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=s(r),m=o,f=p["".concat(c,".").concat(m)]||p[m]||d[m]||a;return r?n.createElement(f,l(l({ref:t},u),{},{components:r})):n.createElement(f,l({ref:t},u))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,l=new Array(a);l[0]=m;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[p]="string"==typeof e?e:o,l[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var n=r(7896),o=(r(2784),r(876));const a={id:"modules",title:"@nf-team/react - v2.4.1",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},l=void 0,i={unversionedId:"react/modules",id:"react/modules",title:"@nf-team/react - v2.4.1",description:"Modules",source:"@site/docs/react/modules.md",sourceDirName:"react",slug:"/react/modules",permalink:"/frontend-libraries/docs/react/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/react - v2.4.1",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/react/"},next:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"}},c={},s=[{value:"Modules",id:"modules",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...r}=e;return(0,o.kt)(p,(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"modules"},"Modules"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/frontend-libraries/docs/react/modules/components"},"components")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/frontend-libraries/docs/react/modules/hooks"},"hooks"))))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[724],{876:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var n=r(2784);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=n.createContext({}),s=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},u=function(e){var t=s(e.components);return n.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=s(r),m=o,f=p["".concat(c,".").concat(m)]||p[m]||d[m]||a;return r?n.createElement(f,l(l({ref:t},u),{},{components:r})):n.createElement(f,l({ref:t},u))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,l=new Array(a);l[0]=m;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[p]="string"==typeof e?e:o,l[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>s});var n=r(7896),o=(r(2784),r(876));const a={id:"modules",title:"@nf-team/react - v2.4.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},l=void 0,i={unversionedId:"react/modules",id:"react/modules",title:"@nf-team/react - v2.4.2",description:"Modules",source:"@site/docs/react/modules.md",sourceDirName:"react",slug:"/react/modules",permalink:"/frontend-libraries/docs/react/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/react - v2.4.2",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/react/"},next:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"}},c={},s=[{value:"Modules",id:"modules",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...r}=e;return(0,o.kt)(p,(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"modules"},"Modules"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/frontend-libraries/docs/react/modules/components"},"components")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/frontend-libraries/docs/react/modules/hooks"},"hooks"))))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6acc1546.58b6fef8.js b/assets/js/6acc1546.048ff41f.js similarity index 90% rename from assets/js/6acc1546.58b6fef8.js rename to assets/js/6acc1546.048ff41f.js index f93b15f..873eb48 100644 --- a/assets/js/6acc1546.58b6fef8.js +++ b/assets/js/6acc1546.048ff41f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{876:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=o(a),u=r,N=k["".concat(d,".").concat(u)]||k[u]||m[u]||l;return a?n.createElement(N,i(i({ref:t},s),{},{components:a})):n.createElement(N,i({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[k]="string"==typeof e?e:r,i[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var n=a(7896),r=(a(2784),a(876));const l={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"react/modules/hooks",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,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/"}},d={},o=[{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:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",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-9",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Defined in",id:"defined-in-9",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4}],s={toc:o},k="wrapper";function m(e){let{components:t,...a}=e;return(0,r.kt)(k,(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"useactionkeyevent"},"useActionKeyEvent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"targetKeys"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Element"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),"[] = []")))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"targetKeys")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"event"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"KeyboardEvent"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",", ...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useActionKeyEvent.ts#L6"},"packages/react/src/hooks/useActionKeyEvent.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useboolean"},"useBoolean"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBoolean"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"initialValue?"),"): ","[",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", (",(0,r.kt)("inlineCode",{parentName:"p"},"nextValue?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"]"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,r.kt)("inlineCode",{parentName:"p"},"useState"),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"initialValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\ucd08\uae30\uac12\uc744 \uc138\ud305")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,"[",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", (",(0,r.kt)("inlineCode",{parentName:"p"},"nextValue?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useBoolean.ts#L13"},"packages/react/src/hooks/useBoolean.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usedebounce"},"useDebounce"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useDebounce"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"T")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"T")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useDebounce.ts#L3"},"packages/react/src/hooks/useDebounce.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useeffectonce"},"useEffectOnce"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useEffectOnce"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useEffectOnce.ts#L3"},"packages/react/src/hooks/useEffectOnce.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useisfirstrender"},"useIsFirstRender"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsFirstRender"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useIsFirstRender.ts#L3"},"packages/react/src/hooks/useIsFirstRender.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useismounted"},"useIsMounted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsMounted"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,"Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,r.kt)("br",null),"\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."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useIsMounted.ts#L18"},"packages/react/src/hooks/useIsMounted.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useisomorphiclayouteffect"},"useIsomorphicLayoutEffect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsomorphicLayoutEffect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"deps?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Accepts a function that contains imperative, possibly effectful code."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Version"))),(0,r.kt)("p",null,"16.8.0"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://react.dev/reference/react/useEffect"},"https://react.dev/reference/react/useEffect")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Imperative function that can return a cleanup function")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"deps?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If present, effect will only activate if the values in the list change.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/ts5.0/index.d.ts:1064"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uselessthenscrolly"},"useLessThenScrollY"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useLessThenScrollY"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"targetScrollY?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"targetScrollY")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"200"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useLessThenScrollY.ts#L5"},"packages/react/src/hooks/useLessThenScrollY.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useresizeviewportheight"},"useResizeViewportHeight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useResizeViewportHeight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,"\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,r.kt)("br",null),"\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."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useResizeViewportHeight.ts#L17"},"packages/react/src/hooks/useResizeViewportHeight.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethrottlecallback"},"useThrottleCallback"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThrottleCallback"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dependencyList"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay"),"): (...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"never"),"[]")))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dependencyList")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"fn")),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h5",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U"))))),(0,r.kt)("h5",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useThrottleCallback.ts#L3"},"packages/react/src/hooks/useThrottleCallback.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usetimeout"},"useTimeout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTimeout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useTimeout.ts#L5"},"packages/react/src/hooks/useTimeout.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useunmount"},"useUnmount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useUnmount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useUnmount.ts#L5"},"packages/react/src/hooks/useUnmount.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useupdateeffect"},"useUpdateEffect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useUpdateEffect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"deps?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"deps?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1daa36a/packages/react/src/hooks/useUpdateEffect.ts#L5"},"packages/react/src/hooks/useUpdateEffect.ts:5")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{876:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>N});var a=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=o(n),u=r,N=k["".concat(d,".").concat(u)]||k[u]||m[u]||l;return n?a.createElement(N,i(i({ref:t},s),{},{components:n})):a.createElement(N,i({ref:t},s))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[k]="string"==typeof e?e:r,i[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var a=n(7896),r=(n(2784),n(876));const l={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"react/modules/hooks",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,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/"}},d={},o=[{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:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",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-9",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Defined in",id:"defined-in-9",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4}],s={toc:o},k="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(k,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"useactionkeyevent"},"useActionKeyEvent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"targetKeys"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Element"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),"[] = []")))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"targetKeys")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"event"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"KeyboardEvent"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",", ...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ActionKeyEvent"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useActionKeyEvent.ts#L6"},"packages/react/src/hooks/useActionKeyEvent.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useboolean"},"useBoolean"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBoolean"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"initialValue?"),"): ","[",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", (",(0,r.kt)("inlineCode",{parentName:"p"},"nextValue?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"]"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,r.kt)("inlineCode",{parentName:"p"},"useState"),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"initialValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"\ucd08\uae30\uac12\uc744 \uc138\ud305")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,"[",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", () => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", (",(0,r.kt)("inlineCode",{parentName:"p"},"nextValue?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useBoolean.ts#L13"},"packages/react/src/hooks/useBoolean.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usedebounce"},"useDebounce"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useDebounce"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"value"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"T")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"value")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"T")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useDebounce.ts#L3"},"packages/react/src/hooks/useDebounce.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useeffectonce"},"useEffectOnce"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useEffectOnce"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback"))))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useEffectOnce.ts#L3"},"packages/react/src/hooks/useEffectOnce.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useisfirstrender"},"useIsFirstRender"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsFirstRender"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useIsFirstRender.ts#L3"},"packages/react/src/hooks/useIsFirstRender.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useismounted"},"useIsMounted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsMounted"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,"Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,r.kt)("br",null),"\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."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n")),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useIsMounted.ts#L18"},"packages/react/src/hooks/useIsMounted.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useisomorphiclayouteffect"},"useIsomorphicLayoutEffect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useIsomorphicLayoutEffect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"deps?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Accepts a function that contains imperative, possibly effectful code."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Version"))),(0,r.kt)("p",null,"16.8.0"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://react.dev/reference/react/useEffect"},"https://react.dev/reference/react/useEffect")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Imperative function that can return a cleanup function")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"deps?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If present, effect will only activate if the values in the list change.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/ts5.0/index.d.ts:1064"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"uselessthenscrolly"},"useLessThenScrollY"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useLessThenScrollY"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"targetScrollY?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"targetScrollY")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"200"))))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useLessThenScrollY.ts#L5"},"packages/react/src/hooks/useLessThenScrollY.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useresizeviewportheight"},"useResizeViewportHeight"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useResizeViewportHeight"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Description"))),(0,r.kt)("p",null,"\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,r.kt)("br",null),"\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."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n")),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useResizeViewportHeight.ts#L17"},"packages/react/src/hooks/useResizeViewportHeight.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethrottlecallback"},"useThrottleCallback"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThrottleCallback"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"U"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"dependencyList"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay"),"): (...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"never"),"[]")))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"U"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dependencyList")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"fn")),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h5",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"U"))))),(0,r.kt)("h5",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useThrottleCallback.ts#L3"},"packages/react/src/hooks/useThrottleCallback.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usetimeout"},"useTimeout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTimeout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"delay"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"delay")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useTimeout.ts#L5"},"packages/react/src/hooks/useTimeout.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useunmount"},"useUnmount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useUnmount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useUnmount.ts#L5"},"packages/react/src/hooks/useUnmount.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useupdateeffect"},"useUpdateEffect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useUpdateEffect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"effect"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"deps?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"effect")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EffectCallback"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"deps?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DependencyList"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/mbti-nf-team/frontend-libraries/blob/1903b2b/packages/react/src/hooks/useUpdateEffect.ts#L5"},"packages/react/src/hooks/useUpdateEffect.ts:5")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.5a276b38.js b/assets/js/935f2afb.8251ab23.js similarity index 97% rename from assets/js/935f2afb.5a276b38.js rename to assets/js/935f2afb.8251ab23.js index 81c6ac9..f41dd6c 100644 --- a/assets/js/935f2afb.5a276b38.js +++ b/assets/js/935f2afb.8251ab23.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"sidebar":[{"type":"link","label":"Intro","href":"/frontend-libraries/docs/","docId":"index"},{"type":"category","label":"@nf-team/core","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/frontend-libraries/docs/core/modules","docId":"core/modules"}],"href":"/frontend-libraries/docs/core/"},{"type":"category","label":"@nf-team/react","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/frontend-libraries/docs/react/modules","docId":"react/modules"},{"type":"category","label":"Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"components","href":"/frontend-libraries/docs/react/modules/components","docId":"react/modules/components"},{"type":"link","label":"hooks","href":"/frontend-libraries/docs/react/modules/hooks","docId":"react/modules/hooks"}]}],"href":"/frontend-libraries/docs/react/"},{"type":"link","label":"@nf-team/eslint-config","href":"/frontend-libraries/docs/eslint-config/","docId":"eslint-config/index"}]},"docs":{"core/index":{"id":"core/index","title":"@nf-team/core","description":"Check out our @nf-team/core libraries docs.","sidebar":"sidebar"},"core/modules":{"id":"core/modules","title":"@nf-team/core - v2.0.1","description":"Functions","sidebar":"sidebar"},"eslint-config/index":{"id":"eslint-config/index","title":"@nf-team/eslint-config","description":"\ud83d\ude80 Quick Overview","sidebar":"sidebar"},"index":{"id":"index","title":"Intro","description":"- @nf-team/core","sidebar":"sidebar"},"react/index":{"id":"react/index","title":"@nf-team/react","description":"Check out our @nf-team/react libraries docs.","sidebar":"sidebar"},"react/modules":{"id":"react/modules","title":"@nf-team/react - v2.4.1","description":"Modules","sidebar":"sidebar"},"react/modules/components":{"id":"react/modules/components","title":"Module: components","description":"Functions","sidebar":"sidebar"},"react/modules/hooks":{"id":"react/modules/hooks","title":"Module: hooks","description":"Functions","sidebar":"sidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"sidebar":[{"type":"link","label":"Intro","href":"/frontend-libraries/docs/","docId":"index"},{"type":"category","label":"@nf-team/core","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/frontend-libraries/docs/core/modules","docId":"core/modules"}],"href":"/frontend-libraries/docs/core/"},{"type":"category","label":"@nf-team/react","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/frontend-libraries/docs/react/modules","docId":"react/modules"},{"type":"category","label":"Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"components","href":"/frontend-libraries/docs/react/modules/components","docId":"react/modules/components"},{"type":"link","label":"hooks","href":"/frontend-libraries/docs/react/modules/hooks","docId":"react/modules/hooks"}]}],"href":"/frontend-libraries/docs/react/"},{"type":"link","label":"@nf-team/eslint-config","href":"/frontend-libraries/docs/eslint-config/","docId":"eslint-config/index"}]},"docs":{"core/index":{"id":"core/index","title":"@nf-team/core","description":"Check out our @nf-team/core libraries docs.","sidebar":"sidebar"},"core/modules":{"id":"core/modules","title":"@nf-team/core - v2.0.1","description":"Functions","sidebar":"sidebar"},"eslint-config/index":{"id":"eslint-config/index","title":"@nf-team/eslint-config","description":"\ud83d\ude80 Quick Overview","sidebar":"sidebar"},"index":{"id":"index","title":"Intro","description":"- @nf-team/core","sidebar":"sidebar"},"react/index":{"id":"react/index","title":"@nf-team/react","description":"Check out our @nf-team/react libraries docs.","sidebar":"sidebar"},"react/modules":{"id":"react/modules","title":"@nf-team/react - v2.4.2","description":"Modules","sidebar":"sidebar"},"react/modules/components":{"id":"react/modules/components","title":"Module: components","description":"Functions","sidebar":"sidebar"},"react/modules/hooks":{"id":"react/modules/hooks","title":"Module: hooks","description":"Functions","sidebar":"sidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.21b9a777.js b/assets/js/runtime~main.fd14fb54.js similarity index 74% rename from assets/js/runtime~main.21b9a777.js rename to assets/js/runtime~main.fd14fb54.js index f75f85f..564b59b 100644 --- a/assets/js/runtime~main.21b9a777.js +++ b/assets/js/runtime~main.fd14fb54.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,o,a,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,o,a)=>{if(!r){var n=1/0;for(u=0;u=a)&&Object.keys(i.O).every((e=>i.O[e](r[f])))?r.splice(f--,1):(c=!1,a0&&e[u-1][2]>a;u--)e[u]=e[u-1];e[u]=[r,o,a]},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,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);i.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&o&&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(a,n),a},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",514:"1be78505",724:"5192520c",767:"6acc1546",781:"49f38925",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b"}[e]||e)+"."+{6:"caad4c93",53:"5a276b38",60:"3c568afc",109:"008d5cba",167:"01136a5c",237:"6a7604d2",247:"181c37ea",514:"ff6a0996",724:"545c1313",767:"58b6fef8",781:"f151d763",857:"ef1a8ec1",862:"7629a0e8",918:"014da702",971:"40a78337"}[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),o={},a="docs:",i.l=(e,t,r,n)=>{if(o[e])o[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 a=o[e];if(delete o[e],c.parentNode&&c.parentNode.removeChild(c),a&&a.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","935f2afb":"53","43ddbc45":"60","18c3d7cc":"109","8e5c7888":"167","1df93b7f":"237","479ba500":"247","1be78505":"514","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 o=i.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=i.p+i.u(t),c=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",c.name="ChunkLoadError",c.type=a,c.request=n,o[1](c)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],c=r[1],f=r[2],d=0;if(n.some((t=>0!==e[t]))){for(o in c)i.o(c,o)&&(i.m[o]=c[o]);if(f)var u=f(i)}for(t&&t(r);d{"use strict";var e,t,r,o,a,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,o,a)=>{if(!r){var n=1/0;for(u=0;u=a)&&Object.keys(i.O).every((e=>i.O[e](r[d])))?r.splice(d--,1):(c=!1,a0&&e[u-1][2]>a;u--)e[u]=e[u-1];e[u]=[r,o,a]},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,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);i.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&o&&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(a,n),a},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",514:"1be78505",724:"5192520c",767:"6acc1546",781:"49f38925",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b"}[e]||e)+"."+{6:"caad4c93",53:"8251ab23",60:"3c568afc",109:"008d5cba",167:"01136a5c",237:"6a7604d2",247:"bcb7e24a",514:"ff6a0996",724:"cde62ce1",767:"048ff41f",781:"f151d763",857:"ef1a8ec1",862:"8f8c263c",918:"014da702",971:"40a78337"}[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),o={},a="docs:",i.l=(e,t,r,n)=>{if(o[e])o[e].push(t);else{var c,d;if(void 0!==r)for(var f=document.getElementsByTagName("script"),u=0;u{c.onerror=c.onload=null,clearTimeout(b);var a=o[e];if(delete o[e],c.parentNode&&c.parentNode.removeChild(c),a&&a.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),d&&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","935f2afb":"53","43ddbc45":"60","18c3d7cc":"109","8e5c7888":"167","1df93b7f":"237","479ba500":"247","1be78505":"514","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 o=i.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=i.p+i.u(t),c=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",c.name="ChunkLoadError",c.type=a,c.request=n,o[1](c)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],c=r[1],d=r[2],f=0;if(n.some((t=>0!==e[t]))){for(o in c)i.o(c,o)&&(i.m[o]=c[o]);if(d)var u=d(i)}for(t&&t(r);f Intro | @nf-team/frontend-libraries - +
- + \ No newline at end of file diff --git a/docs/core.html b/docs/core.html index 1ae37df..e126644 100644 --- a/docs/core.html +++ b/docs/core.html @@ -4,13 +4,13 @@ @nf-team/core | @nf-team/frontend-libraries - +
- + \ No newline at end of file diff --git a/docs/core/modules.html b/docs/core/modules.html index e924d19..873a393 100644 --- a/docs/core/modules.html +++ b/docs/core/modules.html @@ -4,13 +4,13 @@ @nf-team/core - v2.0.1 | @nf-team/frontend-libraries - +
-

@nf-team/core - v2.0.1

Functions​

checkEmpty​

▸ checkEmpty<T>(value?): T[]

Type parameters​

Name
T

Parameters​

NameType
value?T[]

Returns​

T[]

Defined in​

utils.ts:44

checkNumber​

▸ checkNumber(value?): number

Parameters​

NameType
value?null | number

Returns​

number

Defined in​

utils.ts:26

emptyAThenB​

▸ emptyAThenB(b, a?): string

Parameters​

NameType
bstring
a?null | string

Returns​

string

Defined in​

utils.ts:34

generateArrayOfNumber​

▸ generateArrayOfNumber(length): number[]

Parameters​

NameType
lengthnumber

Returns​

number[]

Defined in​

utils.ts:64

isEmpty​

▸ isEmpty<T>(value?): boolean

Type parameters​

Name
T

Parameters​

NameType
value?T[]

Returns​

boolean

Defined in​

utils.ts:52

removeNullable​

▸ removeNullable(value?, replacementValue?): string

Description

null이나 undefined값이 존재하는 경우 빈문자열로 대체하거나 새로운 문자열로 대체합니다. (오로지 string 타입으로 반환)

const value = undefined;
const result = removeNullable(value, 'newValue');

Example

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

Parameters​

NameTypeDescription
value?null | string첫 번째 인자 string | null | undefined
replacementValue?string두 번째 인자에 값이 존재하는 경우 첫 번째 인자가 null 또는 undefined인 경우 두번째 인자로 문자열 대체

Returns​

string

Defined in​

utils.ts:14

trueOrFalse​

▸ trueOrFalse(value?): boolean

Parameters​

NameType
value?null | string | number | boolean

Returns​

boolean

Defined in​

utils.ts:36

- +

@nf-team/core - v2.0.1

Functions​

checkEmpty​

▸ checkEmpty<T>(value?): T[]

Type parameters​

Name
T

Parameters​

NameType
value?T[]

Returns​

T[]

Defined in​

utils.ts:44

checkNumber​

▸ checkNumber(value?): number

Parameters​

NameType
value?null | number

Returns​

number

Defined in​

utils.ts:26

emptyAThenB​

▸ emptyAThenB(b, a?): string

Parameters​

NameType
bstring
a?null | string

Returns​

string

Defined in​

utils.ts:34

generateArrayOfNumber​

▸ generateArrayOfNumber(length): number[]

Parameters​

NameType
lengthnumber

Returns​

number[]

Defined in​

utils.ts:64

isEmpty​

▸ isEmpty<T>(value?): boolean

Type parameters​

Name
T

Parameters​

NameType
value?T[]

Returns​

boolean

Defined in​

utils.ts:52

removeNullable​

▸ removeNullable(value?, replacementValue?): string

Description

null이나 undefined값이 존재하는 경우 빈문자열로 대체하거나 새로운 문자열로 대체합니다. (오로지 string 타입으로 반환)

const value = undefined;
const result = removeNullable(value, 'newValue');

Example

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

Parameters​

NameTypeDescription
value?null | string첫 번째 인자 string | null | undefined
replacementValue?string두 번째 인자에 값이 존재하는 경우 첫 번째 인자가 null 또는 undefined인 경우 두번째 인자로 문자열 대체

Returns​

string

Defined in​

utils.ts:14

trueOrFalse​

▸ trueOrFalse(value?): boolean

Parameters​

NameType
value?null | string | number | boolean

Returns​

boolean

Defined in​

utils.ts:36

+ \ No newline at end of file diff --git a/docs/eslint-config.html b/docs/eslint-config.html index 9f17189..cd001c3 100644 --- a/docs/eslint-config.html +++ b/docs/eslint-config.html @@ -4,13 +4,13 @@ @nf-team/eslint-config | @nf-team/frontend-libraries - +

@nf-team/eslint-config

🚀 Quick Overview​

Install @nf-team/eslint-config dependency

npm install --save-dev @nf-team/eslint-config

Add @nf-team/eslint-config to extends in your .eslintrc

module.exports = {
  // ...
  extends: ['@nf-team/eslint-config'],
  rules: {
    // ...
  },
};

🤔 What eslint extensions does @nf-team/eslint-config have?​

View more extensions..

👉 Sort default imports​

This is the default value for the groups option:

[
  // Side effect imports.
  ['^\\u0000'],
  // Node.js builtins. You could also generate this regex if you use a `.js` config.
  // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
  // OR Node.js builtins prefixed with `node:`.
  ['^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)', '^node:'],
  // Packages. `react` related packages
  ['^react'],
  // Packages. Things that start with a letter (or digit or underscore), or `@` followed by a letter.
  ['^@?\\w'],
  // Parent imports. Put `..` last.
  ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
  // Other relative imports. Put same-folder imports and `.` last.
  ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
  // Svg file imports.
  ['^.+\\.svg$'],
  // Style imports.
  ['^.+\\.s?css$'],
]

🐛 Bug reporting​

Issues

🔒 LICENSE​

This Project is MIT licensed.

- + \ No newline at end of file diff --git a/docs/react.html b/docs/react.html index f664dae..06110b1 100644 --- a/docs/react.html +++ b/docs/react.html @@ -4,13 +4,13 @@ @nf-team/react | @nf-team/frontend-libraries - +
- + \ No newline at end of file diff --git a/docs/react/modules.html b/docs/react/modules.html index db50da2..ff7b01c 100644 --- a/docs/react/modules.html +++ b/docs/react/modules.html @@ -3,14 +3,14 @@ -@nf-team/react - v2.4.1 | @nf-team/frontend-libraries - +@nf-team/react - v2.4.2 | @nf-team/frontend-libraries +
-
- +
+ \ No newline at end of file diff --git a/docs/react/modules/components.html b/docs/react/modules/components.html index 3b75b7a..72b0d41 100644 --- a/docs/react/modules/components.html +++ b/docs/react/modules/components.html @@ -4,7 +4,7 @@ Module: components | @nf-team/frontend-libraries - + @@ -12,11 +12,11 @@
본문으로 건너뛰기

Module: components

Functions​

ClientOnly​

▸ ClientOnly(«destructured»): ReactElement | null

Description

Component의 mount 여부를 확인하여 mount가 된 경우, Component를 render해줍니다. mount되지 않은 경우에는 Component를 render해주지 않습니다.
SSR 환경에서 실제로 컴포넌트가 브라우저에서 mount 된 이후에만 해당 Component를 보여주고 싶을때 사용합니다. -(SSR 환경에서 Hydration 오류로 인해서 에러가 발생하는 문제를 해결합니다.)

Example

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

Parameters​

NameType
«destructured»Object
› children?ReactNode

Returns​

ReactElement | null

Defined in​

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

DelayRenderComponent​

▸ DelayRenderComponent(«destructured»): null | Element

Parameters​

NameType
«destructured»PropsWithChildren<Props>

Returns​

null | Element

Defined in​

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

GlobalPortal​

▸ GlobalPortal(elementId): null | ReactPortal

Description

부모 컴포넌트의 DOM 외부에 존재하는 DOM 노드에 렌더링 할 수 있게 해주는 +(SSR 환경에서 Hydration 오류로 인해서 에러가 발생하는 문제를 해결합니다.)

Example

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

Parameters​

NameType
«destructured»Object
› children?ReactNode

Returns​

ReactElement | null

Defined in​

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

DelayRenderComponent​

▸ DelayRenderComponent(«destructured»): null | Element

Parameters​

NameType
«destructured»PropsWithChildren<Props>

Returns​

null | Element

Defined in​

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

GlobalPortal​

▸ GlobalPortal(elementId): null | ReactPortal

Description

부모 컴포넌트의 DOM 외부에 존재하는 DOM 노드에 렌더링 할 수 있게 해주는 ReactDOM.createPortal를 이용해 컴포넌트를 렌더링해줍니다.
공통적인 UI(모달, 팝업, 알림 등)나 부모 컴포넌트에 -overflow: hidden, z-index와 같은 스타일이 있을 때 부모 엘리먼트에 의존적이지 않아야하는 경우 유용합니다.

Example

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

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

Parameters​

NameTypeDescription
elementIdPropsWithChildren<Props>부모 엘리먼트가 아닌 다른 DOM 트리의 elementId값

Returns​

null | ReactPortal

Defined in​

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

- +overflow: hidden, z-index와 같은 스타일이 있을 때 부모 엘리먼트에 의존적이지 않아야하는 경우 유용합니다.

Example

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

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

Parameters​

NameTypeDescription
elementIdPropsWithChildren<Props>부모 엘리먼트가 아닌 다른 DOM 트리의 elementId값

Returns​

null | ReactPortal

Defined in​

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 7c38274..6686f2b 100644 --- a/docs/react/modules/hooks.html +++ b/docs/react/modules/hooks.html @@ -4,15 +4,15 @@ Module: hooks | @nf-team/frontend-libraries - +
-
본문으로 건너뛰기

Module: hooks

Functions​

useActionKeyEvent​

▸ useActionKeyEvent<T, U>(targetKeys, callback?): ActionKeyEvent<T, U>

Type parameters​

NameType
TElement
Uextends unknown[] = []

Parameters​

NameType
targetKeysstring | string[]
callback?(event: KeyboardEvent<T>, ...args: U) => void

Returns​

ActionKeyEvent<T, U>

Defined in​

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

useBoolean​

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

Description

boolean 타입으로만 반환하는 useState를 쉽게 사용할 수 있는 hook 입니다.

Example

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

Parameters​

NameTypeDefault valueDescription
initialValuebooleanfalse초기값을 세팅

Returns​

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

Defined in​

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

useDebounce​

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

Type parameters​

Name
T

Parameters​

NameType
valueT
delay?number

Returns​

T

Defined in​

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

useEffectOnce​

▸ useEffectOnce(effect): void

Parameters​

NameType
effectEffectCallback

Returns​

void

Defined in​

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

useIsFirstRender​

▸ useIsFirstRender(): boolean

Returns​

boolean

Defined in​

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

useIsMounted​

▸ useIsMounted(): boolean

Description

Component의 mount 여부를 확인하는 hook 입니다.
-SSR 환경에서 실제로 컴포넌트가 브라우저에서 mount 된 이후에 어떤 동작을 실행하기 위해서 사용합니다.

Example

const isMounted = useIsMounted();

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

Returns​

boolean

Defined in​

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

useIsomorphicLayoutEffect​

▸ useIsomorphicLayoutEffect(effect, deps?): void

Accepts a function that contains imperative, possibly effectful code.

Version

16.8.0

See

https://react.dev/reference/react/useEffect

Parameters​

NameTypeDescription
effectEffectCallbackImperative function that can return a cleanup function
deps?DependencyListIf present, effect will only activate if the values in the list change.

Returns​

void

Defined in​

node_modules/@types/react/ts5.0/index.d.ts:1064

useLessThenScrollY​

▸ useLessThenScrollY(targetScrollY?, delay?): boolean

Parameters​

NameTypeDefault value
targetScrollYnumber0
delaynumber200

Returns​

boolean

Defined in​

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

useResizeViewportHeight​

▸ useResizeViewportHeight(): void

Description

스크롤을 포함한 window의 높이를 가져와 window 크기를 resize해줍니다.
-모바일 환경의 웹뷰에서 디바이스 및 브라우저 환경에 따라 크기가 달라져 불필요한 스크롤이 생길 수 있습니다. 이때 이 hook을 사용하면 유용합니다.

Example

function SampleComponent() {
  useResizeViewportHeight();

  return <div>sample text</div>
}

Returns​

void

Defined in​

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

useThrottleCallback​

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

Type parameters​

NameType
Uextends never[]

Parameters​

NameType
callback(...args: U) => void
dependencyListDependencyList
delaynumber

Returns​

fn

▸ (...args): void

Parameters​
NameType
...argsU
Returns​

void

Defined in​

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

useTimeout​

▸ useTimeout(callback, delay): void

Parameters​

NameType
callback() => void
delaynull | number

Returns​

void

Defined in​

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

useUnmount​

▸ useUnmount(fn): void

Parameters​

NameType
fn() => void

Returns​

void

Defined in​

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

useUpdateEffect​

▸ useUpdateEffect(effect, deps?): void

Parameters​

NameType
effectEffectCallback
deps?DependencyList

Returns​

void

Defined in​

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

- +
본문으로 건너뛰기

Module: hooks

Functions​

useActionKeyEvent​

▸ useActionKeyEvent<T, U>(targetKeys, callback?): ActionKeyEvent<T, U>

Type parameters​

NameType
TElement
Uextends unknown[] = []

Parameters​

NameType
targetKeysstring | string[]
callback?(event: KeyboardEvent<T>, ...args: U) => void

Returns​

ActionKeyEvent<T, U>

Defined in​

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

useBoolean​

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

Description

boolean 타입으로만 반환하는 useState를 쉽게 사용할 수 있는 hook 입니다.

Example

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

Parameters​

NameTypeDefault valueDescription
initialValuebooleanfalse초기값을 세팅

Returns​

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

Defined in​

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

useDebounce​

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

Type parameters​

Name
T

Parameters​

NameType
valueT
delay?number

Returns​

T

Defined in​

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

useEffectOnce​

▸ useEffectOnce(effect): void

Parameters​

NameType
effectEffectCallback

Returns​

void

Defined in​

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

useIsFirstRender​

▸ useIsFirstRender(): boolean

Returns​

boolean

Defined in​

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

useIsMounted​

▸ useIsMounted(): boolean

Description

Component의 mount 여부를 확인하는 hook 입니다.
+SSR 환경에서 실제로 컴포넌트가 브라우저에서 mount 된 이후에 어떤 동작을 실행하기 위해서 사용합니다.

Example

const isMounted = useIsMounted();

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

Returns​

boolean

Defined in​

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

useIsomorphicLayoutEffect​

▸ useIsomorphicLayoutEffect(effect, deps?): void

Accepts a function that contains imperative, possibly effectful code.

Version

16.8.0

See

https://react.dev/reference/react/useEffect

Parameters​

NameTypeDescription
effectEffectCallbackImperative function that can return a cleanup function
deps?DependencyListIf present, effect will only activate if the values in the list change.

Returns​

void

Defined in​

node_modules/@types/react/ts5.0/index.d.ts:1064

useLessThenScrollY​

▸ useLessThenScrollY(targetScrollY?, delay?): boolean

Parameters​

NameTypeDefault value
targetScrollYnumber0
delaynumber200

Returns​

boolean

Defined in​

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

useResizeViewportHeight​

▸ useResizeViewportHeight(): void

Description

스크롤을 포함한 window의 높이를 가져와 window 크기를 resize해줍니다.
+모바일 환경의 웹뷰에서 디바이스 및 브라우저 환경에 따라 크기가 달라져 불필요한 스크롤이 생길 수 있습니다. 이때 이 hook을 사용하면 유용합니다.

Example

function SampleComponent() {
  useResizeViewportHeight();

  return <div>sample text</div>
}

Returns​

void

Defined in​

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

useThrottleCallback​

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

Type parameters​

NameType
Uextends never[]

Parameters​

NameType
callback(...args: U) => void
dependencyListDependencyList
delaynumber

Returns​

fn

▸ (...args): void

Parameters​
NameType
...argsU
Returns​

void

Defined in​

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

useTimeout​

▸ useTimeout(callback, delay): void

Parameters​

NameType
callback() => void
delaynull | number

Returns​

void

Defined in​

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

useUnmount​

▸ useUnmount(fn): void

Parameters​

NameType
fn() => void

Returns​

void

Defined in​

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

useUpdateEffect​

▸ useUpdateEffect(effect, deps?): void

Parameters​

NameType
effectEffectCallback
deps?DependencyList

Returns​

void

Defined in​

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

+ \ No newline at end of file diff --git a/index.html b/index.html index 7916e8a..188e7a8 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ @nf-team/frontend-libraries | @nf-team/frontend-libraries - +
본문으로 건너뛰기

@nf-team/frontend-libraries

@mbti-nf-team 프론트엔드 라이브러리 모음

문서 보러가기
Easy to Use

@nf-team/core

Focus on What Matters

@nf-team/react

Powered by React

@nf-team/eslint-config

- + \ No newline at end of file