diff --git a/README.md b/README.md index a9ef8e5..c19c9eb 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,8 @@ - [useSwitchTransition(state, timeout, mode)](#useswitchtransitionstate-timeout-mode) - [Transition](#transition-1) - [SwitchTransition](#switchtransition-1) + - [ListTransition](#listtransition) +- [Also see these amazing hooks](#also-see-these-amazing-hooks) - [License](#license) ## Installation @@ -238,6 +240,27 @@ FaCC pattern version of useSwitchTransition | `mode` | `default` \| `out-in` \| `in-out` | **Optional**. Default to `default` mode | | `children` | `(state: any, stage: Stage)=>React.ReactNode` | **Required**. FaCC pattern. | +### ListTransition + +```jsx + + {(item, stage)=>

{item}

} +
+``` + +| Props | Type | Description | +| :--------- | :------------------------------------------- | :------------------------------------------------------------ | +| `list` | `Array` | **Required**. Your array state | +| `timeout` | `number` | **Required**. How long before the animation ends and unmounts | +| `children` | `(item: any, stage: Stage)=>React.ReactNode` | **Required**. FaCC pattern. | + +## Also see these amazing hooks + +| Repo | Intro | +| :------------------------------------------------------------------------ | :-------------------------------------------------------- | +| [🧻 infinite-scroll-hook](https://github.com/iamyoki/infinite-scroll-hook) | Scroll down to load more never been so easy! | +| [☄️ transition-hook](https://github.com/iamyoki/transition-hook) | An extremely light-weight react transition animation hook | + ## License [MIT](https://choosealicense.com/licenses/mit/)