CBWIRE
InstallSource CodeIssuesSupport
v3.x
v3.x
  • Introduction
  • Getting Started
  • Configuration
  • How It Works
  • Release History
    • What's New With 3.2
    • What's New With 3.1
    • What's New With 3.0
    • What's New With 2.2
    • What's New With 2.1
    • What's New With 2.0
  • Examples
    • Contact Form
    • Multi-select Input
    • File Upload
  • Resources
  • The Essentials
    • Components
    • Templates
    • Data Properties
    • Computed Properties
    • Actions
    • Events
    • Lifecycle Methods
    • JavaScript
    • Testing
  • Wire Features
    • Validation
    • File Uploads
    • Query String
    • Redirecting
    • WireBox
  • Template Features
    • Directives
    • Loading States
    • Polling
    • Prefetching
    • Offline State
    • Defer Loading
    • Dirty State
  • Integrations
    • ContentBox CMS
    • SPAs with Turbo
    • AlpineJS
Powered by GitBook
On this page
  • Requirements
  • Installation
  • Layout Setup
  • Next Steps

Getting Started

Every journey starts somewhere.

PreviousIntroductionNextConfiguration

Last updated 1 year ago

Requirements

  • Adobe ColdFusion 2018+ or Lucee 5+

  • ColdBox 6+

Installation

Install .

Within the root of your project, run:

box install cbwire@3

If you want the latest bleeding edge, run:

box install cbwire@be

Layout Setup

CBWIRE requires some lightweight CSS and JavaScript to be added to your ColdBox layout.

You can have CBWIRE do this for you by enabling the autoInjectAssets property in your config/ColdBox.cfc file.

// config/ColdBox.cfc
moduleSettings = {
    "cbwire" : {
        "autoInjectAssets": true
    }
};

You can also manually add the references by calling wireStyles() and wireScripts() in your layout file.

<!--- ./layouts/Main.cfm --->
<cfoutput>
<!DOCTYPE html>
<html lang="en">
    <head>
        <title>My Page</title>
        <!--- CBWIRE CSS --->
        #wireStyles()#
    </head>
    <body>
        <!--- CBWIRE JS --->
        #wireScripts()#
    </body>
</html>
</cfoutput>

CBWIRE will not work if you do not add the wireStyles() and wireScripts() references to your layout or enable autoInjectAssets.

Next Steps

You are ready to go. Now head to the section to learn how to create and use CBWIRE components.

We also have numerous you can review to get up and running quickly.

CommandBox
Configuration
Making Components
Examples