From 1d53cf6a2295d583be146c84e16625ec4b59fc0d Mon Sep 17 00:00:00 2001 From: d0422 Date: Tue, 16 Apr 2024 11:14:10 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EB=AC=B8=EB=B2=95=EC=A0=81=20=EC=98=A4?= =?UTF-8?q?=EB=A5=98=20=EA=B0=9C=EC=84=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8d80c55..441cc36 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ simple hook to change input components(uncontroll component) to controll compone The animation of this package is based on ClassName by default. -So first, declare css classNames that show animations +First, declare css classNames that show animations ```css @keyframes fadeIn { @@ -64,7 +64,7 @@ So first, declare css classNames that show animations } ``` -then, you can use className as parameters of animation hooks +You can then use class names as parameters for the animation hooks. ### useAnimation @@ -72,7 +72,7 @@ useAnimation manages mount/unmountAnimation. `AnimationWrapper`: Apply mount/unmountAnimation to the children prop provided in the AnimationWrapper. you can provide style prop to apply style to Wrapper -`show` : trigger mountAnimation +`show` : triggers the mount animation. `hide` : trigger unmountAnimation and unmount children prop @@ -89,12 +89,12 @@ With "useDragIndexCarousel," you can easily implement a dragable Index Carousel. you can set `startIndex` and `minMove`. -`minMove` : minimum movement that the index goes over. +`minMove` : Minimum movement required for the index to shift. ### useDragCarouselIndex -this hook must be called in carousel provider which is provided by useDragIndexCarousel Component. -carousel provider renders children elements. It already contains `display:flex` property. +This hook should be called within the carousel provider provided by the useDragIndexCarousel component. +carousel provider renders children elements. It already has the `display: flex` property included. you can get current index in carousel children. @@ -108,7 +108,7 @@ you can get current index in carousel children. `startIndex` : specifies the start index. -`infinity` : When the carousel is over, decide whether to return for the first time. +`infinity` : Specifies whether to loop back to the beginning when the carousel reaches the end. #### return values @@ -116,7 +116,7 @@ useCarousel returns `CarouselWrapper`, `next`, `prev`, `index`, `ref`, `isEnd`, `CarouselWrapper`: renders children elements. It already contains `display:flex` property. -`ref`: you have to assign ref to Carousel Wrapper +`ref`: you need to assign a ref to the Carousel Wrapper. `next`: increase index