diff options
Diffstat (limited to 'vendor/github.com/Unknwon/paginater/README.md')
-rw-r--r-- | vendor/github.com/Unknwon/paginater/README.md | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/vendor/github.com/Unknwon/paginater/README.md b/vendor/github.com/Unknwon/paginater/README.md deleted file mode 100644 index 3886d7b4..00000000 --- a/vendor/github.com/Unknwon/paginater/README.md +++ /dev/null @@ -1,65 +0,0 @@ -Paginater [](https://travis-ci.org/Unknwon/paginater) -========= - -Package paginater is a helper module for custom pagination calculation. - -## Installation - - go get github.com/Unknwon/paginater - -## Getting Started - -The following code shows an example of how to use paginater: - -```go -package main - -import "github.com/Unknwon/paginater" - -func main() { - // Arguments: - // - Total number of rows - // - Number of rows in one page - // - Current page number - // - Number of page links to be displayed - p := paginater.New(45, 10, 3, 3) - - // Then use p as a template object named "Page" in "demo.html" - // ... -} -``` - -`demo.html` - -```html -{{if not .Page.IsFirst}}[First](1){{end}} -{{if .Page.HasPrevious}}[Previous]({{.Page.Previous}}){{end}} - -{{range .Page.Pages}} - {{if eq .Num -1}} - ... - {{else}} - {{.Num}}{{if .IsCurrent}}(current){{end}} - {{end}} -{{end}} - -{{if .Page.HasNext}}[Next]({{.Page.Next}}){{end}} -{{if not .Page.IsLast}}[Last]({{.Page.TotalPages}}){{end}} -``` - -Possible output: - -``` -[First](1) [Previous](2) ... 2 3(current) 4 ... [Next](4) [Last](5) -``` - -As you may guess, if the `Page` value is `-1`, you should print `...` in the HTML as common practice. - -## Getting Help - -- [API Documentation](https://gowalker.org/github.com/Unknwon/paginater) -- [File An Issue](https://github.com/Unknwon/paginater/issues/new) - -## License - -This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.
\ No newline at end of file |