Templating Language

Create dynamic templates with BoxLang's powerful templating language for HTML generation, views, and content rendering

BoxLang includes a powerful templating language designed for creating dynamic HTML, views, and content rendering. Template files use the .bxm extension and provide a natural way to mix static content with dynamic BoxLang code.

📄 Template File Structure

Template files (.bxm) are designed for content generation and HTML output. Unlike script files (.bxs) or class files (.bx), templates default to outputting content directly, making them ideal for views, email templates, and dynamic HTML generation.

<!DOCTYPE html>
<html>
<head>
    <title>Welcome to BoxLang</title>
</head>
<body>
    <bx:output>
        <h1>Hello, #name#!</h1>
        <p>Today is #dateFormat( now(), "full" )#</p>
    </bx:output>
</body>
</html>

🔤 Output Interpolation

BoxLang templates use the # (hash/pound) character for output interpolation. Any expression wrapped in # symbols will be evaluated and output to the page.

Important: For interpolation to work in templates, expressions must be surrounded by a <bx:output> component or within an outputting component context (like <bx:loop query="...">). Component attribute values are automatically evaluated and support interpolation without requiring <bx:output>.

Basic Interpolation

<bx:set greeting = "Hello, World!">
<bx:output>
    <p>#greeting#</p>
    <p>Current time: #now()#</p>
    <p>Random number: #randRange( 1, 100 )#</p>
</bx:output>

Escaping Hash Symbols

To output a literal # character without evaluation, use double hashes ##:

<bx:output>
    <p>Use ## for hash symbols in CSS: ##header { color: blue; }</p>
    <p>This outputs: # for hash symbols in CSS: #header { color: blue; }</p>
</bx:output>

Complex Expressions

You can use any BoxLang expression within interpolation:

<bx:set products = [ "Laptop", "Mouse", "Keyboard" ]>
<bx:output>
    <p>We have #products.len()# products</p>
    <p>First product: #products[1]#</p>
    <p>Total price: #calculateTotal( products )#</p>
</bx:output>

🏷️ Template Components

BoxLang provides a rich set of template components using the bx: prefix. All template components follow XML-like syntax with opening and closing tags or self-closing syntax.

Common Template Components

bx:output

The bx:output component enables output of dynamic content and expressions. Within bx:output, the # interpolation is automatically enabled.

Basic Usage:

<bx:output>
    <h1>Welcome, #user.name#!</h1>
    <p>Your account was created on #dateFormat( user.created, "long" )#</p>
</bx:output>

Attributes:

query - Loop over a query object and output each row
group - Group query output by a column name
groupCaseSensitive - Whether group matching is case-sensitive (default: false)
startRow - Start outputting from this row number
maxRows - Maximum number of rows to output
encodefor - Automatically encode output ("html", "javascript", "url", "xml")

Query Loop Example:

<bx:output query="#products#">
    <div class="product">
        <h3>#products.name#</h3>
        <p>Price: #dollarFormat( products.price )#</p>
    </div>
</bx:output>

Automatic Encoding Example:

<!--- Automatically HTML-encode all interpolated values --->
<bx:output query="#users#" encodefor="html">
    <p>#users.name# - #users.email#</p>
</bx:output>

Grouped Output Example:

<!--- Group products by category --->
<bx:output query="#products#" group="category">
    <h2>#products.category#</h2>
    <bx:output>
        <p>#products.name# - #dollarFormat( products.price )#</p>
    </bx:output>
</bx:output>

bx:set

Define variables in templates using bx:set:

<bx:set userName = "Luis Majano">
<bx:set userAge = 25>
<bx:set userInfo = { name: userName, age: userAge }>

bx:script

Execute BoxLang script code within a template:

<bx:script>
    users = queryExecute( "SELECT * FROM users" )
    totalUsers = users.recordCount
    activeUsers = users.filter( ( row ) => row.active == true ).len()
</bx:script>

<bx:output>
    <p>Total Users: #totalUsers#</p>
    <p>Active Users: #activeUsers#</p>
</bx:output>

bx:if, bx:elseif, bx:else

Conditional rendering in templates:

<bx:set role = "admin">

<bx:if role == "admin">
    <div class="admin-panel">Admin Dashboard</div>
<bx:elseif role == "editor">
    <div class="editor-panel">Editor Dashboard</div>
<bx:else>
    <div class="user-panel">User Dashboard</div>
</bx:if>

bx:loop

Iterate over arrays, queries, structures, and ranges:

