Бесплатная библиотека Node.js для создания & управления Word DOCX из шаблонов

Как установить Docxtemplater?

Для установки Docxtemplater вы можете использовать npm, менеджер пакетов для JavaScript. Пожалуйста, выполните следующие команды для успешной установки.

 npm install --save docxtemplater pizzip

Создание документов Word через шаблон в Node.js

Открытая библиотека Docxtemplater упрощает разработчикам генерацию документов Microsoft Word DOCX с использованием шаблона. Разработчики могут внедрять динамические данные в шаблон, передавая объект с парами «ключ‑значение», чтобы заменить заполнители реальными данными и создать окончательный документ. Приведённый пример демонстрирует, как разработчики могут загрузить существующий шаблон и сгенерировать документ Word из него в среде Node.js.

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 означает возможность применять различные стилистические атрибуты, такие как стили шрифтов, цвета, размеры, выравнивание и многое другое к различным элементам внутри документа 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!');