npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ink-use-stream-dimensions

v0.1.2

Published

Get the columns and rows of a stream in a ink app

Downloads

11

Readme

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

import React from 'react'
import { Box, Text, useStdout } from "ink"
import { useStreamDimensions } from "ink-use-stream-dimensions"


function MyApp() {
   const { stdout } = useStdout()
   const [columns, rows] = useStreamDimensions(stdout)

   return (
    <Box>
      <Text>
        {columns}x{rows}
      </Text>
    </Box>
   )
}

export default MyApp

License

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