npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-use-exceljs

v1.1.1

Published

A thin wrapper around the [exceljs](https://github.com/exceljs/exceljs) package that uses [file-saver](https://github.com/eligrey/FileSaver.js) for generating excel files.

Downloads

612

Readme

react-use-exceljs

A thin wrapper around the exceljs package that uses file-saver for generating excel files.

Usage

import { useExcelJS } from "react-use-exceljs"

const data = [
  { id: 1, name: "Jane Doe", dob: new Date(1984, 6, 7) },
  { id: 2, name: "John Doe", dob: new Date(1965, 1, 7) },
]

function App() {
  const excel = useExcelJS({
    filename: "testing.xlsx",
    worksheets: [
      {
        name: "Sheet 1",
        columns: [
          {
            header: "Id",
            key: "id",
            width: 10,
          },
          {
            header: "Name",
            key: "name",
            width: 32,
          },
          {
            header: "D.O.B.",
            key: "dob",
            width: 200,
          },
        ],
      },
    ],
  })

  const onClick = () => {
    excel.download(data)
  }
  
  return (
    <div>
      <button onClick={onClick}>Download</button>
    </div>
  )
}

Worksheets can use different sets of data if download() is passed a Record<SheetName, Array<any>>.

const people = [
  { id: 1, name: "Jane Doe", dob: new Date(1984, 6, 7) },
  { id: 2, name: "John Doe", dob: new Date(1965, 1, 7) },
]

const cities = [
  { city: 'Dallas' },
  { city: 'New York' },
  { city: 'Miami' },
]

function App() {
  const excel = useExcelJS({
    filename: "testing.xlsx",
    worksheets: [
      {
        name: "People",
        columns: [
          {
            header: "Id",
            key: "id",
            width: 10,
          },
          {
            header: "Name",
            key: "name",
            width: 32,
          },
          {
            header: "D.O.B.",
            key: "dob",
            width: 200,
          },
        ],
      },
      {
        name: "Cities",
        columns: [
          {
            header: "City",
            key: "city",
          },
        ],
      },
    ],
  })

  const onClick = () => {
    excel.download({ People: people, Cities: cities })
  }
  
  return (
    <div>
      <button onClick={onClick}>Download</button>
    </div>
  )
}

You can pass an intercept function that will provide the generated workbook for you to modify before it is downloaded.

const excel = useExcelJS({
  filename: "testing.xlsx",
  intercept: (workbook) => {
    workbook.getWorksheet("Sheet 1").getColumn("id").fill = {
      type: "pattern",
      pattern: "solid",
      fgColor: { argb: "55e6ed" },
    }
  },
  worksheets: [
    {
      name: "Sheet 1",
      columns: [
        {
          header: "Id",
          key: "id",
          width: 10,
        },
      ],
    },
  ],
})

You can also use the non-hook function version which the useExcelJS uses internally.

import { downloadExcelJS } from 'react-use-exceljs'

const onClick = () => {
  downloadExcelJS({
    filename: "testing.xlsx",
    data: [
      {id: 1},
      {id: 2}
    ],
    worksheets: [
      {
        name: "Sheet 1",
        columns: [
          {
            header: "Id",
            key: "id",
            width: 10,
          },
        ],
      },
    ],
  }) 
}

Optimization

The file-saver and the rather large exceljs packages are lazily loaded on initiation of an excel download.