# @types/react-loading-overlay

> TypeScript definitions for react-loading-overlay

Latest version **1.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-loading-overlay
pnpm add @types/react-loading-overlay
yarn add @types/react-loading-overlay
bun add @types/react-loading-overlay
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-11-07 |
| First published | 2021-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-loading-overlay
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-loading-overlay
- npm.io page: https://npm.io/package/@types/react-loading-overlay

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 1.0.4 (latest) — 2023-11-07
- 1.0.1 (ts3.8) — 2021-12-24
- 1.0.0 (ts3.6) — 2021-07-02
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-loading-overlay`

# Summary
This package contains type definitions for react-loading-overlay (https://github.com/derrickpelletier/react-loading-overlay).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-loading-overlay.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-loading-overlay/index.d.ts)
````ts
import * as React from "react";
export interface LoadingOverlayProps {
    /** default: ``true`` - whether the loader is visible. */
    active?: boolean;

    /** default: ``500`` - the transition speed for fading out the overlay. */
    fadeSpeed?: number;

    /** default: ``undefined`` - click handler for the overlay when active. */
    onClick?: React.MouseEventHandler<HTMLDivElement>;

    /**
     * default: ``undefined`` - the className for the wrapping ``<div />`` that
     *  is present whether active or not.
     */
    className?: string;

    /**
     * default: ``_loading_overlay_`` - the prefix for all classNames on the
     * generated elements. see Styling for more info.
     */
    classNamePrefix?: string;

    /**
     * default: ``false`` - renders the default spinner when true (and when the
     * loader is active). Otherwise you can provide any valid react node to use
     * your own spinner.
     */
    spinner?: boolean | React.ReactNode;

    /**
     * default: ``undefined`` - the text or react node to render in the loader overlay when active.
     */
    text?: React.ReactNode;

    /**
     * default: ``undefined`` - see Styling for more info.
     */
    styles?: {
        content?: (base: React.CSSProperties) => React.CSSProperties;
        overlay?: (base: React.CSSProperties) => React.CSSProperties;
        spinner?: (base: React.CSSProperties) => React.CSSProperties;
        wrapper?: (base: React.CSSProperties) => React.CSSProperties;
    };
}

declare class LoadingOverlay extends React.Component<LoadingOverlayProps> {}
export default LoadingOverlay;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by .

---
_Source: https://npm.io/package/@types/react-loading-overlay · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._