# freezeui

> FreezeUI is a dead simple, responsive, vanilla javascript loading plugin. No jQuery required.

Latest version **1.0.1** (published 2020-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install freezeui
pnpm add freezeui
yarn add freezeui
bun add freezeui
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-03-26 |
| First published | 2020-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rheznendra Praditya |
| Maintainers | rheznendra |

## Links

- npm: https://www.npmjs.com/package/freezeui
- Repository: https://github.com/rheznendra/FreezeUI
- Issues: https://github.com/rheznendra/FreezeUI/issues
- npm.io page: https://npm.io/package/freezeui

## Recent versions

- 1.0.1 (latest) — 2020-03-26

## README

# FreezeUI
FreezeUI is a dead simple, responsive, vanilla javascript loading plugin. 
No jQuery required.

**Demo and examples:** [alex-radulescu.com/freeze-ui](http://alexradulescu.github.io/freeze-ui/)

## Installation

Add the css and the script to your project:
```html
<html>
  <head>
    ...
    <link href="/path/to/freeze-ui.min.css" type="text/css" rel="stylesheet"/>
  </head>
  <body>
    ...
    <script src="/path/to/freeze-ui.min.js" type="text/javascript"></script>
  </body>
</html>
```
## Usage

### Basic

```javascript
// Freeze the UI
FreezeUI();

// Un Freeze the UI 
UnFreezeUI();
```


## Options
You can set some options when calling the FreezeUI function.

Param | Type | Default | Details
------------ | ------------- | ------------- | -------------
text | `string` | Loading | The text to be displayed. 
selector | `string` | <body> of the document | The loading can be applied only to an element, as long as the element has position absolute or fixed.

### Examples
```javascript
FreezeUI(); // To simply freeze the whole page
FreezeUI({ text: 'Custom text' }); // Freeze with a custom text
FreezeUI({ selector: '.class-name' }); // Freeze a certain component.
FreezeUI({ selector: '#id-name' }); // The component must have position: fixed or absolute to work
FreezeUI({ selector: '.component', text: 'Getting there...' }) // Using both options at the same time. 
UnFreezeUI(); // Will unfreeze any and all options from above
```

## Licence
FreezeUI is under [MIT licence](https://opensource.org/licenses/mit-license.php)

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