react-appear-hook v1.0.0

react-appear-hook

A React HOC, adding hooks for handling a component enters or exits the viewport.

Add following hooks

• didAppear: Called when a componnet enters the viewport
• didAppearOnce: Same as didAppear but called only once
• didDisappear: Called when a componnet exits the viewport
• didDisappearOnce: Same as didDisappear but called only once

All hooks will receive a param when called: IntersectionObserverEntry

Tip: when react-appear-hook needs to be combined with other decorators or higher-order-components, make sure that react-appear-hook is the innermost (first applied) decorator, this will not affect other HOC behavior, such as MobX observer; otherwise the this in hooks may not correct.

Installation

npm install react-appear-hook --save

Usage

import React, { Component } from 'react';
import withAppear from 'react-appear-hook';

@withAppear({
  didAppear(ioe) {
    console.log('Appeared');
    this.setState({ appeared: true });
  }

  didAppearOnce(ioe) {
    console.log('Once Appeared');
    this.setState({ appeared: true });
  }

  didDisappear(ioe) {
    console.log('Disappeared');
    this.setState({ appeared: false });
  }

  didDisappearOnce(ioe) {
    console.log('Once Disappeared');
    this.setState({ appeared: false });
  }
})
class extends Component {
  state = {
    appeared: false
  }

  render() {
    const { appeared } = this.state;

    return (
      <div>{ appeared ? 'appeared' : 'disappeared' }</div>
    )
  }
}