# rem-help

> quickly add rem to your project

Latest version **1.0.1** (published 2020-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install rem-help
pnpm add rem-help
yarn add rem-help
bun add rem-help
```

## 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-05-29 |
| First published | 2020-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | jon-millent |
| Maintainers | huaji-millent |
| Keywords | rem, remjs, rem-help |

## Links

- npm: https://www.npmjs.com/package/rem-help
- Repository: https://github.com/Jon-Millent/rem-help
- Homepage: https://github.com/Jon-Millent/rem-help#readme
- Issues: https://github.com/Jon-Millent/rem-help/issues
- npm.io page: https://npm.io/package/rem-help

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-05-29
- 1.0.0 — 2020-05-29

## README

# rem-help
`version 1.0.1` quickly add rem to your project

## Translation
<a href="https://github.com/Jon-Millent/rem-help/blob/master/zh.md">中文</a>

## Install
`yarn add rem-help` & `npm install rem-help --save`

## Use
### import
```js
import RemHelp from 'rem-help'
let rem = new RemHelp()
rem.addRem()
...
```
### browser
```html
<script src="./rem-help.min.js"></script>
<script>
    let rem = new RemHelp()
    rem.addRem()
    ...
</script>
```

## Api
### config
```js
let rem = new RemHelp({
  eventType: 'resize', // type of monitoring events
  scale: 10, // scaling ratio
  maxWidth: 750, // maximum response width
  minWidth: 320, // minimum response width
  auto: true,  // whether to respond to the Resize event
  accuracy: 3, // how many decimal places are reserved
  onResize: function(event, remNumber){ // resize function
  }
})
```
### methods
#### `rem.addRem`
add rem to the browser
```
rem.addRem()
```
#### `rem.removeRem`
remove rem from the browser, also remove related monitoring events.
```
rem.removeRem()
```
## LICENSE
<a href="http://opensource.org/licenses/MIT">MIT</a>

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