Scryber.Core
5.0.4
See the version list below for details.
dotnet add package Scryber.Core --version 5.0.4
NuGet\Install-Package Scryber.Core -Version 5.0.4
<PackageReference Include="Scryber.Core" Version="5.0.4" />
paket add Scryber.Core --version 5.0.4
#r "nuget: Scryber.Core, 5.0.4"
// Install Scryber.Core as a Cake Addin #addin nuget:?package=Scryber.Core&version=5.0.4 // Install Scryber.Core as a Cake Tool #tool nuget:?package=Scryber.Core&version=5.0.4
Change the way you create documents.
With a styles based template layout it is easy to create good looking, flowing documents with dynamic content from you applications or sites.
HTML First
The latest version of scryber makes a significant switch to an XHTML first approach. If you know HTML you can create documents.
scryber supports:
- standard html body, tables, lists, divs and spans and many newer html5 tags
- flowing and flexible layout with multiple pages in css sizes, along with page headers, footers and breaks.
- SVG elements for drawings and icons.
- cascading styles: linked, embedded or inline using css syntax and priority.
- databinding for dynamic content on simple and complex objects with repeating templates.
- iframe imports of external content,
- sizing and positioning of elements inline, block, relative or absolute.
- images and colours with text and shape fills backgrounds and borders.
- multiple fonts, including linked google fonts, with text alignment; spacing; leading; decoration and breaking.
If you have used the previous pdfx files, the older templates should continue to work. But we will be concentrating on html, css and svg going forwards.
Getting Started
The easiest way to begin is to use the Nuget Packages here
scryber.core package (Base libraries for GUI or console applications)
OR for asp.net mvc
scryber.core.mvc package (Which includes the scryber.core package).
Check out Read the Docs for more information on how to use the library.
Example Template
Create a new html template file with your content.
<!DOCTYPE HTML >
<html lang='en' xmlns='http://www.w3.org/1999/xhtml' >
<head>
<meta charset='utf-8' name='author' content='Richard Hewitson' />
<title>Hello World</title>
<style>
body{
font-family: sans-serif;
font-size: 14pt;
}
p.header {
color: #AAA;
background-color: #333;
background-image: url('../html/images/ScyberLogo2_alpha_small.png');
background-repeat: no-repeat;
background-position: 10pt 10pt;
background-size: 20pt 20pt;
margin-top: 0pt;
padding: 10pt 10pt 10pt 35pt;
}
.foot td {
border: none;
text-align: center;
font-size: 10pt;
margin-bottom: 10pt;
}
</style>
</head>
<body>
<header>
<p class="header">Scryber document creation</p>
</header>
<main style="padding:10pt">
<h2 style="{@:model.titlestyle}">{@:model.title}</h2>
<div>We hope you like it.</div>
<ol>
<template data-bind='{@:model.items}'>
<li>{@:.name}</li>
</template>
</ol>
</main>
<footer>
<table class="foot" style="width:100%">
<tr>
<td>{@:author}</td>
<td><page /></td>
<td>Hello World Sample</td>
</tr>
</table>
</footer>
</body>
</html>
From your application code.
//using Scryber.Components
static void Main(string[] args)
{
var path = System.Environment.CurrentDirectory;
path = System.IO.Path.Combine(path, "../../../Content/HTML/READMESample.html");
//create our sample model data.
var model = new
{
titlestyle = "color:#ff6347",
title = "Hello from scryber",
items = new[]
{
new { name = "First item" },
new { name = "Second item" },
new { name = "Third item" },
}
};
using (var doc = Document.ParseDocument(path))
{
//pass data paramters as needed, supporting simple values, arrays or complex classes.
doc.Params["author"] = "Scryber Engine";
doc.Params["model"] = model;
//And save it to a file or a stream
using (var stream = new System.IO.FileStream("READMESample.pdf", System.IO.FileMode.Create))
{
doc.SaveAsPDF(stream);
}
}
}
Or from an MVC web application
//using Scryber.Components
//using Scryber.Components.Mvc
public IActionResult HelloWorld(string title = "This is the title")
{
using(var doc = Document.ParseDocument("[input template]"))
{
doc.Params["author"] = "Scryber Engine";
doc.Params["model"] = GetMyParameters(title);
//This will output to the response inline.
return this.PDF(doc); // inline:false, outputFileName:"HelloWorld.pdf"
}
}
And the output
Check out Read the Docs for more information on how to use the library.
Getting Involved
We would love to hear your feedback. Feel free to get in touch. Issues, ideas, includes are all welcome.
If you would like to help with building, extending then happy to get contributions
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net5.0
- Microsoft.Extensions.Configuration (>= 5.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 5.0.0)
- Newtonsoft.Json (>= 12.0.3)
- Scryber.Core.OpenType (>= 5.0.3)
- System.Configuration.ConfigurationManager (>= 5.0.0)
- System.Drawing.Common (>= 5.0.0)
- System.Resources.Extensions (>= 5.0.0)
- System.Text.Encoding (>= 4.3.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Scryber.Core:
| Package | Downloads |
|---|---|
|
Scryber.Core.Mvc
The Mvc extensions for the Scryber.Core PDF creation engine - change the way you make documents. Scryber is an advanced PDF generation engine based around HTML templates with CSS styles and SVG drawing, or just code it. It includes full flowing pages, dynamic template binding on your object model and referenced external files, images, css and fonts. Easily create documents from your Apps, MVC sites, or Javascipt ajax calls. This framework is built entirely in .NET6 and Net Standard 2.0 and is released under the LGPL licence so you can use to it in commercial applications. |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Scryber.Core:
| Repository | Stars |
|---|---|
|
grandnode/grandnode2
Open-Source eCommerce Platform on .NET Core, MongoDB, AWS DocumentDB, Azure CosmosDB, LiteDB & Vue.js
|
|
|
richard-scryber/scryber.core
Scryber.Core is a dotnet 6 html to pdf engine written entirely in C# for creating beautiful flowing documents from html templates including css styles, object data binding and svg drawing.
|
| Version | Downloads | Last updated | |
|---|---|---|---|
| 6.0.4-beta | 10,441 | 1/12/2024 | |
| 6.0.3.2-beta | 8,953 | 10/6/2023 | |
| 6.0.3.1-beta | 648 | 10/6/2023 | |
| 6.0.3-beta | 674 | 10/5/2023 | |
| 6.0.2.1-beta | 987 | 9/18/2023 | |
| 6.0.2-alpha | 3,641 | 5/4/2023 | |
| 6.0.1.3-beta | 637 | 9/18/2023 | |
| 6.0.1-beta | 11,118 | 3/24/2023 | |
| 6.0.0.16-beta | 1,791 | 3/1/2023 | |
| 6.0.0.14-beta | 15,513 | 1/1/2023 | |
| 6.0.0.13-beta | 1,144 | 12/6/2022 | |
| 6.0.0.10-beta | 1,088 | 10/6/2022 | |
| 6.0.0.9-beta | 2,569 | 9/30/2022 | |
| 6.0.0.8-beta | 1,938 | 9/23/2022 | |
| 6.0.0.6-beta | 765 | 9/23/2022 | |
| 6.0.0.5-beta | 975 | 9/16/2022 | |
| 6.0.0.4-beta | 934 | 9/16/2022 | |
| 5.1.0.2-beta | 12,237 | 8/31/2021 | |
| 5.1.0.1-beta | 1,744 | 7/27/2021 | |
| 5.1.0-beta | 1,160 | 7/19/2021 | |
| 5.0.7 | 53,708 | 6/16/2021 | |
| 5.0.7-alpha | 826 | 4/29/2021 | |
| 5.0.6.3 | 2,786 | 4/9/2021 | |
| 5.0.6.2-beta | 775 | 4/7/2021 | |
| 5.0.6.1-beta | 868 | 4/6/2021 | |
| 5.0.6 | 988 | 3/30/2021 | |
| 5.0.5.4 | 1,334 | 3/30/2021 | |
| 5.0.5.3-beta | 961 | 3/13/2021 | |
| 5.0.5.2-beta | 873 | 3/12/2021 | |
| 5.0.5.1 | 1,415 | 3/5/2021 | |
| 5.0.5 | 1,347 | 2/26/2021 | |
| 5.0.5-beta | 920 | 2/21/2021 | |
| 5.0.4 | 1,877 | 1/30/2021 | |
| 5.0.3 | 1,258 | 1/18/2021 | |
| 5.0.3-beta | 898 | 1/12/2021 | |
| 5.0.3-alpha | 1,003 | 1/4/2021 | |
| 5.0.1-alpha | 1,049 | 12/30/2020 | |
| 1.0.2-alpha | 889 | 12/15/2020 | |
| 1.0.1-alpha | 975 | 9/14/2020 | |
| 1.0.0.25 | 2,559 | 9/1/2020 | |
| 1.0.0.24 | 1,520 | 8/18/2020 | |
| 1.0.0.23 | 1,370 | 8/16/2020 | |
| 1.0.0.5 | 1,282 | 6/19/2020 | |
| 1.0.0.3 | 1,421 | 6/10/2020 | |
| 1.0.0.1 | 1,187 | 5/23/2020 | |
| 0.9.0 | 1,198 | 5/23/2020 |
5.0.4
Added SVG Support, and local font urls
5.0.3
Public release with most of the issue ironed out (just let us know if not). Along with @font-face, absolute, relative and display css.
5.0.3-beta
Working with support for @page css directives for the whole document and section page sizes. Support for <page />
tags with property or for attributes. Fix for anchor links with internal and external href.
5.0.3-alpha
Added support for HTML binding with the template tag and data-bind attribute. Along with fixes for single character css values and other minor updates.
5.0.1-alpha
Increased support for the HTML parsing with entities and DTD, along with the upgrade to dotnet 5
1.0.1-alpha
Significant updates to the Components namespace (removing the PDF prefix); support for the match='' style attribute; prioritizing style application based on selectors and complexity; direct parsing of XHTML; and support for styles based page breaking. With updated unit tests
1.0.0.25
-----------------
Updated and improved HTML and Markdown handling.
1.0.0.24
-------------------
Package for release to Nuget Public
Updated for the allow missing images option and fixed height and width for 0 resolution
Added the xsd files to the root of the components project
Added a readme.txt file
Added column-widths to the components and styles, with support for varable widths.
Page numbering falls back to the page number format set on the page if not explicitly set.
Removed the Page number prefix instead only supprting the page number display format
Updated to add the static cache provider service
Added the template property to the Placeholder, and support for updating templates to parameters
Stronger typing on the parameters and object parameter, and support for XML pararmeters as XPath or XNode values.
Passing any controller to the template generation so that it can be used to bind to events in templates.
Updated the data components for ForEach, With, If, Choose:When to be able to use xpath and object binding expressions on the value property.
Updated the PDFUser Component to use Params not Items
Updated the bindings and Params. Autobind on the document defaults to true.
Added the binding expressions as default in the parsing options
Fixed the query string overrides on the item native values
PDFDocument fix for remote references.
1.0.0.5
Fixes for path mapping on Mac / Unix / Windows when loading reference paths. Updated for the schema references and scrybersettings.json in the Scryber.Core.Schemas package
Added the default namespaces to the ParsingOptions, and updated version to match MVC and OpenType