テンプレートから Word DOCX を作成・管理する無料 Node.js ライブラリ

Docxtemplater のインストール方法

Docxtemplater をインストールするには、JavaScript 用パッケージマネージャ npm を使用できます。以下のコマンドで正常にインストールしてください。

 npm install --save docxtemplater pizzip

Node.js でテンプレートを使用した Word ドキュメント作成

オープンソースの Docxtemplater ライブラリは、テンプレートを使用して Microsoft Word DOCX ドキュメントを簡単に生成できるようにします。ソフトウェア開発者はキーとバリューのペアを含むオブジェクトを渡すことで、テンプレート内のプレースホルダーに動的データを注入し、最終的な出力ドキュメントを作成できます。以下の例は、既存のテンプレートをロードし、Node.js 環境内で Word ドキュメントを生成する方法を示しています。

const fs = require('fs');
const Docxtemplater = require('docxtemplater');

// Load the template
const content = fs.readFileSync('template.docx', 'binary');
const doc = new Docxtemplater(content);

// Set data to fill placeholders
const data = {
  firstName: 'John',
  lastName: 'Doe'
};

// Replace placeholders with actual data
doc.setData(data);

// Render the document
doc.render();

// Save the generated document
const output = fs.writeFileSync('output.docx', doc.getZip().generate({type: 'nodebuffer'}));

console.log('Document generated successfully!');

Node.js アプリでカスタム関数とフィルタを追加

Docxtemplater ライブラリのカスタム関数とフィルタは、テンプレート内でデータを操作し、特定の処理を実行する高度な機能を提供します。基本的なプレースホルダー置換を超えてライブラリの機能を拡張し、動的コンテンツ生成や複雑なデータ処理が可能になります。テンプレート内でデータを操作したり特定の処理を行うカスタム関数やフィルタを定義できます。以下の例は、開発者がショッピングカート内のアイテム合計価格を計算するカスタム関数と、通貨値をフォーマットするフィルタを実装する方法を示しています。

const fs = require('fs');
const Docxtemplater = require('docxtemplater');

// Define custom function to calculate total price
function calculateTotal(items) {
  return items.reduce((total, item) => total + item.price * item.quantity, 0);
}

// Define custom filter to format currency
function formatCurrency(value) {
  return '$' + value.toFixed(2); // Format as dollars with 2 decimal places
}

// Load the template
const content = fs.readFileSync('template.docx', 'binary');
const doc = new Docxtemplater(content, {
  parser: {
    // Define custom tag for invoking functions
    getFunction: function(tag) {
      if (tag === 'calculateTotal') {
        return calculateTotal;
      }
    },
    // Define custom tag for applying filters
    getFilter: function(tag) {
      if (tag === 'currency') {
        return formatCurrency;
      }
    }
  }
});

// Set data with shopping cart items
const data = {
  items: [
    { name: 'Product 1', price: 10, quantity: 2 },
    { name: 'Product 2', price: 20, quantity: 1 },
    { name: 'Product 3', price: 15, quantity: 3 }
  ]
};

// Replace placeholders with actual data
doc.setData(data);

// Render the document
doc.render();

// Save the generated document
const output = fs.writeFileSync('output.docx', doc.getZip().generate({ type: 'nodebuffer' }));

console.log('Document generated successfully!');

リッチフォーマットのサポート

オープンソースの Docxtemplater は、シンプルなテンプレートベースのアプローチを提供することで、Word ドキュメントの作成と管理のプロセスを簡素化します。Word ドキュメントにおけるリッチフォーマットのサポートとは、フォントスタイル、色、サイズ、配置などさまざまなスタイリング属性を文書内の要素に適用できる機能を指します。テキスト、表、画像、段落、セクション、リスト、箇条書きなどのフォーマットを行い、読みやすさと視覚的魅力を高めます。以下の簡単な例は、文書内のテキストの一部にリッチフォーマットを適用する方法を示しています。

// Render the document with custom parser options for rich formatting
doc.render({
  parser: {
    // Custom tag for interpreting HTML-like tags for rich formatting
    tagToken: function(tag) {
      return {
        tagName: tag.substring(1),
        mode: 'open'
      };
    },
    // Apply rich formatting based on tag names
    commands: {
      b: function(scope, context, tag) {
        return {
          type: 'applyRichText',
          value: { b: true }
        };
      },
      i: function(scope, context, tag) {
        return {
          type: 'applyRichText',
          value: { i: true }
        };
      },
      u: function(scope, context, tag) {
        return {
          type: 'applyRichText',
          value: { u: true }
        };
      },
      strike: function(scope, context, tag) {
        return {
          type: 'applyRichText',
          value: { strike: true }
        };
      }
    }
  }
});

// Save the generated document
const output = fs.writeFileSync('output.docx', doc.getZip().generate({ type: 'nodebuffer' }));

console.log('Document generated successfully!');