XLSX Libs

The project of Excel download modules.

This project has been created by Vessel CLI. For a simple and quick reference about it, click here.

About

프로젝트 개발에 사용되는 모듈들에 대해 집합적인 형태로 제공되는 패키지.

Installation

해당 라이브러리를 사용 할 프로젝트에서는 아래와 같이 의존성 모듈로 설치한다.

$ npm install --save @mornya/xlsx-libs
or
$ yarn add @mornya/xlsx-libs

Modules in the package

본 패키지에는 아래와 같은 모듈들을 포함한다. 제공되는 모듈과 메소드 사용법 등은 코드 스니핏을 참고한다.

XLSX module

샘플 모듈은 다음과 같은 메소드들을 제공한다.

XLSX.Builder

엑셀 워크시트 생성 및 암호화 등의 처리 후 다운로드 한다.

const headers = [
  { label: '순번', key: 'no' },
  { label: '이름', key: 'name' },
  { label: '나이', key: 'age' },
];
const items = [
  { no: 1, name: '김철수', age: 50 },
  { no: 2, name: '신영희', age: 30 },
  { no: 3, name: '홍길동', age: 100 },
];

위와 같은 내용으로 엑셀 데이터를 선언 후,

const option: XLSX.Option = {
  password: 'my@password', // optional
  filename: '친구들.xlsx', // optional
  isShowHeaderIfEmpty: true, // optional
};

const xlsx = new XLSX.Builder(option);

xlsx.addSheet('친구목록', headers);
xlsx.addItems(items);

await xlsx.build();
await xlsx.download();

위와 같은 방식으로 처리하거나, 아래 샘플처럼 옵션 내 비밀번호, 파일명 등은 build 및 download 메소드의 파라미터로 별도 제공해도 된다.

const xlsx = new XLSX.Builder();

xlsx.addSheet('친구목록', headers);
xlsx.addItems(items);

await xlsx.build('my@password'); // 비밀번호 지정
await xlsx.download('친구들.xlsx'); // 다운로드 받을 파일명 지정

동일 엑셀 파일 내 여러 시트를 추가할 경우 addSheet 및 addItems를 아래와 같은 방식으로 계속 추가해주면 된다.

const xlsx = new XLSX.Builder();

// 1번 시트
xlsx
  .addSheet('친구목록#1', headers)
  .addItems(items);

// 2번 시트
xlsx
  .addSheet('친구목록#2', headers)
  .addItems(items)
  .addItems(items);

/* ... */

await xlsx.build();
await xlsx.download('친구들.xlsx');

Change Log

프로젝트 변경사항은 CHANGELOG.md 파일 참조.

License

프로젝트 라이센스는 LICENSE 파일 참조.