Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TreeFarmer/embed-table
Easily make nice looking text tables for Discord's embed fields and descriptions.
https://github.com/TreeFarmer/embed-table
discord discordjs messageembed table
Last synced: 11 days ago
JSON representation
Easily make nice looking text tables for Discord's embed fields and descriptions.
- Host: GitHub
- URL: https://github.com/TreeFarmer/embed-table
- Owner: TreeFarmer
- License: mit
- Created: 2021-08-24T21:33:00.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-20T04:55:54.000Z (over 1 year ago)
- Last Synced: 2024-09-17T23:53:01.196Z (about 2 months ago)
- Topics: discord, discordjs, messageembed, table
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/embed-table
- Size: 446 KB
- Stars: 12
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - TreeFarmer/embed-table - Easily make nice looking text tables for Discord's embed fields and descriptions. (TypeScript)
README
# Embed-Table
Easily make nice looking text tables for Discord's embed fields and descriptions.
# Installation
Install with `npm install embed-table` and it will be installed.
# Important
- `titles` are the column titles that will display in the **name** value of the Embed Field. The `titleIndexes` are the indexes of where the titles start in the generated string, it is recommended to have the first title at `0`. [**See example below.**](https://www.npmjs.com/package/embed-table#output)
- If the start values are not greater than the previous column name, an error will be thrown about an invalid count value.
- **Make sure** that your `titles`, `titleIndexes` and `columnIndexes` all are the same number of values, or else things get messy. An option to make the field inline is available since the method creates a complete field object.
- It is easiet to manage where your data lines up in the columns when using backticks ( ` ) at the start and end of the rows, this makes any character the same width.
# Basic Usage (with Discord.js v14+)
```ts
import { Table } from 'embed-table';
import { EmbedBuilder } from 'discord.js';
const table = new Table({
titles: ['Level', 'Money', 'Wins'],
titleIndexes: [0, 8, 16],
columnIndexes: [0, 6, 14],
start: '`',
end: '`',
padEnd: 3
});
table.addRow(['1', '$120', '2'], { override: 4 });
table.addRow(['72', '$10', '25'], { override: 0 });
table.addRow(['614', '$1220', '12']);
// Use this 'embed' when sending a message to a channel.
const embed = new EmbedBuilder().setFields(table.toField());
// Use this 'tableString' in a plain text area, (embed description or a regular message)
const string = table.toString();
```
# Embed Output
# API
Read the documentation for embed-table @ [**embed-table.treefarmer.xyz**](https://embed-table.treefarmer.xyz/)
# Contributing
Feel free to contribute however, it is appreciated! Join the community server @ [**treefarmer.xyz/discord**](https://treefarmer.xyz/discord)