@instructure/ui-react-utils/types/experimental.d.ts

A React utility library made by Instructure Inc.

import { ComponentClass } from 'react';
/**
 * ---
 * category: utilities/react
 * ---
 * Flag React component and component props as experimental.
 * Warnings will display in the console when experimental components/props
 * props are used.
 *
 * ```js-code
 *  class Example extends Component {
 *    static propTypes = {
 *      currentProp: PropTypes.func
 *    }
 *  }
 *  export default experimental(['experimentalProp'])(Example)
 * ```
 *
 * @module experimental
 * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)
 * @param {string} message
 * @return {function} React component flagged as experimental
 */
declare const experimental: (...args: unknown[]) => (ComposedComponent: ComponentClass<any>) => any;
export default experimental;
export { experimental };
//# sourceMappingURL=experimental.d.ts.map