# safe-area-insets

> Use javascript to get the safe area insets.

Latest version **1.4.1** (published 2019-08-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install safe-area-insets
pnpm add safe-area-insets
yarn add safe-area-insets
bun add safe-area-insets
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.1 |
| Published | 2019-08-21 |
| First published | 2018-03-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 91 |
| Author | Shengqiang Guo |
| Maintainers | guoshengqiang |
| Keywords | safari, iphonex, safeAreaInsets |

## Links

- npm: https://www.npmjs.com/package/safe-area-insets
- Repository: https://github.com/zhetengbiji/safeAreaInsets
- Homepage: https://github.com/zhetengbiji/safeAreaInsets#readme
- Issues: https://github.com/zhetengbiji/safeAreaInsets/issues
- npm.io page: https://npm.io/package/safe-area-insets

## Recent versions

- 1.4.1 (latest) — 2019-08-21
- 1.4.0 — 2019-08-21
- 1.3.2 — 2018-12-07
- 1.3.1 — 2018-06-05
- 1.3.0 — 2018-06-05
- 1.2.4 — 2018-06-05
- 1.2.3 — 2018-05-02
- 1.2.2 — 2018-04-11
- 1.2.1 — 2018-04-09
- 1.2.0 — 2018-04-09
- 1.1.2 — 2018-04-04
- 1.1.1 — 2018-03-27
- 1.1.0 — 2018-03-27
- 1.0.0 — 2018-03-27

## README

# safeAreaInsets

Use javascript to get the safe area insets.

Chinese documentation : [中文文档](https://github.com/zhetengbiji/safeAreaInsets/blob/master/README-CH.md)

## Precondition

* WKWebview
* viewport-fit=cover

## Install

### NPM

```
npm install safe-area-insets --save
```

### UMD

```http
https://unpkg.com/safe-area-insets/out/umd/index.min.js
```

## Use

### Require

```js
const safeAreaInsets = require('safe-area-insets')
```

### Safe Area Info

```js
console.log('safeAreaInsets.support', safeAreaInsets.support)
console.log('safe-area-inset-top', safeAreaInsets.top)
console.log('safe-area-inset-left', safeAreaInsets.left)
console.log('safe-area-inset-right', safeAreaInsets.right)
console.log('safe-area-inset-bottom', safeAreaInsets.bottom)
```

### Listening Change Event

```js
function callback(style){
    console.log(style)
}
// add
safeAreaInsets.onChange(callback)
// remove
safeAreaInsets.offChange(callback)
```

## Related Reading

>[Designing Websites for iPhone X](https://webkit.org/blog/7929/designing-websites-for-iphone-x/)

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