diff --git a/.version b/.version index b3695912a..8f0e97055 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -0.2.528 \ No newline at end of file +0.2.529 \ No newline at end of file diff --git a/docs/docs/12-integrations/index.md b/docs/docs/12-integrations/index.md index f1789ed46..367fe99b9 100644 --- a/docs/docs/12-integrations/index.md +++ b/docs/docs/12-integrations/index.md @@ -1,24 +1,30 @@ # Integrations -Templ is framework agnostic but that does not mean it can not be used with Go frameworks and other tools. +Templ is framework agnostic but that does not mean it can not be used with Go frameworks and other tools. Below are some examples of how to use templ with other Go libraries, frameworks and tools, and links to systems that have built-in templ support. -## Gin +## Chi -See example of using https://github.com/gin-gonic/gin with templ at: +See an example of using https://github.com/go-chi/chi with templ at: -https://github.com/a-h/templ/tree/main/examples/integration-gin +https://github.com/a-h/templ/tree/main/examples/integration-chi -## Chi +## Echo -See example of using https://github.com/go-chi/chi with templ at: +See an example of using https://echo.labstack.com/ with templ at: -https://github.com/a-h/templ/tree/main/examples/integration-chi +https://github.com/a-h/templ/tree/main/examples/integration-echo + +## Gin + +See an example of using https://github.com/gin-gonic/gin with templ at: + +https://github.com/a-h/templ/tree/main/examples/integration-gin ## Go Fiber -See example of using https://github.com/gofiber/fiber with templ at: +See an example of using https://github.com/gofiber/fiber with templ at: https://github.com/a-h/templ/tree/main/examples/integration-gofiber diff --git a/examples/integration-echo/go.mod b/examples/integration-echo/go.mod new file mode 100644 index 000000000..dc62ccd18 --- /dev/null +++ b/examples/integration-echo/go.mod @@ -0,0 +1,22 @@ +module github.com/a-h/templ/examples/integration-echo + +go 1.20 + +require ( + github.com/a-h/templ v0.2.513 + github.com/labstack/echo/v4 v4.11.4 +) + +require ( + github.com/labstack/gommon v0.4.2 // indirect + github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/valyala/bytebufferpool v1.0.0 // indirect + github.com/valyala/fasttemplate v1.2.2 // indirect + golang.org/x/crypto v0.18.0 // indirect + golang.org/x/net v0.20.0 // indirect + golang.org/x/sys v0.16.0 // indirect + golang.org/x/text v0.14.0 // indirect +) + +replace github.com/a-h/templ => ../../ diff --git a/examples/integration-echo/go.sum b/examples/integration-echo/go.sum new file mode 100644 index 000000000..00f523079 --- /dev/null +++ b/examples/integration-echo/go.sum @@ -0,0 +1,41 @@ +github.com/a-h/templ v0.2.513 h1:ZmwGAOx4NYllnHy+FTpusc4+c5msoMpPIYX0Oy3dNqw= +github.com/a-h/templ v0.2.513/go.mod h1:9gZxTLtRzM3gQxO8jr09Na0v8/jfliS97S9W5SScanM= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/labstack/echo/v4 v4.11.4 h1:vDZmA+qNeh1pd/cCkEicDMrjtrnMGQ1QFI9gWN1zGq8= +github.com/labstack/echo/v4 v4.11.4/go.mod h1:noh7EvLwqDsmh/X/HWKPUl1AjzJrhyptRyEbQJfxen8= +github.com/labstack/gommon v0.4.2 h1:F8qTUNXgG1+6WQmqoUWnz8WiEU60mXVVw0P4ht1WRA0= +github.com/labstack/gommon v0.4.2/go.mod h1:QlUFxVM+SNXhDL/Z7YhocGIBYOiwB0mXm1+1bAPHPyU= +github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= +github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= +github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= +github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo= +github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k= +golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4= +golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc= +golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg= +golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c= +golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U= +golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo= +golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc= +golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU= +golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/examples/integration-echo/home.templ b/examples/integration-echo/home.templ new file mode 100644 index 000000000..7444b1196 --- /dev/null +++ b/examples/integration-echo/home.templ @@ -0,0 +1,5 @@ +package main + +templ Home() { +
Hello World
+} diff --git a/examples/integration-echo/home_templ.go b/examples/integration-echo/home_templ.go new file mode 100644 index 000000000..93763ed29 --- /dev/null +++ b/examples/integration-echo/home_templ.go @@ -0,0 +1,34 @@ +// Code generated by templ - DO NOT EDIT. + +package main + +//lint:file-ignore SA4006 This context is only used if a nested component is present. + +import "github.com/a-h/templ" +import "context" +import "io" +import "bytes" + +func Home() templ.Component { + return templ.ComponentFunc(func(ctx context.Context, templ_7745c5c3_W io.Writer) (templ_7745c5c3_Err error) { + templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templ_7745c5c3_W.(*bytes.Buffer) + if !templ_7745c5c3_IsBuffer { + templ_7745c5c3_Buffer = templ.GetBuffer() + defer templ.ReleaseBuffer(templ_7745c5c3_Buffer) + } + ctx = templ.InitializeContext(ctx) + templ_7745c5c3_Var1 := templ.GetChildren(ctx) + if templ_7745c5c3_Var1 == nil { + templ_7745c5c3_Var1 = templ.NopComponent + } + ctx = templ.ClearChildren(ctx) + _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString("
Hello World
") + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + if !templ_7745c5c3_IsBuffer { + _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteTo(templ_7745c5c3_W) + } + return templ_7745c5c3_Err + }) +} diff --git a/examples/integration-echo/main.go b/examples/integration-echo/main.go new file mode 100644 index 000000000..506f90bbb --- /dev/null +++ b/examples/integration-echo/main.go @@ -0,0 +1,25 @@ +package main + +import ( + "net/http" + + "github.com/a-h/templ" + "github.com/labstack/echo/v4" +) + +func main() { + app := echo.New() + app.GET("/", HomeHandler) + app.Logger.Fatal(app.Start(":4000")) +} + +// This custom Render replaces Echo's echo.Context.Render() with templ's templ.Component.Render(). +func Render(ctx echo.Context, statusCode int, t templ.Component) error { + ctx.Response().Writer.WriteHeader(statusCode) + ctx.Response().Header().Set(echo.HeaderContentType, echo.MIMETextHTML) + return t.Render(ctx.Request().Context(), ctx.Response().Writer) +} + +func HomeHandler(c echo.Context) error { + return Render(c, http.StatusOK, Home()) +}