Retracted

hyperbricks

module

v0.5.6-alpha Latest Latest Go to latest Published: Jul 20, 2025 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hyperbricks/hyperbricks

Links

Open Source Insights

README ¶

Licence: MIT
Version: v0.5.6-alpha
Build time: 2025-07-20T13:41:13Z

Disclaimer

This project is a personal experiment, initially built for my own use. You’re welcome to use it however you like, but please be aware that it’s currently in an alpha stage and not recommended for production environments.

The project is released under the MIT License and provided “as-is,” without any warranties or guarantees.

HyperBricks Documentation

HyperBricks is a headless content management system that aims to bridge front and back-end development of HTMX powered hypermedia applications.

This is done by creating configuration files (referred to as "hyperbricks") that allows you to declare and describe the state of a document in a concise and structured manner.

Key Features:

Declarative Configurations:

Write your web page structure, hierarchy and behavior in easy-to-read configuration files.

Dynamic Rendering:

Use HTMX to dynamically update parts of your page without a full reload.

Modular and Reusable:

Configure components once and reuse them across pages through object inheritance and reusability.

Go direct to:

Quickstart
Installation Instructions for HyperBricks
Defining Hypermedia Documents and Fragments
Adding Properties to Configurations
Rendering Order and Property Rules
Example Configurations
- Hypermedia Example
- Fragment Example with HTMX Trigger
Object Inheritance and Reusability
Importing Predefined HyperScripts
HyperBricks type reference
API Serverside Render

Defining Hypermedia Documents and Fragments

Main Composite Configuration Types

HyperBricks organizes configuration files using a clear hierarchy:

<HYPERMEDIA>

Represents the primary configuration component for full-page documents in HyperBricks. It orchestrates page structure, including and sections, route handling, and overall document rendering.

<TREE>

The type can nest items recursively, but it requires a or component as the root composite component.

<FRAGMENT>

Defines dynamically updateable sections of your pages, utilizing HTMX for efficient content updates without full-page reloads. Ideal for partial page rendering and interactivity. A <FRAGMENT> dynamically updates parts of an HTML page using HTMX, improving performance by avoiding full page reloads."

<API_RENDER>

Used for fetching and rendering external API data. Optimized for caching and public data consumption, typically nested within <HYPERMEDIA> or <FRAGMENT> components.

<API_FRAGMENT_RENDER>

Acts as a bi-directional proxy for API requests and responses, enabling secure and dynamic rendering of authenticated API data directly into HTMX fragments, managing authentication, JWT tokens, and session cookies.

<TREE>

Allows hierarchical nesting of components to structure complex content arrangements. Must be rooted within either a <HYPERMEDIA> or <FRAGMENT>.

<TEMPLATE>

Enables reusable HTML structures through Golang templates, promoting consistency and reducing redundancy across pages and fragments.

Certainly! Here are some concise and clear documentation examples illustrating how HyperBricks uses the standard Go html/template library extended with Sprig functions:

HyperBricks Templates: Using Go html/template with Sprig

HyperBricks leverages the standard Go html/template library, enriched by the powerful functions provided by Sprig. This combination enables developers to write dynamic, reusable, and expressive templates for rendering HTML content within HyperBricks configurations.

Simple Template Example

A basic template rendering dynamic data:

Configuration:

myTemplate = <TEMPLATE>
myTemplate {
    inline = <<[
        <h1>{{.title}}</h1>
        <p>{{.message}}</p>
    ]>>
    values {
        title = Hello World
        message = Welcome to HyperBricks!
    }
}

Expected Result

<h1>Hello World</h1>
<p>Welcome to HyperBricks!</p>

Iterating Data (Arrays)

Templates can iterate over data arrays easily:

fragment = <FRAGMENT>
fragment.route = get-users

fragment.10 = <TEMPLATE>
fragment.10 {
    inline = <<[
        <ul>
            {{$users := fromJson .users}}
            {{ range $users }}
                <li>{{.name}} ({{.email}})</li>
            {{ end }}
        </ul>
    ]>>
    values {
        # multiline string users
        users = <<[ 
            
            [
                { "name": "Alice", "email": "alice@example.com" },
                { "name": "Bob", "email": "bob@example.com" }
            ]

        ]>>
    }
}

Expected Result

<ul>
    <li>Alice (alice@example.com)</li>
    <li>Bob (bob@example.com)</li>
</ul>

Advanced Example: Using Sprig Functions

Sprig functions greatly expand the capabilities of templates. Here's how to leverage some useful Sprig functions within HyperBricks:

Example with Sprig's `upper` and `date` Functions:

postTemplate = <TEMPLATE>
postTemplate {
    inline = <<[
        <article>
            <h2>{{ .title | upper }}</h2>
            <p>{{ .content }}</p>
            <footer>Published on {{ now | date "Jan 2, 2006" }}</footer>
        </article>
    ]>>
    values {
        title = Getting started
        content = HyperBricks makes it easy to build web applications with HTMX.
    }
}

Expected Result

<article>
    <h2>GETTING STARTED</h2>
    <p> HyperBricks makes it easy to build web applications with HTMX.</p>
    <footer>Published on March 14, 2025</footer>
</article>

Advanced Example with Sprig `default` and Conditional Logic

Template utilizing conditional logic and Sprig’s default function for robust rendering:

profileTemplate = <TEMPLATE>
profileTemplate {
    inline = <<[
        <div>
            <h3>{{ .username | default "Anonymous" }}</h2>
            {{ if .bio }}
                <p>{{ .bio }}</p>
            {{ else }}
                <p>No bio provided.</p>
            {{ end }}
        </div>
    ]>>
    values {
        title = Profile
        bio = 
    }
}

Expected Result

<div>
    <h3>Anonymous</h2> 
    <p>No bio provided.</p>
</div>

Helpful Resources:

Hypermedia documents or fragments can be declared using simple key-value properties. This next example creates two locations on site root (index) and /somefragment

myHypermedia = <HYPERMEDIA>
myHypermedia.route = index

