Blog

CBWIRE 3.0.0 Released

Grant Copley May 22, 2023

Spread the word

Grant Copley

May 22, 2023

Spread the word


Share your thoughts

CBWIRE v3 is here!

We are very excited to announce the release of version 3 of CBWIRE, our ColdBox module that makes building modern, reactive apps a breeze. This version brings with it a new component syntax, 19 enhancements and bug fixes, and improved documentation. Our biggest goal with this release was to improve the developer experience and to provide a low barrier to entry to getting started with CBWIRE.

New Syntax

CBWIRE v3 now supports a simplified component syntax which makes building reactive UI components that much easier. In previous versions, creating a UI component required for you to create both a .CFC and .CFM file. The .CFC file was a CFML component where data properties, computed properties, actions, and more were placed, and the .CFM file is where the template was placed.

Now, components are completely self-contained in a single .CFM file.

Consider this contact form below, which is defined in the file ./wires/emailSignup.cfm. The template is defined within a tag and the component blueprint ( data properties, computed properties, etc ) are defined within tags.

// Render our contact form somewhere
wire( "ContactForm" );
<!--- ./wires/emailSignup.cfm --->
<!--- Template --->
<cfoutput>
    <form wire:submit.prevent="submitForm" id="contactForm">
        <div class="form-floating">
            <input wire:model.lazy="email" class="form-control" type="email" placeholder="Enter your email..." />
            <label for="email">Email address</label>
            <cfif validation.hasErrors( "email" )>
                <div class="text-danger">
                    #validation.getAllErrors( "email" ).first()#
                </div>
            </cfif>
        </div>
        
        <!--- Show if the form submit is successful --->
        <cfif success>
            <div id="submitSuccessMessage">
                <div class="text-center mb-3">
                    <div class="fw-bolder">Form submission successful!</div>
                </div>
            </div>
        </cfif>
        <button
            class="btn btn-primary text-uppercase <cfif validation.hasErrors()>disabled</cfif>"
            id="submitButton"
            type="submit">Send</button>
    </form>
</cfoutput>

<!--- Component Blueprint --->
<cfscript>
    // Validation constraints
    constraints = {
        "email": {
            "required": true,
            "type": "email"
        }
    };

    // Data properties
    data = {
        "email": "",
        "success": false
    };

    // Actions
    function submitForm() {
        // Maybe send an email here
        data.success = true;
    }
</cfscript>

Here are some other improvements you may have not noticed.

  • Data properties are now accessible in the template using #propertyName#. Before you had to scope the variables using #args.propertyName#.
  • Computed properties are now accessible using #propertyName()#. Before you had to scope using #args.computed.propertyName#.

Module Awareness

Your UI components are now module-aware, meaning that they understand what module they originate from. If you are using ColdBox modules to separate your application into various concerns, you can also place your CBWIRE components there.

Consider this application structure:

- handlers
- models
- modules_app
    - ContactForm
        - wires
            - contactForm.cfm
    - Common
        - wires
            - alert.cfm
            - button.cfm
- wires
    - globalComponent.cfm
Application.cfc
index.cfm

If you are working on your contact form and want to include a reactive alert ( let's say that the form submitted successfully ), you can reference the wire from the other module using

wire( "alert@Common" );

Also if you want to include a button component inside your alert component ( Nested Components ), you could reference it without specifying a module since both the alert and button component are in the same module.

<!--- ./wires/alert.cfm --->
<cfoutput>
    <div class="alert alert-info">
        An alert to the user.
        <cfif showCloseButton>
            #wire( "Button", { buttonText: "Close" } )#
        </cfif>
    </div>
</cfoutput>

<cfscript>
    data = {
        "showCloseButton": true
    };
</cfscript>

Improved Docs

All documentation examples have been updated to use the new syntax. https://cbwire.ortusbooks.com/

Other Changes

You can see a full list of the v3 changes here: https://cbwire.ortusbooks.com/release-history/whats-new-with-3.0

Summary

We really hope you are enjoying CBWIRE and find that it's helping you build applications faster, with less boilerplate and unnecessary JavaScript. As always, we appreciate any and all feedback and look forward to hear how you are using CBWIRE.

Add Your Comment

(1)

May 27, 2023 16:22:10 UTC

by John Farrar

Why is the first file above referencing, `wire( "ContactForm" );` and the file beneath it is `./wires/emailSignup.cfm`. I don't follow the conventions there.

Recent Entries

Ortus March Newsletter

Ortus March Newsletter

Welcome to Ortus Solutions’ monthly roundup, where we're thrilled to showcase cutting-edge advancements, product updates, and exciting events! Join us as we delve into the latest innovations shaping the future of technology.

Maria Jose Herrera
Maria Jose Herrera
April 01, 2024
Into the Box 2024 Last Early Bird Days!

Into the Box 2024 Last Early Bird Days!

Time is ticking, with less than 60 days remaining until the excitement of Into the Box 2024 unfolds! Don't let this golden opportunity slip away; our exclusive Early Bird Pricing is here for a limited time only, available until March 31st. Why wait? Secure your seat now and take advantage of this steal!

Maria Jose Herrera
Maria Jose Herrera
March 20, 2024
Ortus February Newsletter 2024

Ortus February Newsletter 2024

Welcome to Ortus Solutions’ monthly roundup, where we're thrilled to showcase cutting-edge advancements, product updates, and exciting events! Join us as we delve into the latest innovations shaping the future of technology.

Maria Jose Herrera
Maria Jose Herrera
March 06, 2024