ngx-pdf-export 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mohammed Abdul Shahed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# ngx-pdf-export
+
+A DOM-aware, client-side Angular library that exports a rendered
+Angular/HTML element into a real PDF — with actual selectable, searchable,
+copy-pasteable PDF text — entirely in the browser. No backend, no API
+calls, and no `html2canvas`-style screenshot-to-image pipeline.
+
+```bash
+npm install ngx-pdf-export
+```
+
+```ts
+import { PdfExportService } from 'ngx-pdf-export';
+
+constructor(private pdf: PdfExportService) {}
+
+async exportDashboard() {
+  await this.pdf.download('#dashboard', 'dashboard.pdf', {
+    format: 'A4',
+    orientation: 'landscape',
+  });
+}
+```
+
+It reads the browser's own already-computed layout
+(`getBoundingClientRect`, `getComputedStyle`, and per-line text boxes via
+`Range.getClientRects`) and replays it as real PDF drawing/text operators,
+instead of rasterizing the page. Only the rare element using a CSS feature
+this library doesn't translate (gradients, box-shadow, CSS filters) is
+rasterized — and only that one element, never the whole page.
+
+## Also available
+
+- `PdfExportDirective` (`[pdfExport]`) for template-driven export.
+- `toBlob()` / `download()` / `export()` on `PdfExportService`.
+- `registerFont()` for custom TTF/OTF fonts (required for non-Latin
+  Unicode text — see the Unicode note below).
+- Multi-page pagination with `keepTogether`, `break-before`/`break-after`,
+  and repeated table headers.
+- Headers/footers with page numbers (`Page X of Y`).
+- A `debug: true` mode that outlines page boundaries and rasterized
+  fallback elements directly on the output PDF.
+
+## Unicode note
+
+The default (Standard-14) fonts only support Latin-1-ish text. For ₹,
+Arabic, Devanagari, CJK, or most accented characters, register a Unicode
+TTF/OTF font first:
+
+```ts
+await pdf.registerFont({ family: 'Noto Sans', src: '/fonts/NotoSans-Regular.ttf', weight: 400 });
+```
+
+Use a **static** font file (a single weight/style), not a variable font —
+`@pdf-lib/fontkit` does not subset variable fonts correctly.
+
+## Documentation
+
+Full architecture docs, CSS support matrix, pagination algorithm, and API
+design are in the [repository's `docs/` folder](https://github.com/mdabdulshahed/angular-pdf/tree/main/docs).
+
+## License
+
+MIT