# Or
myFragment = <FRAGMENT>
myFragment.route = somefragment

Adding Properties to Configurations

Add properties to hypermedia objects in either flat or nested formats

Flat Configuration Example:

fragment = <FRAGMENT>
fragment.route = myfragment
fragment.content = <TREE>
fragment.content.10 = <HTML>
fragment.content.10.value = <p>THIS IS HTML</p>

Nested Configuration Example:

fragment = <FRAGMENT>
fragment.route = myfragment
fragment {
    content = <TREE>
    content {
        10 = <HTML>
        10 {
            value = <p>THIS IS HTML</p>
        }
    }
}

<FRAGMENT> and <API_FRAGMENT_RENDER> declarations can contain response object keys. These are conform the HTMX documented headers.

response header example:

fragment = <FRAGMENT>
fragment.route = myfragment
fragment {
    content = <TREE>
    content {
        10 = <HTML>
        10 {
            value = <p>THIS IS HTML</p>
        }
    }
    response {
        hx_target = target-element-id
    }
}

Properties are rendered in alphanumeric order. Property values are typeless, so quotes are not required. Types such as <IMAGE>, <HTML>, or <TEXT> are identified automatically during parsing.

hypermedia = <HYPERMEDIA>
hypermedia.10 = <HTML>
hypermedia.10.value = <p>some text</p>

hypermedia.20 = <HTML>
hypermedia.20.value = <p>some more text</p>

hypermedia.1 = <HTML>
hypermedia.1 {
    value = <<[
        <p>RENDERS FIRST</p>
    ]>>
}

Example Configurations

Hypermedia Example

A basic <HYPERMEDIA> object with nested <IMAGE> and <TEXT> types in a <TEMPLATE>:

hypermedia = <HYPERMEDIA>
hypermedia.route = index
hypermedia.head = <HEAD>
hypermedia.head {
    10 = <CSS>
    10.inline = <<[
        .content {
            color: green;
        }
    ]>>

    20 = <JAVASCRIPT>
    20.inline = <<[
        console.log("hello world");
    ]>>
    20.attributes {
        type = text/javascript
    }

    30 = <HTML>
    30.value = <<[
        <link rel="stylesheet" href="styles.css">
        <script src="main.js" type="text/javascript"></script>
    ]>>
}
hypermedia.10 = <TREE>
hypermedia.10 {
    1 = <HTML>
    1.value = <p>SOME CONTENT</p>
}

Fragment Example with HTMX Trigger

A <FRAGMENT> object using an HTMX trigger with nested <IMAGE> and <TEXT> types:

fragment = <FRAGMENT>
fragment.response {
    hx_trigger = myEvent
    hx_target = #target-element-id
}
fragment.10 = <TEMPLATE>
fragment.10 {
    template = <<[
        <h2>{{header}}</h2>
        <p>{{text}}</p>
        {{image}}
    ]>>
    istemplate = true
    values {
        header = SOME HEADER
        text = <TEXT>
        text.value = some text

        image = <IMAGE>
        image.src = hyperbricks-test-files/assets/cute_cat.jpg
        image.width = 800
    }
}

Object Inheritance and Reusability

Properties can inherit from other objects. Here, fragment.content.10 inherits from myComponent, with its values.src overridden:

myComponent = <TEMPLATE>
myComponent {
    template = <<[
        <iframe width="{{width}}" height="{{height}}" src="{{src}}"></iframe>
    ]>>
    istemplate = true
    values {
        width = 300
        height = 400
        src = https://www.youtube.com/embed/tgbNymZ7vqY
    }
}

fragment = <FRAGMENT>
fragment.content = <TREE>
fragment.content {
    10 < myComponent
    10.values.src = https://www.youtube.com/watch?v=Wlh6yFSJEms
    enclose = <div class="youtube_video">|</div>
}

Importing Predefined HyperScripts

Predefined hyperscripts can be imported and reused:

#imports myComponent
@import "path/my_component.hyperbricks"

fragment = <FRAGMENT>
fragment.content = <TREE>
fragment.content {
    10 < myComponent
    10.values.src = https://www.youtube.com/watch?v=Wlh6yFSJEms
    enclose = <div class="youtube_video">|</div>
}

Fragment Example with Response Headers

fragment = <FRAGMENT>
fragment.route = fragment_response
fragment {
    content = <TREE>
    content {
        10 = <HTML>
        10.value = <p>This is a fragment with response headers.</p>
    }
    response {
        hx_trigger = customEvent
        hx_target = #response-container
    }
}

This fragment is triggered on the client side by `customEvent`, updating the content in the DOM element with the ID `#response-container`.

Hypermedia with Template

hypermedia = <HYPERMEDIA>
hypermedia.route = template_page
hypermedia.title = Template Example
hypermedia.10 = <TEMPLATE>
hypermedia.10 {
    inline = <<[
        <h1>{{title}}</h1>
        <p>{{content}}</p>
    ]>>
    values {
        title = Welcome!
        content = This is a template-driven hypermedia page.
    }
}

This Hypermedia uses a template to structure its content dynamically.

Hypermedia with Multiple Ordered Items

hypermedia = <HYPERMEDIA>
hypermedia.route = ordered_content
hypermedia.title = Ordered Items
hypermedia.10 = <HTML>
hypermedia.10.value = <p>Item 10</p>

hypermedia.20 = <HTML>
hypermedia.20.value = <p>Item 20</p>

hypermedia.30 = <HTML>
hypermedia.30.value = <p>Item 30</p>

Content is ordered numerically and renders in that sequence.

API Render Example

api_render = <API_RENDER>
api_render.route = api_example
api_render.url = https://api.example.com/data
api_render.method = GET
api_render.inline = <<[
    <h1>{{.title}}</h1>
    <p>{{.description}}</p>
]>>

Fetches data from an API and renders it using a template.

API Fragment Render Example

api_fragment = <API_FRAGMENT_RENDER>
api_fragment.route = api_fragment_example
api_fragment.url = https://api.example.com/fragment
api_fragment.method = POST
api_fragment.inline = <<[
    <div>{{.content}}</div>
]>>
api_fragment.response {
    hx_target = #fragment-container
    hx_trigger = newData
}

