@mskcc/carbon-react
Version:
Carbon react components for the MSKCC DSM
63 lines (62 loc) • 2.02 kB
TypeScript
/**
* MSKCC DSM 2021, 2023
*/
/// <reference types="react" />
import PropTypes from 'prop-types';
import { ReactAttr } from '../../types/common';
export interface LoadingProps extends ReactAttr<HTMLDivElement> {
/**
* Specify whether you want the loading indicator to be spinning or not
*/
active?: boolean;
/**
* Provide an optional className to be applied to the containing node
*/
className?: string;
/**
* Specify a description that would be used to best describe the loading state
*/
description?: string;
/**
* @deprecated The prop `id` is no longer needed
*/
id?: string;
/**
* Specify whether you would like the small variant of <Loading>
*/
small?: boolean;
/**
* Specify whether you want the loader to be applied with an overlay
*/
withOverlay: boolean;
}
declare function Loading({ active, className: customClassName, withOverlay, small, description, ...rest }: LoadingProps): JSX.Element;
declare namespace Loading {
var propTypes: {
/**
* Specify whether you want the loading indicator to be spinning or not
*/
active: PropTypes.Requireable<boolean>;
/**
* Provide an optional className to be applied to the containing node
*/
className: PropTypes.Requireable<string>;
/**
* Specify a description that would be used to best describe the loading state
*/
description: PropTypes.Requireable<string>;
/**
* Provide an `id` to uniquely identify the label
*/
id: (props: any, propName: any, componentName: any, ...rest: any[]) => any;
/**
* Specify whether you would like the small variant of <Loading>
*/
small: PropTypes.Requireable<boolean>;
/**
* Specify whether you want the loader to be applied with an overlay
*/
withOverlay: PropTypes.Requireable<boolean>;
};
}
export default Loading;