list-item

list-item

Generate a single formatted list item, allowing you to easily generate lists with proper indentation, bullets, numbers or other leading characters.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save list-item

Usage

const listitem = require('list-item');

Examples

Basic list

Generate a list using default bullets and indentation:

const listitem = require('list-item');
const li = listitem();

let list = ['a', 'b', 'c', 'd', 'e'].map((ele, i) => li(i, ele));
console.log(list.join('\n'));

Results in:

- a
  * b
    + c
      - d
        * e

Roman numerals

Generate roman numerals in increments of 10.

const listitem = require('list-item');
const romanize = require('romanize');

// specify `chars` to pass to fill-range, and use the callback 
// to modify generated numerals
const li = listitem({ chars: '1..100..10' }, (indent, ch) => {
  return indent + romanize(ch) + '.';
});

// generate a formatted list!
let list = ['a', 'b', 'c', 'd', 'e'].map((ele, i) => li(i, ele));
console.log(list.join('\n'));

Results in:

I. a
  XI. b
    XXI. c
      XXXI. d
        XLI. e

API

listitem

Returns a function to generate a plain-text/markdown list-item, allowing options to be cached for subsequent calls.

Params

• options {Object}: pass options to customize list item characters, indentation, etc.
• options.nobullet {Boolean}: Pass true if you only want the list iten and identation, but no bullets.
• options.indent {String}: The amount of leading indentation to use. default is ``.
• options.chars {String|Array}: If a string is passed, fill-range will be used to generate an array of bullets (visit fill-range to see all options.) Or directly pass an array of bullets, numbers, letters or other characters to use for each list item. Default ['-', '*', '+']
• fn {Function}: pass a function fill-range to modify the bullet for an item as it's generated. See the examples.
• returns {String}: returns a formatted list item

Example

const li = listitem(options);

li(0, 'Level 0 list item');
//=> '- Level 0 list item'

li(1, 'Level 1 list item');
//=> '  * Level 1 list item'

li(2, 'Level 2 list item');
//=> '    + Level 2 list item'

Release History

2.0.0 - July 5, 2018

Breaking changes

• The callback signature has changed to (indent, char, level).

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

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:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• deromanize: Convert roman numerals to arabic numbers (useful for books, outlines, documentation, slide decks, etc) | homepage
• fill-range: Fill in a range of numbers or letters, optionally passing an increment or step to… more | homepage
• randomatic: Generate randomized strings of a specified length using simple character sequences. The original generate-password. | homepage
• romanize: Convert numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc) | homepage
• to-regex-range: Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… more | homepage

Contributors

Commits	Contributor
18	jonschlinkert
7	adjohnson916

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on July 05, 2018.