ink-component-table
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

Welcome to ink-component-table 👋

npm version CI status Code Coverage
Maintenance License: MIT Twitter: matthewtole

A table component for Ink.

Installation

npm install --save ink-component-table

Demo

Screen recording of the component demo

npm run build && npm run demo

Usage

import {Table} from 'ink-component-table';
 
render(
  <Table columnWidths={[10, 20, 30]}>
    <Table.Header>
      <Table.Row>
        <Table.Cell>ID</Table.Cell>
        <Table.Cell>Name</Table.Cell>
        <Table.Cell>Email</Table.Cell>
      </Table.Row>
    </Table.Header>
    <Table.Body>
      <Table.Row>
        <Table.Cell>123</Table.Cell>
        <Table.Cell>Matthew</Table.Cell>
        <Table.Cell>matthewtole@gmail.com</Table.Cell>
      </Table.Row>
    </Table.Body>
  </Table>
);

Run tests

# You will need to build the library first 
npm run build
npm run test

Author

👤 Matthew Tole matthewtole@gmail.com

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Matthew Tole matthewtole@gmail.com.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

Readme

Keywords

none

Package Sidebar

Install

npm i ink-component-table

Weekly Downloads

1

Version

1.4.0

License

MIT

Unpacked Size

127 kB

Total Files

6

Last publish

Collaborators

  • matthewtole