paginator-cl v1.0.0

Paginator

Split and show your text in console with user interaction

This module allows you to split and fit the text in console, dividing it in pages which user can go through.\ I decided to create this based on Inquirer paginator util used on its List prompt, 'cause it's quite useful when creating CLI.

How this works

paginator.print(text:string, pageSize: number, options?: pageOptions)

Firstly, splits the given text to fit well in the console, without intercalated words. Then, with rxjs, observes the keybord input to check if UP or DOWN key is pressed, for moving the page up and down.\

Print

/**
 * Capture key arrows for moving the text UP and DOWN with a determinate PageSize.
 * Use Message option for show an static text above the text.
 * @param {string} text Defines the text to split up and fit in the console.
 * @param {number} pageSize Defines the max number of lines to show in console. Use a positive integer.
 * @param {pageOptions | undefined} options Defines the options.
 * @async Uses Promises, awaiting for the Return key pressed.
 * @returns Promise, resolving in Boolean True.
 */
async paginator.print(text:string, pageSize: number, options?: pageOptions)

Options

interface pageOptions {
  /**
   * Shows an static message above the text.
   */
  message?: string
  /**
   * Shows an static, dim message for help, like '(Use arrow keys)'
   */
  suffix?: string
  /**
   * Shows a message for help to continue executing the code. 'Press return button to exit'
   */
  exitMessage?: string
  /**
   * If true, defines if is neccesary to go trough all the pages to continue.
   */
  read_to_return?: boolean
}

Also, you can define the default options to be used in every print.

paginator.options(options?: pageOptions)

Examples

Simple Lorem Ipsum

var text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua...' // Just a big lorem ipsum
paginator.print(text, 10) // Shows 10 lines per page

Options

var text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua...' // The same big lorem ipsum
paginator.print(text, 10, {
  exitMessage: 'Please, press return to exit :D',
  message: 'A big lorem ipsum!',
  suffix: 'Use those arrows'
})

Know issues

• This doesn't work very well when text uses \n as breaklines.
• With chalk, when the formatted text is splitted in multiple lines, the text is not showed correctly.