README.md

Nuxt PDFMake

Easily add pdfMake to your Nuxt 3 application.

• ✨  Release Notes

Documentation

See the documentation here: Nuxt PDFMake

Quick Setup

1. Add nuxt-pdfmake dependency to your project

# Using pnpm
pnpm add -D nuxt-pdfmake

# Using yarn
yarn add --dev nuxt-pdfmake

# Using npm
npm install --save-dev nuxt-pdfmake

2. Add nuxt-pdfmake to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["nuxt-pdfmake"],
});

That's it! You can now use Nuxt PDFMake in your Nuxt app ✨.

Usage

You can use the $pdfMake variable inside a function

const { $pdfMake } = useNuxtApp();

Or you can use the usePDFMake composable

const pdfMake = usePDFMake();

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release