0.4.3 • Published 1 year ago

@czkoudy/export-to-excel v0.4.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@czkoudy/export-to-excel

React component for exporting data to Excel

NPM JavaScript Style Guide

Downloads

Install

npm install --save @czkoudy/export-to-excel

Usage

import PaginationTable from '@czkoudy/pagination-table';

const allUsers = [
  {
    firstName: 'Jakub',
    age: 36,
    nationality: 'Czech',
  },
];

const workbookOptions = {
  filename: 'Export of users',
  sheets: [
    {
      name: 'Users',
      options: {
        columns: [{ header: 'First Name' }, { header: 'Age' }, { header: 'Nationality' }],
      },
      data: allUsers,
      keys: [
        {
          label: 'firstName',
          formatValue: (val) => val.toLowerCase(),
        },
        {
          label: 'age',
        },
        {
          label: 'nationality',
        },
      ],
    },
  ],
};

return <ExcelExport options={workbookOptions} />;

API

ExcelExport props

NameTypeRequiredDefault
optionsObjectYes-

options props

NameTypeRequiredDefaultDescription
fileNameStringYes-Name of excel file
sheetsArrayYes-Array of objects representing sheet in workbook

options.sheets props

NameTypeRequiredDefaultDescription
nameStringYes-
optionsObjectYes-
dataArrayYes-
keysArrayYes-

options.sheets.options props

columns: [{ header: 'First Name' }, { header: 'Age' }, { header: 'Nationality' }],

License

MIT © czkoudy

0.4.3

1 year ago

0.4.2

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.3.0

1 year ago

0.2.0

1 year ago

0.1.0

1 year ago