pdfrender

Documentation

Overview

Package pdfrender contains HTML to PDF implementations

Index

• Constants
• Variables
• type CallbackEvent
• type CallbackEventChan
• type Config
• type Document
• type InvalidWaitLifecycleEventError
  • func NewInvalidWaitLifecycleEventError(eventType string) *InvalidWaitLifecycleEventError
  • func (err *InvalidWaitLifecycleEventError) Error() string
• type PDFRenderer
• type RenderInfo
• type RenderPoolInfo
• type RenderPoolStats
• type TemplateName
• type WaitLifecycleEvent
  • func (event WaitLifecycleEvent) IsCallback() bool
  • func (event *WaitLifecycleEvent) Set(value string) error
  • func (event *WaitLifecycleEvent) String() string
  • func (event *WaitLifecycleEvent) UnmarshalJSON(value []byte) error

Constants

const (
	WaitLifecycleEventInit                 = WaitLifecycleEvent("init")
	WaitLifecycleEventLoad                 = WaitLifecycleEvent("load")
	WaitLifecycleEventDOMContentLoaded     = WaitLifecycleEvent("DOMContentLoaded")
	WaitLifecycleEventFirstPaint           = WaitLifecycleEvent("firstPaint")
	WaitLifecycleEventFirstContentfulPaint = WaitLifecycleEvent("firstContentfulPaint")

	WaitLifecycleEventFirstMeaningfulPaintCandidate = WaitLifecycleEvent(
		"firstMeaningfulPaintCandidate",
	)

	WaitLifecycleEventNetworkAlmostIdle    = WaitLifecycleEvent("networkAlmostIdle")
	WaitLifecycleEventFirstMeaningfulPaint = WaitLifecycleEvent("firstMeaningfulPaint")
	WaitLifecycleEventNetworkIdle          = WaitLifecycleEvent("networkIdle")

	// PDF printing triggered only when callback event is received.
	WaitLifecycleEventCallback = WaitLifecycleEvent("callback")
)

Wait Lifecycle events.

const (
	DefaultWaitLifecycleEvent = WaitLifecycleEventLoad
)

Default values for RenderConfig.

Variables

var WaitLifecycleEvents = []WaitLifecycleEvent{
	WaitLifecycleEventInit,
	WaitLifecycleEventLoad,
	WaitLifecycleEventDOMContentLoaded,
	WaitLifecycleEventFirstPaint,
	WaitLifecycleEventFirstContentfulPaint,
	WaitLifecycleEventFirstMeaningfulPaintCandidate,
	WaitLifecycleEventNetworkAlmostIdle,
	WaitLifecycleEventFirstMeaningfulPaint,
	WaitLifecycleEventNetworkIdle,
	WaitLifecycleEventCallback,
}

WaitLifecycleEvents list of allowed WaitLifecycleEvent.

Types

type CallbackEvent

type CallbackEvent struct{}

CallbackEvent send from page to internal server.

type CallbackEventChan

type CallbackEventChan chan CallbackEvent

CallbackEventChan is channel for CallbackEvent.

type Config

type Config struct {
	Landscape          *bool
	PrintBackground    *bool
	Scale              *float64
	PaperWidth         *float64
	PaperHeight        *float64
	MarginTop          *float64
	MarginBottom       *float64
	MarginLeft         *float64
	MarginRight        *float64
	PreferCSSPageSize  *bool
	WaitLifecycleEvent *WaitLifecycleEvent
}

Config is print config.

type Document

type Document struct {
	BodyHTML     string
	HeaderHTML   *string
	FooterHTML   *string
	TemplateName TemplateName
}

Document wrap HTML with template metadata.

type InvalidWaitLifecycleEventError

type InvalidWaitLifecycleEventError struct {
	// contains filtered or unexported fields
}

InvalidWaitLifecycleEventError returned when provided unexpected event type.

func NewInvalidWaitLifecycleEventError

func NewInvalidWaitLifecycleEventError(eventType string) *InvalidWaitLifecycleEventError

NewInvalidWaitLifecycleEventError construct new InvalidWaitLifecycleEventError.

func (*InvalidWaitLifecycleEventError) Error

func (err *InvalidWaitLifecycleEventError) Error() string

type PDFRenderer

type PDFRenderer interface {
	RenderPDF(
		ctx context.Context,
		config *Config,
		document Document,
	) (
		[]byte,
		error,
	)
	Info(context.Context) (*RenderInfo, error)
}

PDFRenderer interface.

type RenderInfo

type RenderInfo struct {
	Pool     RenderPoolInfo
	Metadata map[string]string
}

RenderInfo contains pool info and metadata.

type RenderPoolInfo

type RenderPoolInfo struct {
	Stats RenderPoolStats
	Type  string
}

RenderPoolInfo contains stats and type.

type RenderPoolStats

type RenderPoolStats struct {
	Active      int
	Idle        int
	Destroyed   int
	Invalidated int
}

RenderPoolStats container stats of render pool.

type TemplateName

type TemplateName string

TemplateName type.

type WaitLifecycleEvent

type WaitLifecycleEvent string

WaitLifecycleEvent is type for waited LifecycleEvent.

func (WaitLifecycleEvent) IsCallback

func (event WaitLifecycleEvent) IsCallback() bool

IsCallback return true if event is callback.

func (*WaitLifecycleEvent) Set

func (event *WaitLifecycleEvent) Set(value string) error

Set value. On not valid value return InvalidWaitLifecycleEventError.

func (*WaitLifecycleEvent) String

func (event *WaitLifecycleEvent) String() string

String return event value.

func (*WaitLifecycleEvent) UnmarshalJSON

func (event *WaitLifecycleEvent) UnmarshalJSON(value []byte) error

UnmarshalJSON unmarshal json.