https://github.com/enquirer/terminal-paginator
This repository has been archived, use Enquirer instead.
https://github.com/enquirer/terminal-paginator
Last synced: 3 months ago
JSON representation
This repository has been archived, use Enquirer instead.
- Host: GitHub
- URL: https://github.com/enquirer/terminal-paginator
- Owner: enquirer
- License: mit
- Created: 2016-08-29T00:55:43.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T12:36:43.000Z (about 8 years ago)
- Last Synced: 2024-04-25T03:02:35.989Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://github.com/enquirer/enquirer
- Size: 19.5 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# terminal-paginator [](https://www.npmjs.com/package/terminal-paginator) [](https://npmjs.org/package/terminal-paginator) [](https://npmjs.org/package/terminal-paginator)
> Paginator used for rendering lists or choices for prompts in the terminal.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save terminal-paginator
```
## Usage
```js
var Paginator = require('terminal-paginator');
var paginator = new Paginator();
paginator.paginate(string, selectedIndex, pageLimit);
```
## Attribution
Based on the Paginator in Inquirer.
## About
### Related projects
* [choices-separator](https://www.npmjs.com/package/choices-separator): Separator for choices arrays in prompts. Based on the Separator from inquirer. | [homepage](https://github.com/enquirer/choices-separator "Separator for choices arrays in prompts. Based on the Separator from inquirer.")
* [enquirer](https://www.npmjs.com/package/enquirer): Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… [more](https://github.com/enquirer/enquirer) | [homepage](https://github.com/enquirer/enquirer "Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all the same prompt types and more, but without the bloat.")
* [prompt-choices](https://www.npmjs.com/package/prompt-choices): Create an array of multiple choice objects for use in prompts. | [homepage](https://github.com/enquirer/prompt-choices "Create an array of multiple choice objects for use in prompts.")
* [readline-utils](https://www.npmjs.com/package/readline-utils): Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more. | [homepage](https://github.com/enquirer/readline-utils "Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 24, 2017._