2017-07-22 21:27:38 +05:30
|
|
|
// @flow
|
|
|
|
import React, { PureComponent } from 'react';
|
2016-05-02 22:55:14 +05:30
|
|
|
|
2017-10-28 19:08:07 +05:30
|
|
|
import { omit, debounce } from 'functions';
|
2016-07-29 22:44:52 +05:30
|
|
|
|
2016-05-02 22:55:14 +05:30
|
|
|
/**
|
|
|
|
* MeasureHeight is a component that allows you to measure the height of elements wrapped.
|
|
|
|
*
|
|
|
|
* Each time the height changed, the `onMeasure` prop will be called.
|
|
|
|
* On each component update the `shouldMeasure` prop is being called and depending of
|
|
|
|
* the value returned will be decided whether to call `onMeasure`.
|
|
|
|
* By default `shouldMeasure` will compare the old and new values of the `state` prop.
|
2019-06-09 13:59:54 +05:30
|
|
|
* Both `shouldMeasure` and `state` can be used to reduce the amount of measures, which
|
|
|
|
* will reduce the count of forced reflows in browser.
|
2016-05-02 22:55:14 +05:30
|
|
|
*
|
|
|
|
* Usage:
|
|
|
|
* <MeasureHeight
|
|
|
|
* state={theValueToInvalidateCurrentMeasure}
|
|
|
|
* onMeasure={this.onUpdateContextHeight}
|
|
|
|
* >
|
|
|
|
* <div>some content here</div>
|
|
|
|
* <div>which may be multiple children</div>
|
|
|
|
* </MeasureHeight>
|
|
|
|
*/
|
|
|
|
|
2019-06-09 13:59:54 +05:30
|
|
|
type ChildState = mixed;
|
2019-06-09 13:24:03 +05:30
|
|
|
|
2017-08-23 02:01:41 +05:30
|
|
|
export default class MeasureHeight extends PureComponent<{
|
2019-06-09 13:59:54 +05:30
|
|
|
shouldMeasure: (prevState: ChildState, newState: ChildState) => bool,
|
2017-08-23 02:01:41 +05:30
|
|
|
onMeasure: (height: number) => void,
|
2019-06-09 13:24:03 +05:30
|
|
|
state: ChildState
|
2017-08-23 02:01:41 +05:30
|
|
|
}> {
|
2016-05-02 22:55:14 +05:30
|
|
|
static defaultProps = {
|
2019-06-09 13:24:03 +05:30
|
|
|
shouldMeasure: (prevState: ChildState, newState: ChildState) => prevState !== newState,
|
2018-05-03 10:45:09 +05:30
|
|
|
onMeasure: (height: number) => {} // eslint-disable-line
|
2016-05-02 22:55:14 +05:30
|
|
|
};
|
|
|
|
|
2017-08-04 10:21:41 +05:30
|
|
|
el: ?HTMLDivElement;
|
2016-05-02 22:55:14 +05:30
|
|
|
|
2017-07-22 21:27:38 +05:30
|
|
|
componentDidMount() {
|
2017-11-20 00:02:52 +05:30
|
|
|
// we want to measure height immediately on first mount to avoid ui laggs
|
2016-05-02 22:55:14 +05:30
|
|
|
this.measure();
|
2017-11-20 00:02:52 +05:30
|
|
|
window.addEventListener('resize', this.enqueueMeasurement);
|
2016-05-02 22:55:14 +05:30
|
|
|
}
|
|
|
|
|
2017-07-22 21:27:38 +05:30
|
|
|
componentDidUpdate(prevProps: typeof MeasureHeight.prototype.props) {
|
2016-05-02 22:55:14 +05:30
|
|
|
if (this.props.shouldMeasure(prevProps.state, this.props.state)) {
|
2017-11-20 00:02:52 +05:30
|
|
|
this.enqueueMeasurement();
|
2016-05-02 22:55:14 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-10-24 01:11:11 +05:30
|
|
|
componentWillUnmount() {
|
2017-11-20 00:02:52 +05:30
|
|
|
window.removeEventListener('resize', this.enqueueMeasurement);
|
2017-10-24 01:11:11 +05:30
|
|
|
}
|
|
|
|
|
2016-05-02 22:55:14 +05:30
|
|
|
render() {
|
2017-07-22 21:27:38 +05:30
|
|
|
const props: Object = omit(this.props, [
|
|
|
|
'shouldMeasure',
|
|
|
|
'onMeasure',
|
|
|
|
'state'
|
|
|
|
]);
|
2016-07-29 22:44:52 +05:30
|
|
|
|
2017-07-22 21:27:38 +05:30
|
|
|
return <div {...props} ref={(el: HTMLDivElement) => this.el = el} />;
|
2016-05-02 22:55:14 +05:30
|
|
|
}
|
|
|
|
|
2017-11-20 00:02:52 +05:30
|
|
|
measure = () => {
|
|
|
|
requestAnimationFrame(() => {this.el && this.props.onMeasure(this.el.offsetHeight);});
|
|
|
|
};
|
|
|
|
|
|
|
|
enqueueMeasurement = debounce(this.measure);
|
2016-05-02 22:55:14 +05:30
|
|
|
}
|