# ink-use-stdout-dimensions

> React hook for subscribing to stdout dimensions in Ink

Latest version **1.0.5** (published 2020-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install ink-use-stdout-dimensions
pnpm add ink-use-stdout-dimensions
yarn add ink-use-stdout-dimensions
bun add ink-use-stdout-dimensions
```

## 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.5 |
| Published | 2020-01-26 |
| First published | 2020-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Maintainers | cameronhunter |
| Keywords | ink-hook, ink, hook, react, terminal, term, console, command-line, stdout, dimensions |

## Links

- npm: https://www.npmjs.com/package/ink-use-stdout-dimensions
- Repository: https://github.com/cameronhunter/ink-monorepo
- Homepage: https://github.com/cameronhunter/ink-monorepo#readme
- Issues: https://github.com/cameronhunter/ink-monorepo/issues
- npm.io page: https://npm.io/package/ink-use-stdout-dimensions

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2020-01-26
- 1.0.4 — 2020-01-26
- 1.0.3 — 2020-01-26
- 1.0.2 — 2020-01-20
- 1.0.1 — 2020-01-20
- 1.0.0 — 2020-01-20

## README

# ink-use-stdout-dimensions

> React hook for subscribing to stdout dimensions in [Ink](https://github.com/vadimdemedes/ink)

## Install

```
$ npm install ink-use-stdout-dimensions
```

```
$ yarn add ink-use-stdout-dimensions
```

## Usage

```js
import React from 'react';
import { render } from 'ink';
import useStdoutDimensions from 'ink-use-stdout-dimensions';

function Application() {
  const [columns, rows] = useStdoutDimensions();
  return (
    <Text>
      {columns}×{rows}
    </Text>
  );
}

render(<Application />);
```

![Demo of ink-use-stdout-dimensions](https://github.com/cameronhunter/ink-monorepo/blob/master/packages/ink-use-stdout-dimensions/demo.gif?raw=true)

## API

### `useStdoutDimensions(): [number, number]`

Returns initial `stdout` columns and rows and updates values on `resize` events.

## License

MIT © [Cameron Hunter](https://cameronhunter.co.uk)

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