@itwin/core-react
Version:
A react component library of iTwin.js UI general purpose components
37 lines • 1.42 kB
TypeScript
/** @packageDocumentation
* @module Loading
*/
import "./LoadingSpinner.scss";
import * as React from "react";
import { ProgressRadial } from "@itwin/itwinui-react";
type ProgressRadialProps = React.ComponentPropsWithoutRef<typeof ProgressRadial>;
/** Type for ProgressRadialProps.size
* @public
* @deprecated in 4.12.0. Type used in a deprecated component {@link LoadingSpinner}.
*/
export type RadialSizeType = ProgressRadialProps["size"];
/** Properties for [[LoadingSpinner]] component
* @public
* @deprecated in 4.12.0. Props of deprecated component {@link LoadingSpinner}.
*/
export interface LoadingSpinnerProps extends Omit<ProgressRadialProps, "size"> {
/** Message (text) displayed */
message?: string;
/** Position the message above or below the spinner (defaults to bottom) */
messageOnTop?: boolean;
/**
* Size of the progress indicator. Defaults to medium size.
* @default ''
*/
size?: RadialSizeType;
}
/** A loading spinner component that optionally shows a text message.
* @public
* @deprecated in 4.12.0. Use {@link https://itwinui.bentley.com/docs/progressindicator#progress-radial iTwinUI progress indicator} instead.
*/
export declare class LoadingSpinner extends React.PureComponent<LoadingSpinnerProps> {
static defaultProps: Partial<LoadingSpinnerProps>;
render(): React.JSX.Element;
}
export {};
//# sourceMappingURL=LoadingSpinner.d.ts.map