elmasse / ink-table

📐A table component for Ink.

ink-table

A table component for Ink.

Install

 npm install ink-table

Usage

const data = [
  {
    name: "Sosa Saunders",
    gender: "male",
    age: 17,
    email: "[e-mail]",
    phone: "[phone]"
  },
  {
    name: "Angelina Kirk",
    gender: "female",
    age: 3,
    email: "[e-mail]",
    phone: "[phone]"
  },
  {
    name: "Bradford Rosales",
    gender: "male",
    age: 20,
    email: "[e-mail]",
    phone: "[phone]"
  },
  {
    name: "Gwen Schroeder",
    gender: "female",
    age: 17,
    email: "[e-mail]",
    phone: "[phone]"
  },
  {
    name: "Ellison Mann",
    gender: "male",
    age: 5,
    email: "[e-mail]",
    phone: "[phone]"
  }
];

const Basic = () => <Table data={data} />;

render(<Basic />);

Props

data array<object>

List of all the values (rows).

padding number

Offset inside each cell. This is considered one side value (set to 2 will have 2 spaces on the left and on the right - 4 combined).

header ({children}) => h

A component used as header cell. Value is passed as children prop. (Recommend using <Color/> with chalk props.)

cell ({children}) => h

A component used as regular cell. Value is passed as children prop. (Recommend using <Color/> with chalk props.)

skeleton ({children}) => h

A component used as skeleton (lines and crosses ...). Value is passed as children prop. (Recommend using <Color/> with chalk props.)

License

MIT © Matic Zavadlal