@blueprintjs/core
Version:
Core styles & components
69 lines • 2.78 kB
JavaScript
/*
* Copyright 2015 Palantir Technologies, Inc. All rights reserved.
*
* Licensed under the terms of the LICENSE file distributed with this project.
*/
import * as tslib_1 from "tslib";
import * as React from "react";
import { isNodeEnv } from "./utils";
/**
* An abstract component that Blueprint components can extend
* in order to add some common functionality like runtime props validation.
*/
var AbstractComponent = /** @class */ (function (_super) {
tslib_1.__extends(AbstractComponent, _super);
function AbstractComponent(props, context) {
var _this = _super.call(this, props, context) || this;
// Not bothering to remove entries when their timeouts finish because clearing invalid ID is a no-op
_this.timeoutIds = [];
/**
* Clear all known timeouts.
*/
_this.clearTimeouts = function () {
if (_this.timeoutIds.length > 0) {
for (var _i = 0, _a = _this.timeoutIds; _i < _a.length; _i++) {
var timeoutId = _a[_i];
window.clearTimeout(timeoutId);
}
_this.timeoutIds = [];
}
};
if (!isNodeEnv("production")) {
_this.validateProps(_this.props);
}
return _this;
}
AbstractComponent.prototype.componentWillReceiveProps = function (nextProps) {
if (!isNodeEnv("production")) {
this.validateProps(nextProps);
}
};
AbstractComponent.prototype.componentWillUnmount = function () {
this.clearTimeouts();
};
/**
* Set a timeout and remember its ID.
* All stored timeouts will be cleared when component unmounts.
* @returns a "cancel" function that will clear timeout when invoked.
*/
AbstractComponent.prototype.setTimeout = function (callback, timeout) {
var handle = window.setTimeout(callback, timeout);
this.timeoutIds.push(handle);
return function () { return window.clearTimeout(handle); };
};
/**
* Ensures that the props specified for a component are valid.
* Implementations should check that props are valid and usually throw an Error if they are not.
* Implementations should not duplicate checks that the type system already guarantees.
*
* This method should be used instead of React's
* [propTypes](https://facebook.github.io/react/docs/reusable-components.html#prop-validation) feature.
* Like propTypes, these runtime checks run only in development mode.
*/
AbstractComponent.prototype.validateProps = function (_) {
// implement in subclass
};
return AbstractComponent;
}(React.Component));
export { AbstractComponent };
//# sourceMappingURL=abstractComponent.js.map