This API fragment fetches data and dynamically updates #fragment-container.

Image Example

hypermedia = <HYPERMEDIA>
hypermedia.route = image_example
hypermedia.title = Image Display
hypermedia.10 = <IMAGE>
hypermedia.10 {
    src = https://picsum.photos/400
    width = 400
    height = 300
    alt = Random Image
}

Loads a placeholder image dynamically.

# Define the main Hypermedia document
hypermedia = <HYPERMEDIA>

# The route determines the URL path for this Hypermedia document (e.g., "/index")
hypermedia.route = index

# Title of the page (used in the document title and as a variable in the template)
hypermedia.title = Structured Page

# Defines the <body> tag attributes, such as a background color and padding
# The "|" character separates the opening and closing tag
hypermedia.bodytag = <body class="bg-gray-100 p-4">|</body>

# The <HEAD> section of the document, automatically available in <HYPERMEDIA>
# This can contain meta tags, stylesheets, and scripts
hypermedia.head {
    # Assigning priority 100 to ensure this block loads properly
    100 = <HTML>
    100.value = <<[
        <!-- Meta tags for character encoding and viewport settings -->
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">

        <!-- Internal CSS for basic styling -->
        <style>
            body { font-family: Arial, sans-serif; margin: 20px; }
            header, footer { background: #333; color: white; padding: 10px; text-align: center; }
            main { padding: 20px; }
        </style>

        <!-- External CSS: TailwindCSS for modern utility-based styling -->
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css">

        <!-- External JavaScript: HTMX for handling dynamic updates without full-page reloads -->
        <script src="https://unpkg.com/htmx.org@2.0.4"></script>
    ]>>
}

# The template is already predefined in <HYPERMEDIA>
# It determines the full structure of the HTML document and dynamically injects content
hypermedia.template {
    inline = <<[
        <!DOCTYPE html>
        <html lang="en">
        
        <!-- The head section is injected dynamically by hyperbricks using the head marker, 
             which pulls from hypermedia.head (not from values object) -->

        {{.head}}

        <body>
            <header>
                <!-- Injects the title dynamically from hypermedia.template.values.title -->
                <h1>{{.title}}</h1>
            </header>
            <main>
                <!-- Injects dynamic content from hypermedia.values.content -->
                <p>{{.content}}</p>
            </main>
            <footer>
                <p>&copy; 2025 My Website</p>
            </footer>
        </body>
        </html>
    ]>>

    # Predefined values injected into the template
    values {
        # This is referenced in the template with {{.title}}
        title = Structured Page
          
        # Used in {{.content}}
        content = This is a Hypermedia document with a full HTML structure.  
    }
}

html result:

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <style>
        body {
            font-family: Arial, sans-serif;
            margin: 20px;
        }

        header,
        footer {
            background: #333;
            color: white;
            padding: 10px;
            text-align: center;
        }

        main {
            padding: 20px;
        }
    </style>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css">
    <script src="https://unpkg.com/htmx.org@2.0.4"></script>
    <meta name="generator" content="hyperbricks cms">
    <title>Structured Page</title>
</head>

<body>
    <header>
        <h1>Structured Page</h1>
    </header>
    <main>
        <p>This is a Hypermedia document with a full HTML structure.</p>
    </main>
    <footer>
        <p>&copy; 2025 My Website</p>
    </footer>
</body>

</html>

Quickstart

Follow these steps to get started

1. Installation Instructions for HyperBricks

2. Initialize a new project:

hyperbricks init -m someproject

This creates a folder in the modules directory in the root. Always run the hyperbricks cli commands the root (parent of modules directory), otherwise it will not find the module given by the -m parameter.

In the folder someproject you find this directory structure:

someproject/
  ├── hyperbricks
  ├────── hello_world.hyperbricks
  ├────── quote-generator.hyperbricks
  ├── rendered
  ├── resources
  ├── static
  ├────── main.js
  ├── templates
  ├────── head.html
  ├────── template.html
  └─ package.hyperbricks

3. Start the project:

hyperbricks start -m someproject

HyperBricks will scan the hyperbricks root folder for files with the .hyperbricks extensions (not subfolders) and look for package.hyperbricks in the root of the module for global configurations.

for start options type:

hyperbricks start --help

4. Access the project in the browser:

Open the web browser and navigate to http://localhost:8080 to view running hyperbricks.

Installation Instructions for HyperBricks

Requirements:

Go version 1.23.2 or higher

To install HyperBricks, use the following command:

go install github.com/hyperbricks/hyperbricks/cmd/hyperbricks@latest

This command downloads and installs the HyperBricks CLI tool

Usage:

hyperbricks [command]

Available Commands:
-  completion  [Generate the autocompletion script for the specified shell]
-  help        [Help about any command]
-  init        [Create package.hyperbricks and required directories]
-  select      [Select a hyperbricks module]
-  start       [Start server]
-  static      [Render static content]
-  version     [Show version]

Flags:
  -h, --help   help for hyperbricks

Use "hyperbricks [command] --help" for more information about a command.

Initializing a Project

To initialize a new HyperBricks project, use the init command:

hyperbricks init -m <name-of-hyperbricks-module>

without the -m and <name-of-hyperbricks-module> this will create a default folder.

This will create a package.hyperbricks configuration file and set up the required directories for the project.

Starting a Module

Once the project is initialized, start the HyperBricks server using the start command:

hyperbricks start  -m <name-of-hyperbricks-module>

Use the --production flag when adding system and service manager in linux or on a mac

hyperbricks start  -m <name-of-hyperbricks-module> --production

This will launch the server, allowing you to manage and serve hypermedia content on the ip of the machine.

Or hyperbricks start for running the module named default.

Rendering static files to render directory

hyperbricks static  -m <name-of-hyperbricks-module>

Additional Commands

HyperBricks provides other useful commands:

completion: Generate shell autocompletion scripts for supported shells.
help: Display help information for any command.

For detailed usage information about a specific command, run:

hyperbricks [command] --help

HyperBricks type reference

Component categories:

Category: component

<HTML>

Type Description

Properties

enclose
value
trimspace

html enclose

enclose

Description
The enclosing HTML element for the header divided by |

Example

html = <HTML>
html.value = <<[
        <p>HTML TEST</p>    
    ]>>
html.enclose = <div>|</div>
}

