/screen

Cross platform terminal screen detection

Primary LanguageCrystalMIT LicenseMIT

term logo

Term::Cursor

spec status

Terminal screen size detection which works on Linux, OS X and Windows/Cygwin platforms (or will once Windows is supported by Crystal)

Term::Screen provides independent terminal screen size detection component for crystal-term.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  cursor:
    github: crystal-term/screen

  2. Run shards install

Usage

require "term-screen"

Term::Screen allows you to detect terminal screen size by calling size method which returns {height, width} tuple.

Term::Screen.size     # => {51, 280}

To read terminal width do:

Term::Screen.width    # => 280
Term::Screen.columns  # => 280
Term::Screen.cols     # => 280

Similarly, to read terminal height do:

Term::Screen.height   # => 51
Term::Screen.rows     # => 51
Term::Screen.lines    # => 51

Contributing

  1. Fork it (https://github.com/crystal-term/cursor/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors