https://github.com/zheeeng/react-remountable

Maybe you need the remount api for re-mounting a React Component
https://github.com/zheeeng/react-remountable

forcemount react remount remountable typescript

Last synced: about 1 year ago
JSON representation

Maybe you need the remount api for re-mounting a React Component

• Host: GitHub
• URL: https://github.com/zheeeng/react-remountable
• Owner: zheeeng
• License: mit
• Created: 2018-04-06T05:39:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-25T06:07:35.000Z (about 3 years ago)
• Last Synced: 2025-03-24T13:02:57.158Z (about 1 year ago)
• Topics: forcemount, react, remount, remountable, typescript
• Language: TypeScript
• Homepage:
• Size: 20.5 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# react-remountable

[![NPM](https://nodei.co/npm/react-remountable.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/react-remountable/)

[![language](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](http://typescriptlang.org/)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()

[![npm version](https://img.shields.io/npm/v/react-remountable.svg)](https://www.npmjs.com/package/react-remountable)

* provides an API `remount` as prop for re-mounting component

* resets stateful component to initial state

* just use it like using the `ReactComponent::forceUpdate` API

* re-calls phases: `componentWillUnmount` -> `constructor` -> `static getDerivedStateFromProps(v16.3+)` -> `render` -> collect refs ->  `componentDidMount`

## Why

We may need:

* Refresh a component locally

* Discard the mutated state data

* Trigger some component life-cycle hooks

## Installation

```

yarn add react-remountable

```

or

```

npm install -s react-remountable

```

## Example:

```jsx

import remountable from 'react-remountable'

import { StatefulForm1, StatefulForm2, StatefulForm3 } from './Forms'

@remountable  // decorator syntax

export default class Dashboard extends React.Component {

    state = { greeting: '', whatsUp: '' }

    focusRef = (ref) => ref && ref.focus()

    handleWhatsUpChange = (e) => {

        this.setState({ whatsUp: e.target.value })

    }

    handleReset = () => {

        // 1. send log

        // 2. re-render/refresh Dashboard component and its stateful children components

        // 3. auto focus on the text input

        // 4. fetch today's greeting and render it

        this.props.remount()

    }

    async componentDidMount () {

        const { greeting } = await fetch('api.example.com/greeting').then(response.json())

        this.setState({ greeting })

    }

    render () {

        return (

            


                
{this.state.greeting}

                

                

                

                

                Reset

            

        )

    }


    componentWillUnmount () {

        fetch('api.example.com/log', { method: 'POST', body: JSON.stringify({ action: 'reset'}) })

    }

}

```

If the ESNext decorator syntax is not enabled:

```js

export default remountable(Dashboard)

```

## Enjoy it!