Expected Result

<div>
  <p>
    HTML TEST
  </p>
</div>

html value

value

Description
The raw HTML content

Example

html = <HTML>
html.value = <p>HTML TEST</p>    
}

Expected Result

<p>
  HTML TEST
</p>

html trimspace

trimspace

Description
Property trimspace filters (if set to true true), all leading and trailing white space removed, as defined by Unicode.

Example

html = <HTML>
html.value = <<[
        <p>HTML TEST</p>    
    ]>>
html.trimspace = true
}

Expected Result

<p>
  HTML TEST
</p>

<TEXT>

Type Description

Properties

enclose
value

text enclose

enclose

Description
The enclosing HTML element for the text divided by |

Example

text = <TEXT>
text {
	  value = SOME VALUE
    enclose = <span>|</span>
}

Expected Result

<span>
  SOME VALUE
</span>

text value

value

Description
The paragraph content

Example

text = <TEXT>
text {
	value = SOME VALUE
    enclose = <span>|</span>
}

Expected Result

<span>
  SOME VALUE
</span>

Category: composite

`<API_RENDER>` & `<API_FRAGMENT_RENDER>`

API Serverside Render

The API components acts like a bi-directional PROXY that renders response data into HTMX-compatible responses, including HTMX response headers when using <API_FRAGMENT_RENDER>.

API call with json body

    body = <<[
        {
            "username":"emilys",
            "password":"emilyspass",
            "expiresInMins":30
        }
    ]>>

The data can be mapped from form or body POST data. Use $ symbol to map the specific value like this:

    body = <<[
        {
            "username":"$form_username",
            "password":"$password"
        }
    ]>>

Data structure of available data for templating:

// in case of an array or object, Values is always in root and use Data to access response data...
	struct {
		Data   interface{} // Can be anything
		Values map[string]interface{} // define this in values field
		Status int // the Status of the API response
	}

`<API_FRAGMENT_RENDER>`

Use with custom route
Renders API Fetched Data to HTMX fragments
Acts like bi-directional PROXY
Validates headers and filters query params
Maps Client Body data to Body of API request
Handles JWT-based and Basic authentication
Includes jwtsecret and jwtclaims options
Uses cookies for session-based auth if needed
Can respond with HTMX response headers
Custom headers

`<API_RENDER>`

Is nested and optional cached, so it needs a parent composite component like <FRAGMENT> or <HYPERMEDIA>
Renders Fetched Data to HTMX output, based on config values.
Is Cached, depending on Hypermedia's configuration
Passes API requests through, modifies headers, filters query params.
Handles JWT-based and Basic authentication before making API requests.
Uses cookies for session-based auth if needed.

Key Differences Between `<API_RENDER>` and `<API_FRAGMENT_RENDER>` Mode

Feature	`<API_RENDER>`	`<API_FRAGMENT_RENDER>`
Cache	✅ Yes (optional)	❌ No (explicit)
API Request	✅ Yes	✅ Yes
Query Param Filtering (`querykeys`)	✅ Yes	✅ Yes
Custom Headers	✅ Yes	✅ Yes
Request Body Modification	✅ Yes	✅ Yes
Transforms Response (`inline`/`template`)	✅ Yes	✅ Yes
Debugging (`debug = true`)	✅ Yes	✅ Yes

Client->Server Interaction

<API_RENDER> does not handle specific user auth. That makes this component only suited for fetching and rendering public data that can be cached on a interval. This can be set in the root composite component.

<API_FRAGMENT_RENDER> Can handle Client auth requests based on login forms and tokens that will be passed through bi-directional.

`Client->Server`	`<API_RENDER>`	`<API_FRAGMENT_RENDER>`
Client->Server: JWT Authentication (`jwtsecret`)	❌ No	✅ Yes
Client->Server: Session-Based Auth (Cookies)	❌ No	✅ Yes
Client->Server: Basic Auth username and password	❌ No	✅ Yes
Client->Server: Generates JWT with Claims (`jwtclaims`)	❌ No	✅ Yes
Client->Server: Body and formdata mapping	✅ Yes (for public API, non-cached)	✅ Yes

Server->API Interaction

Both components can apply authentication on API requests. So for example a Weather Service that requires a API key can be set by adding a header or by creating a JWT claim based on a secret

`Server->API`	`<API_RENDER>`	`<API_FRAGMENT_RENDER>`
Server->API: JWT Authentication (`jwtsecret`)	✅ Yes	✅ Yes
Server->API: Session-Based Auth (Cookies)	✅ Yes	✅ Yes
Server->API: Basic Auth username and password	✅ Yes	✅ Yes
Server->API: Generates JWT with Claims (`jwtclaims`)	✅ Yes	✅ Yes

Other Interactions

`Server->API`	`<API_RENDER>`	`<API_FRAGMENT_RENDER>`
API->Server: Proxy Cookies (`setcookie`)	❌ No (set cookie headers for API request if required)	✅ (acts like proxy)
Server->Client: Sets Cookies (`setcookie`)	❌ No	✅ Yes

See HTMX response header documentation

HTMX Response Headers for `<API_FRAGMENT_RENDER>`

This document provides an overview of the HTML headers used in the HxResponse struct, their corresponding mapstructure keys, and their descriptions.