<!--- Loop over an array --->
<bx:set fruits = [ "Apple", "Banana", "Orange" ]>
<ul>
<bx:loop array="#fruits#" index="fruit">
    <li>#fruit#</li>
</bx:loop>
</ul>

<!--- Loop over a query --->
<bx:set users = queryNew( "id,name", "integer,varchar", [ [1,"John"], [2,"Jane"] ] )>
<table>
<bx:loop query="#users#">
    <tr>
        <td>#users.id#</td>
        <td>#users.name#</td>
    </tr>
</bx:loop>
</table>

<!--- Loop over a range --->
<bx:loop from="1" to="5" index="i">
    <p>Item #i#</p>
</bx:loop>

bx:include

Include other template files:

<!--- Include a header template --->
<bx:include template="layouts/header.bxm">

<main>
    <h1>Page Content</h1>
</main>

<!--- Include a footer template --->
<bx:include template="layouts/footer.bxm">

Additional Template Components

BoxLang provides many more template components for various purposes:

bx:param

Validate and set default values for variables:

<!--- Require a variable to exist --->
<bx:param name="userId" type="string" required="true">

<!--- Set a default value if variable doesn't exist --->
<bx:param name="pageSize" type="numeric" default="10">

<!--- Multiple validations --->
<bx:param name="email" type="string" required="true">
<bx:param name="isAdmin" type="boolean" default="false">

bx:try / bx:catch / bx:finally

Exception handling in templates:

<bx:try>
    <bx:set result = divide( 10, 0 )>
    <bx:output>Result: #result#</bx:output>
<bx:catch type="any">
    <bx:output>
        <p class="error">Error occurred: #cfcatch.message#</p>
    </bx:output>
<bx:finally>
    <bx:output><p>Cleanup completed</p></bx:output>
</bx:finally>
</bx:try>

bx:throw

Throw custom exceptions:

<bx:if NOT isValid( "email", form.email )>
    <bx:throw type="ValidationException" message="Invalid email address provided">
</bx:if>

bx:abort

Stop template execution:

<bx:if NOT isUserAuthorized()>
    <bx:output><p>Access denied</p></bx:output>
    <bx:abort>
</bx:if>

bx:dump

Debug output for variables:

<!--- Simple dump --->
<bx:dump var="#myVariable#">

<!--- Dump with label --->
<bx:dump var="#users#" label="User Data">

<!--- Dump without stopping execution --->
<bx:dump var="#queryResult#" abort="false">

bx:exit

Exit from a specific execution context:

<!--- Exit current template --->
<bx:exit>

<!--- Exit to specific method (used in custom components) --->
<bx:exit method="exitTemplate">

bx:savecontent

Capture output into a variable:

<bx:savecontent variable="emailBody">
    <h1>Welcome!</h1>
    <p>Thank you for registering, #user.name#</p>
</bx:savecontent>

<!--- Now use the captured content --->
<bx:set mailService.send( to=user.email, body=emailBody )>

bx:silent

Suppress output:

<bx:silent>
    <bx:set complexCalculation = performExpensiveOperation()>
    <!--- Any output here is suppressed --->
    Some text that won't be rendered
</bx:silent>

🔄 Mixing Scripts and Templates

BoxLang allows seamless mixing of script and template syntax within the same file.

Scripts in Templates

Use <bx:script> to embed BoxLang script code within a template:

<h1>User Report</h1>

<bx:script>
    // Fetch data using script syntax
    users = queryExecute( "SELECT * FROM users WHERE active = ?", [ true ] )
    
    // Process data
    stats = {
        total: users.recordCount,
        admins: 0,
        users: 0
    }
    
    users.each( ( row ) => {
        if( row.role == "admin" ) {
            stats.admins++
        } else {
            stats.users++
        }
    } )
</bx:script>

<bx:output>
    <p>Total: #stats.total#</p>
    <p>Admins: #stats.admins#</p>
    <p>Users: #stats.users#</p>
</bx:output>

Templates in Scripts

