# react-immutable-render-mixin
**Repository Path**: mirrors_fis-components/react-immutable-render-mixin
## Basic Information
- **Project Name**: react-immutable-render-mixin
- **Description**: Fork from https://github.com/jurassix/react-immutable-render-mixin.git
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-10-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
react-immutable-render-mixin
============================
This library exposes 4 distinct options for immutable rendering:
* Mixin for `React.createClass` support
* HoC ( _decorator_ ) for `React.Component`
* shouldComponentUpdate function used by the mixin and HoC
* shallowEqualImmutable function to allow custom `shouldComponentUpdate` implementations
This library when used as a mixin/decorator replaces the [PureRenderMixin](http://facebook.github.io/react/docs/pure-render-mixin.html) when using [facebook/immutable-js](https://github.com/facebook/immutable-js) library with [React](https://github.com/facebook/react)
This Mixin and HoC implements `shouldComponentUpdate` method using prop and state equality with Immutable.is().
We also expose the `shallowEqualImmutable` to allow developers to craft a custom `shouldComponentUpdate` method as needed.
Installation
------------
```sh
npm i react-immutable-render-mixin
```
Usage as Mixin
-----
```js
import immutableRenderMixin from 'react-immutable-render-mixin';
React.createClass({
mixins: [immutableRenderMixin],
render: function() {
return
foo
;
}
});
```
Usage as a HoC
-----
```js
import React from 'react';
import { immutableRenderDecorator } from 'react-immutable-render-mixin';
class Test extends React.Component {
render() {
return ;
}
}
export default immutableRenderDecorator(Test);
```
Usage as Decorator
-----
```js
import React from 'react';
import { immutableRenderDecorator } from 'react-immutable-render-mixin';
@immutableRenderDecorator
class Test extends React.Component {
render() {
return ;
}
}
```
Usage with default `shouldComponentUpdate`
-----
```js
import React from 'react';
import { shouldComponentUpdate } from 'react-immutable-render-mixin';
class Test extends React.Component {
constructor(props) {
super(props);
this.shouldComponentUpdate = shouldComponentUpdate.bind(this);
}
render() {
return ;
}
}
```
Usage with a custom `shouldComponentUpdate`
-----
```js
import React from 'react';
import { shallowEqualImmutable } from 'react-immutable-render-mixin';
class Test extends React.Component {
shouldComponentUpdate(nextProps, nextState) {
return !shallowEqualImmutable(this.props, nextProps) || !shallowEqualImmutable(this.state, nextState);
}
render() {
return ;
}
}
```
Usage with <= ES5
-----
Exports:
```js
var immutableRenderMixin = require('react-immutable-render-mixin').default;
var immutableRenderDecorator = require('react-immutable-render-mixin').immutableRenderDecorator;
var shallowEqualImmutable = require('react-immutable-render-mixin').shallowEqualImmutable;
var shouldComponentUpdate = require('react-immutable-render-mixin').shouldComponentUpdate;
```
Full Example:
```js
var immutableRenderMixin = require('react-immutable-render-mixin').default;
React.createClass({
mixins: [immutableRenderMixin],
render: function() {
return foo
;
}
});
```