- Notifications
You must be signed in to change notification settings - Fork3
Declarative, composable, concise & fast HTML & CSS components in C++
License
rthrfrd/webxx
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Declarative, composable, concise & fast HTML & CSS in C++.
#include"webxx.h"usingnamespaceWebxx;std::string html = render(h1{"Hello", i{"world!"}});// <h1>Hello <i>world</i></h1>
- No templating language: Use native C++ features for variables and composition.
- No external files or string interpolation: Your templates are compiled in.
- Component system provides easy modularity, re-use and automatic CSS scoping.
- Small, simple, single-file, header-only library.
- Compatible with C++17 and above (to support
std::string_view), minimally stdlib dependent.
You can simply download and includeinclude/webxx.h into your project, or clone this repository (e.g. using CMakeFetchContent).
# Define webxx as an interface library target:add_library(webxxINTERFACE)target_sources(webxxINTERFACE your/path/to/webxx.h)# Link and include it in your target:add_executable(yourApp main.cpp)target_link_libraries(yourAppPRIVATE webxx)target_include_directories(yourAppPRIVATE your/path/to/webxx)
// main.cpp#include<iostream>#include<list>#include<string>#include"webxx.h"intmain () {usingnamespaceWebxx;// Bring your own data model:bool is1MVisit =true; std::list<std::string> toDoItems {"Water plants","Plug (memory) leaks","Get back to that other project", };// Create modular components which include scoped CSS:structToDoItem : component<ToDoItem> {ToDoItem (const std::string &toDoText) : component<ToDoItem> { li { toDoText }, } {} };structToDoList : component<ToDoList> {ToDoList (std::list<std::string> &&toDoItems) : component<ToDoList>{// Styles apply only to the component's elements: { {"ul",// Hyphenated properties are camelCased: listStyle{"none" }, }, },// Component HTML: dv { h1 {"To-do:" },// Iterate over iterators: ul { each<ToDoItem>(std::move(toDoItems)) }, }, } {} };// Compose a full page: doc page { html { head { title {"Hello world!" }, script {"alert('Howdy!');" },// Define global (unscoped) styles: style { {"a", textDecoration{"none"}, }, },// Styles from components are gathered up here: styleTarget {}, }, body {// Set attributes: {_class{"dark", is1MVisit ?"party" :""}},// Combine components, elements and text: ToDoList{std::move(toDoItems)}, hr {},// Optionally include fragments:maybe(is1MVisit, [] () {return fragment { h1 {"Congratulations you are the 1 millionth visitor!", }, a { { _href{"/prize" } },"Click here to claim your prize", }, }; }),"© Me 2022", }, }, };// Render to a string: std::cout <<render(page) << std::endl;}
- Parse: This library is just for constructing HTML & friends.
- Validate: You can construct all the malformed HTML you like.
- Escape: Strings are rendered raw - you must escape unsafe data to prevent XSS attacks.
- The order in which CSS styles belonging to different components are rendered cannot be relied upon, due to the undefined order in which components may be initialised.
- Over 700 symbols are exposed in the
Webxxnamespace - use it considerately. - Symbols are lowercased to mimic their typical appearance in HTML & CSS.
- HTML attributes are all prefixed with
_(e.g.href->_href). - All
kebab-casetags, properties and attributes are translated tocamelCase(e.g.line-height->lineHeight). - All CSS
@*rules are renamed toat*(e.g.@import->atImport). - The following terms are specially aliased to avoid C++ keyword clashes:
- HTML Elements:
div->dvtemplate->template_
- CSS Properties:
continue->continue_float->float_
- HTML Elements:
- The type of value you provide as content to webxx elements/attributes/etc generally determines whether webxx will make a copy of the value or not:
- Will not result in a copy:
[const] char*[const] std::string_view[const] std::string&&
- Will result in a copy:
[const] std::string
- Will not result in a copy:
- As it is possible to render elements at a different time from constructing them,you must make sure that the objects you reference in your document have not been destroyed before you render.
- It is encouraged to use
std::moveto move variables into the components where they are needed, both for performance and to ensure their lifetimes are extended to that of the webxx document. - Alternatively you can pass in variables by value, so that the document retains its own copy of the data it needs to render, which cannot fall out of scope.
- Additional care must be taken when providing
std::string_views to the document. While performant, you must ensure the underlying string has not been destroyed.
A component is any C++ struct/class that inherits fromWebxx::component. It is madeup of HTML, along with optional parameters & CSS styles. The CSS is "scoped": Any CSS styles defined in a component apply only to the HTML elements that belong to that component:
usingnamespaceWebxx;// Components can work with whatever data model you want:structTodoItemData { std::string description;bool isCompleted;};structTodoItem : component<TodoItem> {// Paramters are defined in the constructor:TodoItem (TodoItemData &&todoItem) : component<TodoItem> {// CSS (optional, can be omitted): { {"li.completed", textDecoration{"line-through"}, }, },// HTML: li {// Element attributes appear first... {_class{todoItem.isCompleted ?"completed" :""}},// ...followed by content: todoItem.description, },// 'Head elements' - to add to <head> (optional, can be omitted): {// Useful for e.g. preloading assets that this component might use: link{{_rel{"preload"}, _href{"/background.gif"}, _as{"image"}, _type{"image/gif"}}}, } } {}};
It is encouraged to move variables into the components where they are needed, to avoid any risk of them falling out of scope:
TodoItemgenerateTodoItem () { TodoItemData item{"Thing to do!",false};// If we did not use std::move, description would fall// out of scope and be destroyed before being rendered:return TodoItem{std::move(item)};}auto todoItem = generateTodoItem();auto html = render(todoItem);// <li>Thing to do!</li>
It is straightforwards to repeat components using theeach helper function, or optionally include them usingmaybe:
structTodoList : component<TodoList> {TodoList (std::list<TodoItemData> &&todoItems) : component<TodoList> { ul {// Show each item in the list: each<TodoItem>(std::move(todoItems)),// Show a message if the list is empty:maybe(todoItems.empty(), [] () {return li{"You're all done!"}; }), }, } {}};
Components and other nodes can be composed arbitrarily. For example this allows you to create structural components with slots into which other components can be inserted:
structTodoPage : component<TodoPage> {TodoPage (node &&titleEl, node &&mainEl) : component<TodoPage> { doc {// Creates the <doctype> html{// Creates the <html> head { title{"Todo"},// Special element to collect all component CSS: styleTarget{},// Special element to collect all component head elements: headTarget{}, }, body{std::move(titleEl), main {std::move(mainEl), } }, }, }, } {}};auto pageHtml = render(TodoPage{ h1{"My todo list"}, TodoList{{ {"Clean the car",false}, {"Clean the dog",false}, {"Clean the browser history",true}, }},});
ThestyleTarget element must appear somewhere in the HTML, in order for the CSS defined in each component to work. Likewise for theheadTarget and component 'head elements'.
Theeach function can be used to generate elements, and supports two approaches that can produce equivalent outputs:
std::vector<std::string> letters{"a","b","c"};// Using a lambda (or other callable) allows arbitrary complexity:fragment byLambda = each(letters, [] (std::string letter) {return li { letter };});// Using the template approach is best for concise simplicity:fragment byTemplate = each<li>(letters);auto isSame = render(byLambda) == render(byTemplate);// is trueTheloop function behaves the same aseach, but additionally provides a second parameter to the callback with information about the loop:
loop(letters, [] (const std::string& letter,const Loop& loop) {return li {std::to_string(loop.index),":", letter };});
Afragment contains all the generated elements for each item. Afragment is an "invisible" element; it will not show up in the rendered output (but its children will).
They can be used to pass around multiple elements without wrapping them in a containingdiv or similar. For example they let you produce multiple elements for each item in a loop:
auto html = render(each(letters, [] (std::string letter) {return fragment { p{letter}, hr{}, };}));// html = "<p>a</p><hr/><p>b</p><hr/><p>c</p><hr/>"
Placeholders enable you to perform post-processing of the document at render time. This can be useful for tasks such as internationalization.
You can define a "populator" function, which is called for every placeholder that is encountered while rendering the document.
std::unordered_map<std::string_view,std::string_view> translations { {"Hello","Hej"}, {"world","värld"},};h1 title {_{"Hello"}, _{"world"},"!"};auto translatedHtml = render(title, {false, [&translations] (const std::string_view key,const std::string_view ) ->const std::string_view {return translations.at(key); }});// translatedHtml = "<h1>Hey värld!</h1>"You can define your own elements and attributes in the same way that webxx does internally:
constexprstaticchar customElTag[] ="custom-el";using customEl = Webxx::el<customElTag>;constexprstaticchar customDataThingAttr[] ="data-thing";using dataThing = Webxx::attr<customDataThingAttr>;render(customElTag{ { dataThing{"value"}, },"Hi",});// <custom-el data-thing="value">Hi</custom-el>
By default therender function appends everything to an internal string buffer, which it returns. However if you want to get that first byte out before rendering the whole doc, you can hook in with a function to stream the output while the rendering is still in progress:
#include<sstream>std::stringstream out;size_t chunkSize{256};// Our hook function takes rendered data, and a reference to the internal buffer:voidonRenderData (const std::string_view data, std::string &buffer) {// In this case we are going to still use the internal buffer... buffer.append(data);if (buffer.size() >= chunkSize) {// ...and then stream it out every 256 characters: out << buffer; buffer.clear(); }}doc myDoc { head {}, body {"Hello world"},};// Start the render:std::string leftovers = render(myDoc, {nullptr,// We're not using a placeholder populator. onRenderData,// Provide our render output receiver. chunkSize// Preset the size of the internal buffer.});// Some data might be left in the buffer - this is returned so we can stream that too:out << leftovers;
You can also defer work until callingrender by usinglazy. However lazy blocks are still executed in a passbefore the first bytes are rendered.
std::string text{"Hello"};dv myDiv{// Evaluated now: h1{std::string{text}},// Lazy block takes a function: lazy{[&text] () {// Only evaluated after render() is called below:return p{text}; }},};text ="world";render(myDiv);// <div><h1>Hello</h1><p>world</p></div>Some basicbenchmarks are built atbuild/test/benchmark/webxx_benchmark usinggoogle-benchmark. Webxx appears to be ~5-30x faster than using a template language likeinja.
# clang-14 on macOS Ventura:Running build/test/benchmark/webxx_benchmark--------------------------------------------------------------------Benchmark Time CPU Iterations--------------------------------------------------------------------singleElementInja 6442 ns 6438 ns 85931singleElementWebxx 228 ns 227 ns 2939620singleElementSprintf 70.3 ns 70.2 ns 9009705singleElementStringAppend 26.8 ns 26.8 ns 25017959multiElementInja 9208 ns 9206 ns 65686multiElementWebxx 990 ns 990 ns 640756multiElementSprintf 177 ns 176 ns 3711972multiElementStringAppend 224 ns 224 ns 2844603loop1kInja 1456063 ns 1454982 ns 455loop1kWebxx 871208 ns 870924 ns 656loop1kStringAppend 108399 ns 108362 ns 5607# gcc-13 on macOS Ventura:Running build/test/benchmark/webxx_benchmark--------------------------------------------------------------------Benchmark Time CPU Iterations--------------------------------------------------------------------singleElementInja 6804 ns 6787 ns 95385singleElementWebxx 240 ns 239 ns 2579599singleElementSprintf 74.8 ns 74.7 ns 8870416singleElementStringAppend 27.6 ns 27.5 ns 25333039multiElementInja 9630 ns 9616 ns 65712multiElementWebxx 1015 ns 1013 ns 622698multiElementSprintf 177 ns 177 ns 3706096multiElementStringAppend 211 ns 210 ns 3207111loop1kInja 1537252 ns 1519808 ns 426loop1kWebxx 927711 ns 926574 ns 659loop1kStringAppend 113185 ns 113055 ns 5656
Contributions are super welcome, in the form of pull requests from Github forks. Please ensure you are able to make your contribution under the terms of the project license(MIT). New features may be rejected to limit scope creep.
- Now
- Optimisations to avoid heap allocations where sizes may be known.
- Add Mac & Windows builds.
- More benchmarking/testing (memory, libmxl2, more usage variations).
- Later
- WASM usage (with two-way DOM binding).
- Indented render output.
- Publishing to package managers.
- Simplicity, safety and accessibility are prioritised.
- Idiomatic C++ is used wherever possible.
- Scope creep is treated with caution.
The library is sectioned into several modules:
- CSS: Classes for constructing CSS stylesheets.
- HTML: Classes for constructing HTML elements & documents.
- Component: Abstraction for a modular combination of CSS & HTML.
- Rendering: Functions for rendering constructed Components, HTML & CSS into strings.
- Utility: Helper functions for dynamically generating content.
- Public: The interface users of this library can consume.
About
Declarative, composable, concise & fast HTML & CSS components in C++
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.