@livelybone/use-mounted
v1.0.5
Published
React hook for mounted and unmount, return an object: MutableRefObject<{ mounted: boolean, unmounted: boolean }>
Downloads
15
Maintainers
Readme
@livelybone/use-mounted
pkg.module supported
, which means that you can apply tree-shaking in you project
React hook for mounted and unmounted, return an object: MutableRefObject<{ mounted: boolean, unmounted: boolean }>
repository
https://github.com/livelybone/use-mounted.git
Demo
https://github.com/livelybone/use-mounted#readme
Run Example
Your can see the usage by run the example of the module, here is the step:
- Clone the library
git clone https://github.com/livelybone/use-mounted.git
- Go to the directory
cd your-module-directory
- Install npm dependencies
npm i
(use taobao registry:npm i --registry=http://registry.npm.taobao.org
) - Open service
npm run dev
- See the example(usually is
http://127.0.0.1/examples/test.html
) in your browser
Installation
npm i -S @livelybone/use-mounted
Global name - The variable the module exported in umd
bundle
useMounted
Interface
See what method or params you can use in index.d.ts
import useMounted from '@livelybone/use-mounted'
const Comp = () => {
const mount = useMounted(() => {
console.log('mounted')
return () => console.log('unmounted')
})
console.log(`Is comp mounted? ${mount.current.mounted ? 'Yes' : 'No'}`)
console.log(`Is comp unmounted? ${mount.current.unmounted ? 'Yes' : 'No'}`)
return <div></div>
}
Use in html, see what your can use in CDN: unpkg
<-- use what you want -->
<script src="https://unpkg.com/@livelybone/use-mounted/lib/umd/<--module-->.js"></script>