Hyperbricks Key	HTMX Header	Description
hx_location	HX-Location	Allows you to do a client-side redirect that does not do a full page reload
hx_push_url	HX-Push-Url	Pushes a new URL into the history stack
hx_redirect	HX-Redirect	Can be used to do a client-side redirect to a new location
hx_refresh	HX-Refresh	If set to 'true' the client-side will do a full refresh of the page
hx_replace_url	HX-Replace-URL	Replaces the current URL in the location bar
hx_reswap	HX-Reswap	Allows you to specify how the response will be swapped
hx_retarget	HX-Retarget	A CSS selector that updates the target of the content update
hx_reselect	HX-Reselect	A CSS selector that allows you to choose which part of the response is used to be swapped in
hx_trigger	HX-Trigger	Allows you to trigger client-side events
hx_trigger_after_settle	HX-Trigger-After-Settle	Allows you to trigger client-side events after the settle step
hx_trigger_after_swap	HX-Trigger-After-Swap	Allows you to trigger client-side events after the swap step

<API_FRAGMENT_RENDER> examples

example 1

This is a login example via json body. After the request, the client cookie is set with setcookie field by applying template marker.


# Login with auth via body json and set returned token as cookie in the client's browser
api_login = <API_FRAGMENT_RENDER>
api_login {
    # this is the fragment route:
    route = login
    endpoint = https://dummyjson.com/auth/login
	method = POST

	# use body...
    body = {"username":"emilys","password":"emilyspass","expiresInMins":30}

    # https://dummyjson.com does not have basic auth option but basic auth can be set like this:
	# username = emilys
	# password = emilyspass

	headers {
		Access-Control-Allow-Credentials = true
		Content-Type = application/json
	}
	 inline = <<[
        {{ if eq .Status 200 }}
            <h1>{{.Values.someproperty}}</h1>
            <ul id="{{index .Data.id}}">
                <li>{{index .Data.firstName}} {{index .Data.lastName}}</li>
                <img src="{{index .Data.image}}">
            <ul>

            {{ else }} 
                {{.Data.message}}
        {{ end }}
	 ]>>
     values {
         someproperty = API_FRAGMENT_RENDER demo
     }
    debug = true
   
    # this is the template for setting the token (accessToken)
    setcookie =  <<[token={{.Data.accessToken}}]>>
    # response data is always found in .Data
}

expected output example 1

<h1>API_FRAGMENT_RENDER demo</h1>
<ul id="1">
    <li>Emily Johnson</li>
    <img src="https://dummyjson.com/icon/emilys/128">
<ul>

example 2

The client has cookie token set and passed by the component like for example:

Authorization = Bearer <replace_token_here>

api_me_render = <API_FRAGMENT_RENDER>
api_me_render {
    route = me
    endpoint = https://dummyjson.com/auth/me
	method = GET
	headers {
        # this can be commented out when using a browser because Authorization header is set by the previous example
        # Authorization = Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJlbWlseXMiLCJlbWFpbCI6ImVtaWx5LmpvaG5zb25AeC5kdW1teWpzb24uY29tIiwiZmlyc3ROYW1lIjoiRW1pbHkiLCJsYXN0TmFtZSI6IkpvaG5zb24iLCJnZW5kZXIiOiJmZW1hbGUiLCJpbWFnZSI6Imh0dHBzOi8vZHVtbXlqc29uLmNvbS9pY29uL2VtaWx5cy8xMjgiLCJpYXQiOjE3NDE3Nzk0MTQsImV4cCI6MTc0MTc4MTIxNH0.VsZFlDJg5rtbau0v7QVNKRZifPBIK-s9R_6QuYpSxwY
        #Access-Control-Allow-Credentials = true
		#Content-Type = application/json
        #Accept = application/json
	}
	 inline = <<[
        {{ if eq .Status 200 }}
            <h1>{{.Values.someproperty}}</h1>
            <ul id="{{index .Data.id}}">gender
                <li>{{index .Data.firstName}} {{index .Data.lastName}}</li>
                <li>gender: {{index .Data.gender}} </li>
                <li>Bank CardNumber: {{index .Data.bank.cardNumber}} </li>
            <img src="{{index .Data.image}}">
            <ul>

            {{ else }} 
                {{.Data.message}}
        {{ end }}
        
	 ]>>
     values {
         someproperty = API_FRAGMENT_RENDER demo
     }

    
	enclose = <div class="user">|</div>
}

expected output example 2

<div class="user">
<h1>API_FRAGMENT_RENDER demo</h1>
    <ul id="1">gender
        <li>Emily Johnson</li>
        <li>gender: female </li>
        <li>Bank CardNumber: 9289760655481815 </li>
        <img src="https://dummyjson.com/icon/emilys/128">
    <ul>
</div>

<FRAGMENT>

Type Description

A FRAGMENT dynamically renders a part of an HTML page, allowing updates without a full page reload and improving performance and user experience.

Main Example

fragment = <FRAGMENT>
fragment.response.hx_trigger = myEvent
fragment.10 = <TEMPLATE>
fragment.10 {
    inline = <<[
        <h2>{{.header}}</h2>
        <p>{{.text}}</p>
        {{.image}}
]>>
    
    values {
        header = SOME HEADER
        text = <TEXT>
        text.value = some text

        image = <IMAGE>
        image.src = hyperbricks-test-files/assets/cute_cat.jpg
        image.width = 800
    }
}

Expected Result

<h2>
  SOME HEADER
</h2>
<p>
  some text
</p>
<img src="static/images/cute_cat_w800_h800.jpg" width="800" height="800" />

more

Properties

response
title
route
section
enclose
index
content_type

fragment response

response

Description
HTMX response header configuration.

Example

fragment = <FRAGMENT>
fragment {
	response {
        hx_trigger = trigger-element-id
    }
}

See HTMX response header documentation

HTMX Response Headers

This document provides an overview of the HTML headers used in the HxResponse struct, their corresponding mapstructure keys, and their descriptions.

Hyperbricks Key	HTMX Header	Description
hx_location	HX-Location	Allows you to do a client-side redirect that does not do a full page reload
hx_push_url	HX-Push-Url	Pushes a new URL into the history stack
hx_redirect	HX-Redirect	Can be used to do a client-side redirect to a new location
hx_refresh	HX-Refresh	If set to 'true' the client-side will do a full refresh of the page
hx_replace_url	HX-Replace-URL	Replaces the current URL in the location bar
hx_reswap	HX-Reswap	Allows you to specify how the response will be swapped
hx_retarget	HX-Retarget	A CSS selector that updates the target of the content update
hx_reselect	HX-Reselect	A CSS selector that allows you to choose which part of the response is used to be swapped in
hx_trigger	HX-Trigger	Allows you to trigger client-side events
hx_trigger_after_settle	HX-Trigger-After-Settle	Allows you to trigger client-side events after the settle step
hx_trigger_after_swap	HX-Trigger-After-Swap	Allows you to trigger client-side events after the swap step

fragment title

title

Description
The title of the fragment, only used in the context of the <MENU> component. For document title use <HYPERMEDIA> type.

Example

fragment = <FRAGMENT>
fragment {
	title = Some Title
}

fragment route

route

Description
The route (URL-friendly identifier) for the fragment

Example

fragment = <FRAGMENT>
fragment {
	route = index
}

fragment section

section

Description
The section the fragment belongs to. This can be used with the component <MENU> for example.

Example

fragment = <FRAGMENT>
fragment {
	section = some_section
}

fragment enclose

enclose

Description
Enclosing property using the pipe symbol |

Example

fragment = <FRAGMENT>
fragment {
	10 = <HTML>
    10.value = <p>TEST HTML</p>
    enclose = <div>|</div>
}

Expected Result

<div>
  <p>
    TEST HTML
  </p>
</div>

fragment index

index

Description
Index number is a sort order option for the <MENU> section. See <MENU> for further explanation

Example

fragment = <FRAGMENT>
fragment {
	index = 1
}

fragment content_type

content_type

Description
content type header definition

Example

fragment = <FRAGMENT>
fragment.content_type = text/json

<HEAD>

Type Description

Properties

<HYPERMEDIA>

Type Description

Properties

index
content_type

hypermedia index

index

Description
Index number is a sort order option for the hypermedia defined in the section field. See <MENU> for further explanation and field options

Example

hypermedia = <HYPERMEDIA>
hypermedia {
	index = 1
}

Expected Result

<!DOCTYPE html>
<html>
  <body></body>
</html>

hypermedia content_type

content_type

Description
content type header definition

Example

hypermedia = <HYPERMEDIA>
hypermedia {
	
}

Expected Result

<!DOCTYPE html>
<html>
  <body></body>
</html>

<TEMPLATE>

Type Description

Properties

querykeys
queryparams
enclose

template querykeys

querykeys

Description
The inline template used for rendering.

Example

myComponent = <TEMPLATE>
myComponent {
    
    queryparams = {
        somequeryparameter = helloworld
    }
    querykeys = [somequeryparameter]

   
    values {
        width = 300
        height = 400
        src = https://www.youtube.com/embed/tgbNymZ7vqY
    }
}

template queryparams

queryparams

Description
The inline template used for rendering.

Example

myComponent = <TEMPLATE>
myComponent {
    
    queryparams = {
        somequeryparameter = helloworld
    }
    querykeys = [somequeryparameter]

   
    values {
        width = 300
        height = 400
        src = https://www.youtube.com/embed/tgbNymZ7vqY
    }
}

template enclose

enclose

Description
Enclosing property for the template rendered output divided by |

Example

myComponent = <TEMPLATE>
myComponent {
    inline = <<[
      <img src="{{.src}}" alt="{{.alt}}" width="{{.width}}" height="{{.height}}">
    ]>>
    values {
        width = 500
        height = 600
        alt = Girl in a jacket
        src = img_girl.jpg
    }
    enclose = <div id="image-container">|</div>
}

Expected Result

<div id="image-container">
  <img src="img_girl.jpg" alt="Girl in a jacket" width="500" height="600">
</div>

<TREE>

Type Description

Properties

Category: data

<JSON>

Type Description

Properties

attributes
enclose
file
template
inline
values
debug

json attributes

attributes

Description
Extra attributes like id, data-role, data-action

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json
	inline = <<[
        <h1>Quotes</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    debug = false
}

Expected Result

<h1>
  Quotes
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json enclose

enclose

Description
The enclosing HTML element for the header divided by |

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json
	inline = <<[
        <h1>Quotes</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    debug = false
}

Expected Result

<h1>
  Quotes
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json file

file

Description
Path to the local JSON file

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json
	inline = <<[
        <h1>Quotes</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    debug = false
}

Expected Result

<h1>
  Quotes
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json template

template

Description
Template for rendering output

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json

    # this is a testfile with limitations, use {{TEMPLATE:sometemplate.html}} or use inline like here
	inline = <<[
        <h1>Quotes</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    debug = false
}

Expected Result

<h1>
  Quotes
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json inline

inline

Description
Use inline to define the template in a multiline block <<[ /* Template code goes here */ ]>>

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json
	inline = <<[
        <h1>Quotes</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    debug = false
}

Expected Result

<h1>
  Quotes
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json values

values

Description
Key-value pairs for template rendering

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json

    # this is a testfile with limitations, use {{TEMPLATE:sometemplate.html}} or use inline like here
	inline = <<[
        <h1>{{.someproperty}}</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    values {
        someproperty = Quotes!
    }
    debug = false
}

Expected Result

<h1>
  Quotes!
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

json debug

debug

Description
Debug the response data

Example

local_json_test = <JSON_RENDER>
local_json_test {
	file =  hyperbricks-test-files/assets/quotes.json

    # this is a testfile with limitations, use {{TEMPLATE:sometemplate.html}} or use inline like here
	inline = <<[
        <h1>{{.someproperty}}</h1>
        <ul>
            {{range .Data.quotes}}
                <li><strong>{{.author}}:</strong> {{.quote}}</li>
            {{end}}
        </ul>
	]>>
    values {
        someproperty = Quotes!
    }
    debug = false
}

Expected Result

<h1>
  Quotes!
</h1>
<ul>
  <li>
    <strong>
      Rumi:
    </strong>
    Your heart is the size of an ocean. Go find yourself in its hidden depths.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    The Bay of Bengal is hit frequently by cyclones. The months of November and May, in particular, are dangerous in this regard.
  </li>
  <li>
    <strong>
      Abdul Kalam:
    </strong>
    Thinking is the capital, Enterprise is the way, Hard Work is the solution.
  </li>
  <li>
    <strong>
      Bill Gates:
    </strong>
    If You Can&#39;T Make It Good, At Least Make It Look Good.
  </li>
  <li>
    <strong>
      Rumi:
    </strong>
    Heart be brave. If you cannot be brave, just go. Love&#39;s glory is not a small thing.
  </li>
</ul>

<MENU>

Type Description

Properties

Category: resources

<CSS>

Type Description

Properties

enclose

css enclose

enclose

Description
A custom <style> tag definition |. Will override extraAttributes.

Example

head = <HEAD>
head {
    10 = <CSS>
    10.file = hyperbricks-test-files/assets/styles.css
    10.attributes {
        media = screen
    }
    10.enclose = <style media="print">|</style>
}

Expected Result

<head>
  <style media="print">
    body {
    background-color: red;
    }
  </style>
  <meta name="generator" content="hyperbricks cms">
</head>

<IMAGE>

Type Description

Properties

attributes
enclose
src
width
height
alt
title
id
class
quality
loading
is_static

image attributes

attributes

Description
Extra attributes like loading, data-role, data-action etc

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.attributes {
  usemap = #catmap 
}

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" usemap="#catmap" />

image enclose

enclose

Description
Use the pipe symbol | to enclose the <IMG> tag.

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.attributes {
    loading = lazy
}
image.enclose = <div id="#gallery">|</div>

Expected Result

<div id="#gallery">
  <img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" loading="lazy" />
</div>

image src

src

Description
The source URL of the image

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 300
image.height = 300
image.attributes {
    loading = lazy
}
image.enclose = <div id="#logo">|</div>

Expected Result

<div id="#logo">
  <img src="static/images/cute_cat_w300_h300.jpg" width="300" height="300" loading="lazy" />
</div>

image width

width

Description
The width of the image (can be a number or percentage)

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 300
image.height = 300
image.attributes {
    loading = lazy
}
image.enclose = <div id="#logo">|</div>

Expected Result

<div id="#logo">
  <img src="static/images/cute_cat_w300_h300.jpg" width="300" height="300" loading="lazy" />
</div>

image height

height

Description
The height of the image (can be a number or percentage)

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 310
image.height = 310
image.attributes {
    loading = lazy
}
image.enclose = <div id="#logo">|</div>

Expected Result

<div id="#logo">
  <img src="static/images/cute_cat_w310_h310.jpg" width="310" height="310" loading="lazy" />
</div>

image alt

alt

Description
Alternative text for the image

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.alt = Cute cat!
image.enclose = <div id="#gallery">|</div>

Expected Result

<div id="#gallery">
  <img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" alt="Cute cat!" />
</div>

image title

title

Description
The title attribute of the image

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.title = Some Cute Cat!

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" title="Some Cute Cat!" />

image id

id

Description
Id of image

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 310
image.height = 310
image.id = #cat

Expected Result

<img src="static/images/cute_cat_w310_h310.jpg" width="310" height="310" id="#cat" />

image class

class

Description
CSS class for styling the image

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.title = Some Cute Cat!
image.class = aclass bclass cclass

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" title="Some Cute Cat!" class="aclass bclass cclass" />

image quality

quality

Description
Image quality for optimization, bigger is better.

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 320
image.height = 320
image.quality = 1

Expected Result

<img src="static/images/cute_cat_w320_h320.jpg" width="320" height="320" />

image loading

loading

Description
Lazy loading strategy (e.g., 'lazy', 'eager')

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 320
image.height = 320
image.loading = lazy

Expected Result

<img src="static/images/cute_cat_w320_h320.jpg" width="320" height="320" loading="lazy" />

image is_static

is_static

Description
Flag indicating if the image is static, if so the img will not be scaled and has to be present in the configured static image directory. See package.hyperbricks in the module for settings.

#conveys this logic:
destDir := hbConfig.Directories[&#34;static&#34;] &#43; &#34;/images/&#34;
if config.IsStatic {
    destDir = hbConfig.Directories[&#34;render&#34;] &#43; &#34;/images/&#34;
}

Example

image = <IMAGE>
image.src = cute_cat.jpg
image.width = 310
image.height = 310
image.is_static = true

Expected Result

<img src="static/images/cute_cat.jpg" />

<IMAGES>

Type Description

Properties

attributes
enclose
directory
width
height
id
class
alt
title
quality
loading

images attributes

attributes

Description
Extra attributes like id, data-role, data-action

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.loading = lazy
images.id = #galleryimage_
images.attributes {
    decoding = async 
}

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" id="#galleryimage_0" loading="lazy" decoding="async" />
<img src="static/images/same_cute_cat_w100_h100.jpg" width="100" height="100" id="#galleryimage_1" loading="lazy" decoding="async" />

images enclose

enclose

Description
Use the pipe symbol | to enclose the <IMG> tag.

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 100
image.attributes {
    loading = lazy
}
image.enclose = <div id="#gallery">|</div>

Expected Result

<div id="#gallery">
  <img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" loading="lazy" />
</div>

images directory

images width

width

Description
The width of the images (can be a number or percentage)

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.width = 330

Expected Result

<img src="static/images/cute_cat_w330_h330.jpg" width="330" height="330" />

images height

height

Description
The height of the images (can be a number or percentage)

Example

image = <IMAGE>
image.src = hyperbricks-test-files/assets/cute_cat.jpg
image.height = 100

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" />

images id

id

Description
Id of images with a index added to it

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.loading = lazy
images.id = #img_
images.attributes {
    decoding = async 
}

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" id="#img_0" loading="lazy" decoding="async" />
<img src="static/images/same_cute_cat_w100_h100.jpg" width="100" height="100" id="#img_1" loading="lazy" decoding="async" />

images class

class

Description
CSS class for styling the image

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.height = 10
images.loading = lazy
images.id = #galleryimage_
images.class = galleryimage bordered
images.attributes {
    decoding = async 
}

Expected Result

<img src="static/images/cute_cat_w100_h10.jpg" width="100" height="10" class="galleryimage bordered" id="#galleryimage_0" loading="lazy" decoding="async" />
<img src="static/images/same_cute_cat_w100_h10.jpg" width="100" height="10" class="galleryimage bordered" id="#galleryimage_1" loading="lazy" decoding="async" />

images alt

alt

Description
Alternative text for the image

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.height = 10
images.loading = lazy
images.id = #galleryimage_
images.class = galleryimage bordered
images.alt = gallery image

Expected Result

<img src="static/images/cute_cat_w100_h10.jpg" width="100" height="10" alt="gallery image" class="galleryimage bordered" id="#galleryimage_0" loading="lazy" />
<img src="static/images/same_cute_cat_w100_h10.jpg" width="100" height="10" alt="gallery image" class="galleryimage bordered" id="#galleryimage_1" loading="lazy" />

images title

title

Description
The title attribute of the image

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.loading = lazy
images.id = #img_
images.title = sometitle

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" title="sometitle" id="#img_0" loading="lazy" />
<img src="static/images/same_cute_cat_w100_h100.jpg" width="100" height="100" title="sometitle" id="#img_1" loading="lazy" />

images quality

quality

Description
Image quality for optimization

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.loading = lazy
images.id = #img_
images.quality = 1

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" id="#img_0" loading="lazy" />
<img src="static/images/same_cute_cat_w100_h100.jpg" width="100" height="100" id="#img_1" loading="lazy" />

images loading

loading

Description
Lazy loading strategy (e.g., 'lazy', 'eager')

Example

images = <IMAGES>
images.directory = hyperbricks-test-files/assets/
images.width = 100
images.loading = lazy
images.id = #img_
images.loading = lazy

Expected Result

<img src="static/images/cute_cat_w100_h100.jpg" width="100" height="100" id="#img_0" loading="lazy" />
<img src="static/images/same_cute_cat_w100_h100.jpg" width="100" height="100" id="#img_1" loading="lazy" />

<JS>

Type Description

Properties

attributes
enclose

javascript attributes

attributes

Description
Extra attributes like id, data-role, data-action, type

Example

head = <HEAD>
head {
    10 = <JAVASCRIPT>
    10.file = hyperbricks-test-files/assets/main.js
    10.attributes {
        type = text/javascript
    }
}

Expected Result

<head>
  <script type="text/javascript">
    console.log("Hello World!")
  </script>
  <meta name="generator" content="hyperbricks cms">
</head>

javascript enclose

enclose

Description
The enclosing HTML element for the header divided by |

Example

head = <HEAD>
head {
    10 = <JAVASCRIPT>
    10.file = hyperbricks-test-files/assets/main.js
    10.attributes {
        type = text/javascript
    }
    10.enclose = <script defer></script>
}

Expected Result

<head>
<script defer></script>
console.log("Hello World!")
<meta name="generator" content="hyperbricks cms">

Directories ¶

Path	Synopsis
assets
cmd
hyperbricks command main.go	main.go
hyperbricks/commands commands/select.go	commands/select.go
testing command
pkg
component
composite
database
logging
parser
render render/render_manager.go	render/render_manager.go
renderer
shared
typefactory typefactory/typefactory.go	typefactory/typefactory.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

Disclaimer

HyperBricks Documentation

Key Features:

Declarative Configurations:

Dynamic Rendering:

Modular and Reusable:

Defining Hypermedia Documents and Fragments

Main Composite Configuration Types

HyperBricks Templates: Using Go html/template with Sprig

Simple Template Example

Iterating Data (Arrays)

Advanced Example: Using Sprig Functions

Example with Sprig's upper and date Functions:

Advanced Example with Sprig default and Conditional Logic

Helpful Resources:

Adding Properties to Configurations

Example Configurations

Hypermedia Example

Fragment Example with HTMX Trigger

Object Inheritance and Reusability

Importing Predefined HyperScripts

Fragment Example with Response Headers

This fragment is triggered on the client side by customEvent, updating the content in the DOM element with the ID #response-container.

Hypermedia with Template

Hypermedia with Multiple Ordered Items

API Render Example

API Fragment Render Example

Image Example

Quickstart

1. Installation Instructions for HyperBricks

2. Initialize a new project:

3. Start the project:

4. Access the project in the browser:

Installation Instructions for HyperBricks

Usage:

Initializing a Project

Starting a Module

Rendering static files to render directory

Additional Commands

HyperBricks type reference

Component categories:

component

composite

data

menu

resources

Category: component

<HTML>

html enclose

enclose

html value

value

html trimspace

trimspace

<TEXT>

text enclose

enclose

text value

value

Category: composite

<API_RENDER> & <API_FRAGMENT_RENDER>

API Serverside Render

Data structure of available data for templating:

<API_FRAGMENT_RENDER>

<API_RENDER>

Key Differences Between <API_RENDER> and <API_FRAGMENT_RENDER> Mode

Client->Server Interaction

Server->API Interaction

Other Interactions

HTMX Response Headers for <API_FRAGMENT_RENDER>

<API_FRAGMENT_RENDER> examples

example 1

expected output example 1

example 2

expected output example 2

<FRAGMENT>

fragment response

response

HTMX Response Headers

Example with Sprig's `upper` and `date` Functions:

Advanced Example with Sprig `default` and Conditional Logic

This fragment is triggered on the client side by `customEvent`, updating the content in the DOM element with the ID `#response-container`.

`<API_RENDER>` & `<API_FRAGMENT_RENDER>`

`<API_FRAGMENT_RENDER>`

`<API_RENDER>`

Key Differences Between `<API_RENDER>` and `<API_FRAGMENT_RENDER>` Mode

HTMX Response Headers for `<API_FRAGMENT_RENDER>`