Narcissistic Preening Monarch
    Wondering what’s next for npm?Check out our public roadmap! »

    @rooks/use-will-unmount
    TypeScript icon, indicating that this package has built-in type declarations

    4.11.2 • Public • Published

    @rooks/use-will-unmount

    Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

    npm install rooks
    

    or

    yarn add rooks
    

    Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

    TitleCard

    Build Status

    About

    componentWillUnmount lifecycle as hook for React.

    Installation

    npm install --save @rooks/use-will-unmount
    

    Importing the hook

    import useWillUnmount from "@rooks/use-will-unmount"

    Usage

    function Message(){
    
      useWillUnmount(function () {
        alert("unmounted")
      })
      return <p> Message </p>
    }
    
    
    function Demo() {
      const [
        value,
        changeValue
       ] = useState(true);
    
      function toggleValue(){
        changeValue(!value)
      }
    
      return <>
        <p><button onClick={toggleValue}>Toggle show </button></p>
        {value && <Message/>}
      </>;
    }
    
    render(<Demo/>)

    Arguments

    Arguments Type Description Default value
    callback function Callback function which needs to run on unmount undefined

    A React hook for componentWillUnmount lifecycle method.

    Install

    npm i @rooks/use-will-unmount

    DownloadsWeekly Downloads

    284

    Version

    4.11.2

    License

    MIT

    Unpacked Size

    6.42 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar