Rendro.Recipes (Rendro v1.3.4) (stable)

Copy Markdown View Source

Canonical PDF recipes for standard document types.

These recipes provide a starting point for common documents like invoices and reports, demonstrating best practices for layout and pagination.

Summary

Functions

branded_invoice(data)

Builds a branded invoice document.

branded_invoice(data, opts)

Builds a branded invoice document with options.

certificate(data)

Builds a certificate document.

certificate(data, opts)

Builds a certificate document with options.

invoice(data)

Builds a standard invoice document.

invoice(data, opts)

Builds a standard invoice document with options.

receipt(data)

Builds a receipt document.

receipt(data, opts)

Builds a receipt document with options.

statement(data)

Builds a statement document.

statement(data, opts)

Builds a statement document with options.

Functions

branded_invoice(data)

@spec branded_invoice(map()) :: Rendro.Document.t()

Builds a branded invoice document.

Delegates to branded_invoice/2 with an empty opts list. See Rendro.Recipes.BrandedInvoice for the accepted ## Options.

branded_invoice(data, opts)

@spec branded_invoice(
  map(),
  keyword()
) :: Rendro.Document.t()

Builds a branded invoice document with options.

Delegates to Rendro.Recipes.BrandedInvoice.document/2, forwarding opts verbatim. The recipe module is the single authority for accepted option keys. See Rendro.Recipes.BrandedInvoice for the ## Options section.

certificate(data)

@spec certificate(map()) :: Rendro.Document.t()

Builds a certificate document.

Delegates to certificate/2 with an empty opts list. See Rendro.Recipes.Certificate for the accepted ## Options.

certificate(data, opts)

@spec certificate(
  map(),
  keyword()
) :: Rendro.Document.t()

Builds a certificate document with options.

Delegates to Rendro.Recipes.Certificate.document/2, forwarding opts verbatim. The recipe module is the single authority for accepted option keys. See Rendro.Recipes.Certificate for the ## Options section.

invoice(data)

@spec invoice(map()) :: Rendro.Document.t()

Builds a standard invoice document.

Delegates to invoice/2 with an empty opts list. See Rendro.Recipes.Invoice for the accepted ## Options.

invoice(data, opts)

@spec invoice(
  map(),
  keyword()
) :: Rendro.Document.t()

Builds a standard invoice document with options.

Delegates to Rendro.Recipes.Invoice.document/2, forwarding opts verbatim. The recipe module is the single authority for accepted option keys. See Rendro.Recipes.Invoice for the ## Options section.

receipt(data)

@spec receipt(map()) :: Rendro.Document.t()

Builds a receipt document.

Delegates to receipt/2 with an empty opts list. See Rendro.Recipes.Receipt for the accepted ## Options.

receipt(data, opts)

@spec receipt(
  map(),
  keyword()
) :: Rendro.Document.t()

Builds a receipt document with options.

Delegates to Rendro.Recipes.Receipt.document/2, forwarding opts verbatim. The recipe module is the single authority for accepted option keys. See Rendro.Recipes.Receipt for the ## Options section.

statement(data)

@spec statement(map()) :: Rendro.Document.t()

Builds a statement document.

Delegates to statement/2 with an empty opts list. See Rendro.Recipes.Statement for the accepted ## Options.

statement(data, opts)

@spec statement(
  map(),
  keyword()
) :: Rendro.Document.t()

Builds a statement document with options.

Delegates to Rendro.Recipes.Statement.document/2, forwarding opts verbatim. The recipe module is the single authority for accepted option keys. See Rendro.Recipes.Statement for the ## Options section.