Skip to content

react-component/mutate-observer

Repository files navigation

rc-mutate-observer

MutateObserver for React.

NPM version dumi build status [Codecov][codecov-url] npm download

Development

npm install
npm run start
open http://localhost:8000

Install

@rc-component/mutate-observer

Usage

import React from 'react';
import MutateObserver from './src';

const onMutate = (mutations: MutationRecord[], observer: MutationObserver) => {
  console.log(mutation);
  console.log(observer);
};

const Demo: React.FC = () => {
  return (
    <MutateObserver onMutate={onMutate}>
      <div>test</div>
    </MutateObserver>
  );
};

export default Demo;

🔥 API

We use typescript to create the Type definition. You can view directly in IDE. But you can still check the type definition here.

mutate-observer

Prop Description Type Default
onMutate A function which will be called on each DOM change that qualifies given the observed node or subtree and options MutationCallback -
options An object providing options that describe which DOM mutations should be reported to mutationObserver's callback MutationObserverInit -