From 087f6886058e5dde40bb83ecb7de4b0c8bdde69a Mon Sep 17 00:00:00 2001 From: Shen Junru Date: Wed, 8 Jun 2022 11:38:29 +0800 Subject: [PATCH] docs: update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 817a827..04ce0f9 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,8 @@ ReactDOM.render(( - Wrap your component with `keepLive()` ```JavaScript + import { keepAlive } from 'react-fiber-keep-alive'; + const NewComponent = keepAlive(YourComponent, (props) => { // props: the income props for `` @@ -82,8 +84,19 @@ ReactDOM.render(( }); ``` +- Hook: `useIgnoreKeepAlive()` returns a cache cleaner function. + ```JavaScript + import { useIgnoreKeepAlive } from 'react-fiber-keep-alive'; + + const ignoreCache = useIgnoreKeepAlive(); + + ignoreCache(`unique-key`); + ``` + - If the `render()` of class component has side effects. ```JavaScript + import { markClassComponentHasSideEffectRender } from 'react-fiber-keep-alive'; + markClassComponentHasSideEffectRender(ClassComponent); // Example: @@ -98,6 +111,8 @@ ReactDOM.render(( - If no need to trigger the effect hook while remounting. ```JavaScript + import { markEffectHookIsOnetime } from 'react-fiber-keep-alive'; + markEffectHookIsOnetime(effectHook); // Example: