# @uplift-ltd/use-keyboard-visible

> use-keyboard-visible

Latest version **2.0.0** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uplift-ltd/use-keyboard-visible
pnpm add @uplift-ltd/use-keyboard-visible
yarn add @uplift-ltd/use-keyboard-visible
bun add @uplift-ltd/use-keyboard-visible
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-11-06 |
| First published | 2022-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Uplift Agency Ltd. |
| Maintainers | mariusc23 |

## Links

- npm: https://www.npmjs.com/package/@uplift-ltd/use-keyboard-visible
- Repository: https://github.com/uplift-ltd/nexus
- Homepage: https://nexus.uplift.ltd/docs/packages/use-keyboard-visible
- Issues: https://github.com/uplift-ltd/nexus/issues?q=is:open+is:issue+label:use-keyboard-visible
- npm.io page: https://npm.io/package/@uplift-ltd/use-keyboard-visible

## Recent versions

- 2.0.0 (latest) — 2023-11-06
- 2.0.0-alpha.2 (prerelease) — 2023-04-18
- 2.0.0-alpha.1 — 2023-04-18
- 2.0.0-alpha.0 — 2023-04-18
- 1.3.4 — 2023-02-06
- 1.3.4-alpha.0 — 2023-02-06
- 1.3.3 — 2022-12-05
- 1.3.3-alpha.1 — 2022-12-05

## README

# @uplift-ltd/use-keyboard-visible

## Installation

    npm i --save @uplift-ltd/use-keyboard-visible

## API

### useKeyboardVisible

Hook for react-native keyboard visibility.

```ts
import { useKeyboardVisible } from "@uplift-ltd/use-keyboard-visible";

function MyComponent() {
  const keyboardVisible = useKeyboardVisible();
}
```

Defaults to using `keyboardWillShow` and `keyboardWillHide` events. Can pass in `keyboardDidShow`
and `keyboardDidHide` instead.

```ts
import {
  useKeyboardVisible,
  KeyboardShowEvents,
  KeyboardHideEvents,
} from "@uplift-ltd/use-keyboard-visible";

function MyComponent() {
  const keyboardVisible = useKeyboardVisible({
    showEvent: KeyboardShowEvents.keyboardDidShow,
    hideEvent: KeyboardHideEvents.keyboardDidHide,
  });
}
```

---
_Source: https://npm.io/package/@uplift-ltd/use-keyboard-visible · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._