ink-use-stream-dimensions

React hook to get the columns and rows of a stream (likely stdout) in Ink

This library is ESM compatible.

Install

npm install ink-use-stream-dimensions

API

useStreamDimensions(stdout: ConsoleStream): [number, number]

ConsoleStream is any type that contais:

• rows as a number
• columns as a number
• on, handler with signature (event: "resize", callback: () => void) => void
• off, handler with signature (event: "resize", callback: () => void) => void

(useStdout returns the stdout object which already has that signature)

It returns the columns and rows, and subscribes to changes to them

Example

:warning: This is my first published package. I am trying to make it compatible with ESM and CJS. If you find any issue importing the library, feel free to file a bug

1import React from 'react'
2import { Box, Text, useStdout } from "ink"
3import { useStreamDimensions } from "ink-use-stream-dimensions"
4
5
6function MyApp() {
7   const { stdout } = useStdout()
8   const [columns, rows] = useStreamDimensions(stdout)
9
10   return (
11    <Box>
12      <Text>
13        {columns}x{rows}
14      </Text>
15    </Box>
16   )
17}
18
19export default MyApp

License

This project is licensed under the Unlicense - see the LICENSE file for details.