a-h/templ
Templ
Templ is a type-safe HTML templating engine and UI framework for Go. It provides a system for building reusable HTML components that compile into Go code for server-side rendering, ensuring type safety and compile-time validation of data and logic.
The project features a dedicated language server that provides autocomplete and syntax validation for template files within supported code editors. It employs compile-time code generation to transform a custom template language into Go source code, enabling the creation of modular HTML fragments and logic blocks.
The framework includes automated security mechanisms to prevent cross-site scripting through HTML escaping, CSS class and value sanitization, and resource URL validation. It supports various output targets, including streaming content to response writers for web interfaces or producing standalone files for static site generation.
A command line interface is provided to handle the generation of Go source code and the formatting of markup and template files.
Features
- Compile-Time Code Generation - Transforms a custom template language into type-safe Go source code during the build process.
- HTML Templating Engines - Implements a type-safe HTML templating engine that compiles templates into Go code for server-side rendering.
- Template Compilation Tools - Transforms custom template files into type-safe functions that return renderable HTML components during the build phase.
- HTML Compilation - Compiles a custom templating language into Go source code to produce type-safe user interfaces.
- Go Code Generators - Transforms template files into idiomatic and type-safe Go source code.
- Component Compilers - Compiles markup and logic into Go functions that render HTML using loops and conditionals.
- Cross-Site Scripting Prevention - Automatically escapes user-provided data in HTML attributes and tags to block script injection.
- XSS Protections - Provides built-in sanitization and encoding to prevent cross-site scripting attacks during HTML rendering.
- Component Composition - Organizes user interfaces into reusable functions and types that can be nested to build complex pages.
- Reusable UI Components - Enables the construction of reusable HTML fragments and modular interface elements.
- HTML Response Renderers - Provides capabilities to write type-safe templates directly to a response writer for delivering web content.
- Markup Compilers - Transforms declarative HTML-like syntax into optimized, type-safe component structures at build time.
- Server-Side Rendering - Generates HTML dynamically on the server to serve content to clients.
- Type-Safe UI Frameworks - Offers a UI framework that ensures type safety and compile-time validation for HTML components.
- Web Components - Provides a system for creating a library of modular HTML fragments and logic blocks to compose web pages.
- Web Framework Integrations - Enables rendering dynamic HTML templates within various HTTP routing systems to serve content to web clients.
- Static Page Rendering - Produces standalone HTML files optimized for deployment on static hosting environments.
- Language Server Protocol Implementations - Implements the Language Server Protocol to provide real-time syntax highlighting and autocomplete within code editors.
- Language Servers - Implements the Language Server Protocol to enable autocomplete and syntax validation within supported code editors.
- URL Protocol Sanitizers - Validates URL attributes to remove JavaScript-based links and ensure only safe protocols are used.
- Template Syntax Validators - Parses template files during the build process to ensure type safety and structural correctness.
- Escaping Utilities - Automatically encodes dynamic text content to prevent cross-site scripting and malicious script injection.
- UI Component Libraries - Templurn supports integrating collections of pre-made HTML elements like buttons and cards into a project.
- Type-to-Component Mappings - Ties the user interface directly to data structures by returning components from methods attached to types.
- Static HTML Generators - Outputs rendered component content as standalone static HTML files using standard writer interfaces.
- Custom Rendering Logic - Allows implementing a component interface using raw code to manually control HTML output generation.
- Static Site Generation - Renders Go components into standalone HTML files for deployment on static hosting environments.
