cli-cursor
Advanced tools
Package description
The cli-cursor npm package allows developers to show or hide the cursor in command-line interfaces. This can be useful when creating CLI tools or applications that require a clean, distraction-free interface, or when the cursor needs to be temporarily hidden during spinner animations or other CLI graphics.
Hide Cursor
This feature hides the cursor in the terminal. It is useful when you want to prevent the cursor from interfering with CLI graphics or output.
const cliCursor = require('cli-cursor');
cliCursor.hide(process.stdout);Show Cursor
This feature shows the cursor in the terminal after it has been hidden. It is useful for restoring the cursor once a CLI operation that required hiding it is complete.
const cliCursor = require('cli-cursor');
cliCursor.show(process.stdout);Toggle Cursor
This feature toggles the visibility of the cursor based on a boolean value. It provides a convenient way to switch between showing and hiding the cursor.
const cliCursor = require('cli-cursor');
const isVisible = true; // This should be a dynamic value based on the current cursor state
cliCursor.toggle(process.stdout, isVisible);The ansi-escapes package provides a collection of ANSI escape codes, including codes to hide and show the cursor. It offers more general functionality for manipulating the terminal, whereas cli-cursor is specifically focused on cursor visibility.
Terminal-kit is a full-featured terminal handling library that includes methods for cursor visibility, among many other terminal manipulation features. It is a more comprehensive solution compared to the focused functionality of cli-cursor.
Inquirer is a library for creating interactive command-line user interfaces. While it does not directly provide methods to hide or show the cursor, it manages cursor visibility internally as part of its UI rendering process, which can be considered a similar functionality in a broader context.
Readme
Toggle the CLI cursor
The cursor is gracefully restored if the process exits.
$ npm install --save cli-cursor
const cliCursor = require('cli-cursor');
cliCursor.hide();
const unicornsAreAwesome = true;
cliCursor.toggle(unicornsAreAwesome);
force is useful to show or hide the cursor based on a boolean.
Type: Stream
Default: process.stderr
MIT © Sindre Sorhus
FAQs
Toggle the CLI cursor
The npm package cli-cursor receives a total of 31,059,584 weekly downloads. As such, cli-cursor popularity was classified as popular.
We found that cli-cursor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.
Security News
ua-parser-js is set to drop the MIT license and adopt a controversial dual AGPLv3 + PRO licensing model in its upcoming v2.0 release, raising significant concerns among developers and enterprise users.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.