myPongoGinRender

README

myPongoGinRender

Package Pongo4gin is a template renderer that can be used with the Gin web framework https://github.com/gin-gonic/gin it uses the Pongo2 template library https://github.com/flosch/pongo2

Compatible with pongo version 4

pongo2 is a Django-syntax like templating-language (official website).

Orginal Code By Andrejs Cainikovs - Rob van der Linde (https://gitlab.com/go-box/pongo2gin)

Here is Compatible with pongo version 4 & version 5

pongo2 version 1 - pongo2 gin minimal framework stability renderer / Compatible with pongo version 2

pongo2 version 4 - Compatible with pongo version 4

pongo2 version 5 - Compatible with pongo version 5

please don't forget to give stars :)

Installation

go get "github.com/stnc/myPongoGinRender/v4"

Requirements

Requires Gin 1.14 or higher and Pongo2.

Usage

To use myPongoGinRender you need to set your router.HTMLRenderer to a new renderer instance, this is done after creating the Gin router when the Gin application starts up. This assumes templates will be located in the "templates" directory, or you can use myPongoGinRender.TemplatePath("templates") to specify a custom location.

To render templates from a route, call c.HTML just as you would with regular Gin templates, the only difference is that you pass template data as a pongo2.Context instead of gin.H type.

Basic Example

package main

import (
	"log"
	"net/http"
	myPongoGinRender "github.com/stnc/myPongoGinRender/v4"

	"github.com/flosch/pongo2/v4"
	"github.com/gin-gonic/gin"
)

func GetAllData(c *gin.Context) {
	posts := []string{
		"Larry Ellison",
		"Carlos Slim Helu",
		"Mark Zuckerberg",
		"Amancio Ortega ",
		"Jeff Bezos",
		" Warren Buffet ",
		"Bill Gates",
		"selman tunç",
	}
	// Call the HTML method of the Context to render a template
	c.HTML(http.StatusOK, "index.html",
		pongo2.Context{
			"title": "hello pongo",
			"posts": posts,
		},
	)
}
func main() {
	gin.SetMode(gin.DebugMode)
	r := gin.Default()
	r.Use(gin.Recovery())
	r.HTMLRender = myPongoGinRender.TemplatePath("templates")
	r.GET("/", GetAllData)
	log.Fatal(r.Run(":8888"))
}

HTML

<h1> {{ title }}</h1>

{% for post in posts%}
<ul>
  <li>{{post}}</li>
</ul>
{% endfor %}

Template Caching

Templates will be cached if the current Gin Mode is set to anything but "debug", this means the first time a template is used it will still load from disk, but after that the cached template will be used from memory instead.

If he Gin Mode is set to "debug" then templates will be loaded from disk on each request.

Caching is implemented by the Pongo2 library itself.

GoDoc

Specials Thanks

https://gitlab.com/go-box/pongo2gin

https://zhuanlan.zhihu.com/p/105956154

Documentation

Index

• type PongoHTML
  • func (p *PongoHTML) Render(w http.ResponseWriter) error
  • func (p *PongoHTML) WriteContentType(w http.ResponseWriter)
• type PongoRender
  • func TemplatePath(tmplDir string) *PongoRender
  • func (p *PongoRender) Instance(name string, data interface{}) render.Render

Types

type PongoHTML

type PongoHTML struct {
	Template *pongo2.Template
	Name     string
	Data     pongo2.Context
}

PongoHTML strcut

func (*PongoHTML) Render

func (p *PongoHTML) Render(w http.ResponseWriter) error

Render for gin interface render override

func (*PongoHTML) WriteContentType

func (p *PongoHTML) WriteContentType(w http.ResponseWriter)

WriteContentType for gin interface WriteContentType override

type PongoRender

type PongoRender struct {
	TmplDir string
}

PongoRender struct init

func TemplatePath

func TemplatePath(tmplDir string) *PongoRender

TemplatePath html files path

func (*PongoRender) Instance

func (p *PongoRender) Instance(name string, data interface{}) render.Render

Instance init