#cursor #cli #crossterm #terminal #crossplatform

crossterm_cursor

A cross-platform library for moving the terminal cursor

8 releases

✓ Uses Rust 2018 edition

0.2.6 Aug 2, 2019
0.2.5 Jul 25, 2019
0.2.4 Jun 15, 2019
0.2.3 May 20, 2019
0.1.0 Jan 27, 2019

#28 in Command-line interface

Download history 257/week @ 2019-04-19 320/week @ 2019-04-26 284/week @ 2019-05-03 454/week @ 2019-05-10 439/week @ 2019-05-17 368/week @ 2019-05-24 285/week @ 2019-05-31 494/week @ 2019-06-07 462/week @ 2019-06-14 581/week @ 2019-06-21 797/week @ 2019-06-28 642/week @ 2019-07-05 733/week @ 2019-07-12 652/week @ 2019-07-19 714/week @ 2019-07-26

2,254 downloads per month
Used in 9 crates (6 directly)

MIT license

53KB
971 lines

Crossterm Cursor | cross-platform cursor movement.

Lines of Code Latest Version MIT docs Join us on Discord

This crate allows you to move the terminal cursor cross-platform. It supports all UNIX and windows terminals down to windows 7 (not all terminals are tested see Tested Terminals for more info)

This crate is a sub-crate of crossterm to move the cursor, and can be use individually.

Other sub-crates are:

When you want to use other modules as well you might want to use crossterm with feature flags.

Table of contents:

Getting Started

This documentation is only for crossterm_cursor version 0.2. Also, check out the examples folders with detailed examples for all functionality of this crate.

Add the crossterm_cursor package to your Cargo.toml file.

[dependencies]
crossterm_cursor = "0.2"

Import the crossterm_cursor modules you want to use.

extern crate crossterm_cursor;

pub use crossterm_cursor::{cursor, TerminalCursor};

Useful Links

Features

These are the features of this crate:

  • Cross-platform
  • Multithreaded (send, sync)
  • Detailed Documentation
  • Few Dependencies
  • Cursor
    • Moving n times (up, down, left, right)
    • Position (set/get)
    • Store cursor position and resetting to that later
    • Hiding/Showing
    • Blinking Cursor (only some terminals are supporting this)

Command API

My first recommendation is to use the command API because this might replace some of the existing API in the future. Because it is more convenient, faster, and easier to use.

Examples

The examples folder has more complete and verbose examples.

use crossterm_cursor::cursor;

let mut cursor = cursor();

/// Moving the cursor
// Set the cursor to position X: 10, Y: 5 in the terminal
cursor.goto(10,5);

// Move the cursor up,right,down,left 3 cells.
cursor.move_up(3);
cursor.move_right(3);
cursor.move_down(3);
cursor.move_left(3);

/// Safe the current cursor position to recall later
// Goto X: 5 Y: 5
cursor.goto(5,5);
// Safe cursor position: X: 5 Y: 5
cursor.save_position();
// Goto X: 5 Y: 20
cursor.goto(5,20);
// Print at X: 5 Y: 20.
print!("Yea!");
// Reset back to X: 5 Y: 5.
cursor.reset_position();
// Print 'Back' at X: 5 Y: 5.
print!("Back");

// hide cursor
cursor.hide();
// show cursor
cursor.show();
// blink or not blinking of the cursor (not widely supported)
cursor.blink(true)

Tested terminals

  • Windows Powershell
    • Windows 10 (pro)
  • Windows CMD
    • Windows 10 (pro)
    • Windows 8.1 (N)
  • Ubuntu Desktop Terminal
    • Ubuntu 17.10
  • (Arch, Manjaro) KDE Konsole
  • Linux Mint

This crate supports all Unix terminals and windows terminals down to Windows 7 but not all of them have been tested. If you have used this library for a terminal other than the above list without issues feel free to add it to the above list, I really would appreciate it.

Authors

  • Timon Post - Project Owner & creator

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Dependencies

~579KB