pager

package

v0.0.0-...-883b603 Latest Latest Go to latest Published: May 16, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Documentation ¶

Overview ¶

Package pager splits arrays of metadata into standalone pages. The plugin is initialized with a lister callback which is used to segment a slice of metadata contained within the provided file. While any large set of metadata can be split into segments, this plugin is particularly useful when working with the "collection" for paging blog entries, photos, etc.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Index ¶

type Index struct {
	AllPages []Page
	CurrPage *Page
	Paged    bool
}

Index contains paging information for the current file.

type Lister ¶

type Lister func(file *goldsmith.File) interface{}

Lister callback function is used to return a metadata slice which should be paged across several files.

type Namer ¶

type Namer func(path string, index int) string

Namer callback function builds paths for file pages based on the original file path and page index.

type Page ¶

type Page struct {
	Index int
	Items interface{}
	File  *goldsmith.File

	Next *Page
	Prev *Page
}

Page represents information about a given metadata segment.

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

Pager chainable context.

func New ¶

func New(lister Lister) *Pager

New creates a new instance of the Pager plugin.

func (self *Pager) EnableKey(key string) *Pager

EnableKey sets the metadata key used to determine if the current file should be paged (default: false).

func (self *Pager) Finalize(ctx *goldsmith.Context) error

func (self *Pager) InheritedKeys(keys ...string) *Pager

InheritedKeys sets which metadata keys should be copied to generated pages from the original file (default: []). When no keys are provided, all metadata is copied from the original file to generated pages.

func (*Pager) Initialize(context *goldsmith.Context) error

func (self *Pager) ItemsPerPage(limit int) *Pager

ItemsPerPage sets the maximum number of items which can be included on a single page (default: 10).

func (*Pager) Name() string

func (self *Pager) Namer(namer Namer) *Pager

Namer sets the callback used to build paths for file pages. Default naming inserts page number between file name and extension, for example "file.html" becomes "file-2.html".

func (self *Pager) PagerKey(key string) *Pager

PagerKey sets the metadata key used to store paging information for each file (default: "Pager").

func (self *Pager) Process(context *goldsmith.Context, inputFile *goldsmith.File) error

Source Files ¶

View all Source files

pager.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Index ¶

type Lister ¶

type Namer ¶

type Page ¶

type Pager ¶

func New ¶

func (*Pager) EnableKey ¶

func (*Pager) Finalize ¶

func (*Pager) InheritedKeys ¶

func (*Pager) Initialize ¶

func (*Pager) ItemsPerPage ¶

func (*Pager) Name ¶

func (*Pager) Namer ¶

func (*Pager) PagerKey ¶

func (*Pager) Process ¶

Source Files ¶