https://github.com/brandonhimpfen/html-list-builder
The HTML List Builder is an npm package that allows you to easily create ordered and unordered lists in HTML with class and id attributes as options.
https://github.com/brandonhimpfen/html-list-builder
html html-list html5 list ol ul
Last synced: 2 months ago
JSON representation
The HTML List Builder is an npm package that allows you to easily create ordered and unordered lists in HTML with class and id attributes as options.
- Host: GitHub
- URL: https://github.com/brandonhimpfen/html-list-builder
- Owner: brandonhimpfen
- License: mit
- Created: 2023-06-20T23:18:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T23:46:00.000Z (almost 2 years ago)
- Last Synced: 2025-03-12T09:15:21.809Z (2 months ago)
- Topics: html, html-list, html5, list, ol, ul
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/html-list-builder
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# html-list-builder
[](https://www.npmjs.com/package/html-list-builder)
The HTML List Builder is an npm package that allows you to easily create ordered and unordered lists in HTML with class and id attributes as options. It provides a simple and convenient way to generate lists programmatically.
## Installation
You can install the HTML List Builder package using npm. Run the following command:
```
npm install html-list-builder
```
## Usage
To use the HTML List Builder in your project, require it and call the provided functions:
```
const { createOrderedList, createUnorderedList } = require('html-list-builder');
const items = ['Apple', 'Banana', 'Orange'];
const options = { class: 'fruits', id: 'fruits-list' };
const orderedList = createOrderedList(items, options);
console.log(orderedList);
const unorderedList = createUnorderedList(items, options);
console.log(unorderedList);
```
The `createOrderedList` and `createUnorderedList` functions take an array of items as the first parameter and an options object as the second parameter. The options object can contain `class` and `id`attributes to customize the list element.
## API
### createOrderedList(items, options)
This function generates an ordered list in HTML.
* `items` (Array): An array of strings representing the list items.
* `options` (Object): An optional object with the following properties:
* `class` (String): The class attribute for the `
` element.
* `id` (String): The id attribute for the `` element.
Returns: A string containing the generated ordered list HTML.
### createUnorderedList(items, options)
This function generates an unordered list in HTML.
* `items` (Array): An array of strings representing the list items.
* `options` (Object): An optional object with the following properties:
* `class` (String): The class attribute for the `
` element.
* `id` (String): The id attribute for the `` element.
Returns: A string containing the generated unordered list HTML.