ink-use-stdout-dimensions

React hook for subscribing to stdout dimensions in Ink

Install

$ npm install ink-use-stdout-dimensions

$ yarn add ink-use-stdout-dimensions

Usage

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 />);

API

useStdoutDimensions(): [number, number]

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

License

MIT © Cameron Hunter