In script files (.bxs), you can embed template code using template island notation with triple backticks (```):

// This is a .bxs script file
users = [
    { name: "John", age: 30 },
    { name: "Jane", age: 25 }
]

// Now switch to template syntax
```
<h1>Users List</h1>
<bx:output>
    <ul>
    <bx:loop array="#users#" item="user">
        <li>#user.name# - #user.age# years old</li>
    </bx:loop>
    </ul>
</bx:output>
```

// Back to script syntax
println( "Template rendered successfully" )

🎯 Component Execution

BoxLang templates can execute any BoxLang component using the bx: prefix followed by the component name. The runtime automatically resolves and executes the component.

Built-in Components

BoxLang includes many built-in components for common tasks:

<!--- Query database --->
<bx:query name="users" datasource="myDB">
    SELECT id, name, email FROM users WHERE active = 1
</bx:query>

<!--- HTTP request --->
<bx:http url="https://api.example.com/data" method="GET" result="apiResponse">

<!--- File operations --->
<bx:file action="read" file="/path/to/file.txt" variable="fileContent">

<!--- Directory listing --->
<bx:directory action="list" directory="/uploads" name="files" recurse="true">

<!--- Thread for async execution --->
<bx:thread action="run" name="backgroundTask">
    // Long running task here
</bx:thread>

Custom Components

You can create your own custom components to extend the templating language with reusable functionality. Custom components are BoxLang templates or scripts that can be invoked like built-in components.

Creating a Custom Component

Create a component file (e.g., greeting.bxm):

<!--- File: components/greeting.bxm --->
<bx:param name="attributes.name" type="string" required="true">

<bx:output>
    <div class="greeting-card">
        <h2>Hello, #attributes.name#!</h2>
        <p>Welcome to our application.</p>
    </div>
</bx:output>

Using Custom Components

Call your custom component using the bx:_ prefix:

<!--- In a template --->
<bx:_greeting name="World">

Or using the bx:component tag:

<bx:component template="greeting" name="World">

Component Discovery

BoxLang searches for custom components in several locations:

Relative to the current template
Application-defined component paths (via Application.bx)
Global component directories

Configuring Component Paths

In your Application.bx, you can specify custom component directories:

class {
    this.name = "MyApp"
    
    // Define custom component paths
    this.customComponentPaths = [
        expandPath( "/components" ),
        expandPath( "/shared/components" )
    ]
    
    // For class-based components
    this.classPaths = [
        expandPath( "/classes" )
    ]
}

{% hint style="info" %} For comprehensive documentation on creating and using custom components, including advanced patterns, component scopes, and best practices, see the Components Framework Documentation. {% endhint %}

💡 Practical Examples

Dynamic HTML Page

<!DOCTYPE html>
<html>
<head>
    <bx:output><title>#pageTitle#</title></bx:output>
</head>
<body>
    <bx:set currentDate = now()>
    <bx:set userName = session.userName ?: "Guest">
    
    <bx:output>
        <header>
            <h1>Welcome, #userName#!</h1>
            <p>Today is #dateFormat( currentDate, "full" )#</p>
        </header>
    </bx:output>
    
    <bx:if structKeyExists( session, "userId" )>
        <nav>
            <ul>
                <li><a href="/dashboard">Dashboard</a></li>
                <li><a href="/profile">Profile</a></li>
                <li><a href="/logout">Logout</a></li>
            </ul>
        </nav>
    <bx:else>
        <nav>
            <ul>
                <li><a href="/login">Login</a></li>
                <li><a href="/register">Register</a></li>
            </ul>
        </nav>
    </bx:if>
    
    <main>
        <bx:include template="content/#page#.bxm">
    </main>
    
    <bx:output>
        <footer>
            <p>&copy; #year( currentDate )# My Company. All rights reserved.</p>
        </footer>
    </bx:output>
</body>
</html>

Data Table with Query

<bx:script>
    // Fetch products from database
    products = queryExecute(
        "SELECT id, name, price, category FROM products WHERE active = :active ORDER BY name",
        { active: true }
    )
</bx:script>

<h1>Product Catalog</h1>

<bx:if products.recordCount GT 0>
    <table class="table">
        <thead>
            <tr>
                <th>ID</th>
                <th>Name</th>
                <th>Category</th>
                <th>Price</th>
            </tr>
        </thead>
        <tbody>
            <bx:loop query="#products#">
                <tr>
                    <td>#products.id#</td>
                    <td>#products.name#</td>
                    <td>#products.category#</td>
                    <td>#dollarFormat( products.price )#</td>
                </tr>
            </bx:loop>
        </tbody>
    </table>
    <bx:output><p>Showing #products.recordCount# products</p></bx:output>
<bx:else>
    <p>No products found.</p>
</bx:if>

Email Template

<!--- email/welcome.bxm --->
<bx:set userName = arguments.user.name>
<bx:set userEmail = arguments.user.email>
<bx:set activationLink = arguments.activationLink>

<!DOCTYPE html>
<html>
<head>
    <style>
        body { font-family: Arial, sans-serif; }
        .button { 
            background-color: ##007bff; 
            color: white; 
            padding: 10px 20px; 
            text-decoration: none; 
        }
    </style>
</head>
<body>
    <bx:output>
        <h1>Welcome to Our Platform, #userName#!</h1>
        
        <p>Thank you for registering with email: <strong>#userEmail#</strong></p>
        
        <p>Please activate your account by clicking the button below:</p>
        
        <p>
            <a href="#activationLink#" class="button">Activate Account</a>
        </p>
        
        <p>Or copy this link: #activationLink#</p>
        
        <p>
            Best regards,<br>
            The Team
        </p>
    </bx:output>
</body>
</html>

Form Processing

<h1>Contact Form</h1>

<bx:if structKeyExists( form, "submit" )>
    <bx:script>
        // Process form submission
        result = {
            success: false,
            message: ""
        }
        
        // Validate inputs
        if( len( trim( form.name ) ) == 0 || len( trim( form.email ) ) == 0 ) {
            result.message = "Name and email are required"
        } else if( !isValid( "email", form.email ) ) {
            result.message = "Please enter a valid email address"
        } else {
            // Save to database or send email
            queryExecute(
                "INSERT INTO contacts (name, email, message) VALUES (?, ?, ?)",
                [ form.name, form.email, form.message ]
            )
            result.success = true
            result.message = "Thank you for contacting us!"
        }
    </bx:script>
    
    <bx:if result.success>
        <bx:output><div class="alert alert-success">#result.message#</div></bx:output>
    <bx:else>
        <bx:output><div class="alert alert-error">#result.message#</div></bx:output>
    </bx:if>
</bx:if>

<bx:output>
    <form method="post">
        <div>
            <label>Name:</label>
            <input type="text" name="name" value="#form.name ?: ''#" required>
        </div>
        <div>
            <label>Email:</label>
            <input type="email" name="email" value="#form.email ?: ''#" required>
        </div>
        <div>
            <label>Message:</label>
            <textarea name="message" required>#form.message ?: ''#</textarea>
        </div>
        <button type="submit" name="submit">Send Message</button>
    </form>
</bx:output>

🔒 Security Considerations

When outputting user-generated content or data from external sources, always encode the output to prevent XSS attacks:

<!--- Bad: No encoding --->
<p>#user.name#</p>

<!--- Good: HTML encoding --->
<p>#encodeForHTML( user.name )#</p>

<!--- For JavaScript context --->
<script>
    var userName = '#encodeForJavaScript( user.name )#'
</script>

<!--- For URL parameters --->
<a href="/profile?name=#encodeForURL( user.name )#">Profile</a>

<!--- Automatic encoding with bx:output encodefor attribute --->
<bx:output query="users" encodefor="html">
    <p>#users.name#</p>
    <p>#users.bio#</p>
</bx:output>

📚 Component Reference

For a complete list of available template components, see:

🎓 Best Practices

Use templates for views: Template files (.bxm) are ideal for HTML generation and views
Keep logic in scripts: Use <bx:script> or separate script files for complex business logic
Encode output: Always encode user-generated content using encodeForHTML() and related functions
Organize includes: Store reusable template fragments in a common directory structure
Comment your templates: Use  for documentation
Use meaningful variable names: Make your templates readable and maintainable

PreviousAnnotations NextReference

Last updated 9 days ago

Was this helpful?

hashtag📄 Template File Structure

hashtag🔤 Output Interpolation

hashtagBasic Interpolation

hashtagEscaping Hash Symbols

hashtagComplex Expressions

hashtag🏷️ Template Components

hashtagCommon Template Components

hashtagbx:output

hashtagbx:set

hashtagbx:script

hashtagbx:if, bx:elseif, bx:else

hashtagbx:loop

hashtagbx:include

hashtagAdditional Template Components

hashtagbx:param

hashtagbx:try / bx:catch / bx:finally

hashtagbx:throw

hashtagbx:abort

hashtagbx:dump

hashtagbx:exit

hashtagbx:savecontent

hashtagbx:silent

hashtag🔄 Mixing Scripts and Templates

hashtagScripts in Templates

hashtagTemplates in Scripts

hashtag🎯 Component Execution

hashtagBuilt-in Components

hashtagCustom Components

hashtagCreating a Custom Component

hashtagUsing Custom Components

hashtagComponent Discovery

hashtagConfiguring Component Paths

hashtag💡 Practical Examples

hashtagDynamic HTML Page

hashtagData Table with Query

hashtagEmail Template

hashtagForm Processing

hashtag🔒 Security Considerations

hashtag📚 Component Reference

hashtag🎓 Best Practices

hashtag🔗 Related Documentation