What's New?
Updates to the Crestron HTML5 User Interface and documentation are described below from newest to oldest.
August 6, 2026
- Crestron Virtual Panel Released
- The Crestron Virtual Panel application has been released publicly.
- Documentation Updates
- Added new Crestron Virtual Panel Deployment topics.
July 7, 2026
- Crestron HTML5 User Interface v2.18 Released
- Crestron HTML5 User Interface v2.18 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Added support for defaultLanguage parameter in project-config.json file to Add or Remove Languages, Project Configuration File, and Project Config Function.
- Added new HTML Div component topic.
- Updated Button and Slider component topics with support for new features.
- Added TSW-80 and TS-80 specifications to Touch Screen Emulation.
- Font Awesome version updated and Material symbols added to the icon list. For more information on using icon classes, refer to Icon Classes.
- Updated Showcase Application to reflect CH5 2.18.
May 20, 2026
- Crestron HTML5 User Interface v2.17.3 Released
- Crestron HTML5 User Interface v2.17.3 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Added direct connect support to Media Player.
- Added new CH5 Image Credential Migration topic that covers authentication changes for credential-based images and video streams.
- Updated Showcase Application to reflect CH5 2.17.3.
March 3, 2026
- Crestron HTML5 User Interface v2.17.2 Released
- Crestron HTML5 User Interface v2.17.2 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Updated Showcase Application to reflect CH5 2.17.2.
February 11, 2026
- Crestron HTML5 User Interface v2.17.1 Released
- Crestron HTML5 User Interface v2.17.1 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Added new Required Project Files topic to indicate libraries and files that must be imported into all CH5 projects.
- Added additional design considerations to Media Player.
- Updated Showcase Application to reflect CH5 2.17.1.
December 9, 2025
- Crestron HTML5 User Interface v2.17 Released
- Crestron HTML5 User Interface v2.17 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Added new component topic for Media Player.
- Updated Showcase Application to reflect CH5 2.17.
October 14, 2025
- Crestron HTML5 User Interface v2.16.1 Released
- Crestron HTML5 User Interface v2.16.1 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Updated Showcase Application to reflect CH5 2.16.1.
August 19, 2025
- Crestron HTML5 User Interface v2.16 Released
- Crestron HTML5 User Interface v2.16 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Updated Theme Builder to describe the ability to save themes with new names.
July 8, 2025
- Crestron HTML5 User Interface v2.15 Released
- Crestron HTML5 User Interface v2.15 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Added new Add an Animation to a Page or Widget topic to How Do I? for Crestron Template Project tasks.
- Updated Add a Custom Background with information about background configurations moving to the Theme Builder.
- Updated Add XPanel to Custom (Non‑Template) Project with latest code samples.
- Updated Project Configuration File to remove deprecated background properties and theme extensions.
- Updated Custom Fonts to describe import function.
May 27, 2025
- Crestron HTML5 User Interface v2.14 Released
- Crestron HTML5 User Interface v2.14 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Depreciated existing content for extending custom themes via the SASS software project and replaced with instructions for using the Theme Builder tool and how to Add a Custom Theme to the Template Project.
April 15, 2025
- Crestron HTML5 User Interface v2.13 Released
- Crestron HTML5 User Interface v2.13 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Updated Button and Known Limitations topics with note on subpixel rendering of button borders in web browsers.
- Updated Showcase Application to reflect CH5 2.13.
March 4, 2025
- Crestron HTML5 User Interface v2.12 Released
- Crestron HTML5 User Interface v2.12 has been released publicly. Refer to the release notes posted to the Crestron website via the Resources page for detailed information about this release.
- Documentation Updates
- Updated Showcase Application to reflect CH5 2.12.
January 13, 2025
- Crestron HTML5 User Interface v2.11.2 Released
- Crestron HTML5 User Interface v2.11.2 has been released publicly.
- Documentation Updates
- Updated Showcase Application to reflect CH5 2.11.2.
August 28, 2024
- Crestron HTML5 User Interface v2.11.1 Released
- Crestron HTML5 User Interface v2.11.1 has been released publicly.
- Documentation Updates
- Added design consideration about video incompatibility with scrolling lists to Video (Beta).
- Updated Showcase Application to reflect CH5 2.11.1.
July 30, 2024
- Crestron HTML5 User Interface v2.11 Released
- Crestron HTML5 User Interface v2.11 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.11 changes, including (but not limited to):
- Component Topics: Slider, Video (Beta)
- Updated Showcase Application to reflect CH5 2.11.
July 12, 2024
- Documentation Updates
- Added new Control Systems and Self-Signed Certificates topic for HTML5 Web XPanel deployments.
May 21, 2024
- Crestron HTML5 User Interface v2.10 Released
- Crestron HTML5 User Interface v2.10 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.10 changes, including (but not limited to):
- Crestron Template Project Performance Optimization
- Component Topics: QR Code
- Updated Showcase Application to reflect CH5 2.10.
May 1, 2024
- Crestron HTML5 User Interface v2.9.1 Released
- Crestron HTML5 User Interface v2.9.1 has been released publicly.
- Documentation Updates
- Updated Showcase Application to reflect CH5 2.9.1.
April 16, 2024
- Crestron HTML5 User Interface v2.9 Released
- Crestron HTML5 User Interface v2.9 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.9 changes, including (but not limited to):
- Create Custom HTML Themes (introducing CSS variables), Crestron Template Project Performance Optimization
- Component Topics: Video Switcher
- Updated Showcase Application to reflect CH5 2.9.
January 9, 2024
- Crestron HTML5 User Interface v2.8 Released
- Crestron HTML5 User Interface v2.8 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.8 changes, including (but not limited to):
- Updated Showcase Application to reflect CH5 2.8.
December 6, 2023
- Crestron HTML5 User Interface v2.7 Released
- Crestron HTML5 User Interface v2.7 has been released publicly.
- Support has been added for creating Zoom Rooms control projects in CH5.
- Documentation Updates
- Added or updated various topics based on CH5 v2.7 changes, including (but not limited to):
- Updated Showcase Application to reflect CH5 2.7.
October 24, 2023
- Crestron HTML5 User Interface v2.6 Released
- Crestron HTML5 User Interface v2.6 has been released publicly.
- Documentation Updates
- Minimum Node.js (20.04.0) and NPM (9.7.2) versions have been updated for CH5 v2.6. Refer to System Requirements for details.
- Updated Showcase Application to reflect CH5 2.6.
September 7, 2023
- Crestron HTML5 User Interface v2.5 Released
- Crestron HTML5 User Interface v2.5 has been released publicly.
- Documentation Updates
- Removed all mentions of the software mobility license (SW‑MOBILITY). This license is no longer required to deploy CH5 projects for use with the HTML5 Web XPanel functionality or the Crestron ONE™ app.
- Documented that the standalone component reference documentation has been retired as of this release and is now merged with the Showcase Application.
- Added and updated various topics based on CH5 v2.5 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Date and Time, Text
- Updated Showcase Application to reflect CH5 2.5
August 1, 2023
- Crestron HTML5 User Interface v2.4.1 Released
- Crestron HTML5 User Interface v2.4.1 has been released publicly.
- Documentation Updates
- Updated various topics based on CH5 v2.4.1 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Video (Beta)
- Updated Showcase Application and Component Reference to reflect CH5 2.4.1
June 29, 2023
- Crestron HTML5 User Interface v2.4 Released
- Crestron HTML5 User Interface v2.4 has been released publicly.
- Documentation Updates
- Updated various topics based on CH5 v2.4 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Button, Slider
- Best Practices topics: Crestron Template Project Performance Optimization
- Updated Showcase Application and Component Reference to reflect CH5 2.4
May 9, 2023
- Crestron HTML5 User Interface v2.3.1 Released
- Crestron HTML5 User Interface v2.3.1 has been released publicly.
- Documentation Updates
- Updated various topics based on CH5 v2.3.1 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Button
- Best Practices topics: Crestron Template Project Performance Optimization
March 29, 2023
- Crestron HTML5 User Interface v2.3 Released
- Crestron HTML5 User Interface v2.3 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.3 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Button List, Subpage Reference List, Tab Button
- Best Practices topics: Crestron Template Project Performance Optimization
- Reference topics: Hard Buttons JSON File
- Updated Showcase Application and Component Reference to reflect CH5 2.3
January 10, 2023
- Crestron HTML5 User Interface v2.2 Released
- Crestron HTML5 User Interface v2.2 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.2 changes, including (but not limited to):
- Using CH5 Components and Themes topics: Segmented Gauge, Wi‑Fi Signal Level Gauge
- Best Practices topics: Crestron Template Project Performance Optimization
- Updated Showcase Application and Component Reference to reflect CH5 2.2
November 28, 2022
- Crestron HTML5 User Interface v2.1 Released
- Crestron HTML5 User Interface v2.1 has been released publicly.
- Documentation Updates
- Added or updated various topics based on CH5 v2.1 changes, including (but not limited to):
- Getting Started topics: Install CH5 Developer Tools
- Using CH5 Components and Themes topics: Animation Object, Color Chip, Color Picker (Beta), Signal Level Gauge
- Best Practices topics: Crestron Template Project Performance Optimization
- Updated Showcase Application and Component Reference to reflect CH5 2.1
August 22, 2022
- Crestron HTML5 User Interface v2.0 Released
- Crestron HTML5 User Interface v2.0 has been released publicly.
- Minimum Node.js and NPM versions have been updated for CH5 v2.0. Refer to System Requirements for details.
- Documentation Updates
- Added or updated various topics based on CH5 v2.0 changes, including (but not limited to):
- Getting Started topics: Install CH5 Developer Tools
- Using the Crestron Template Project topics: Setup, Upgrade a Project from v1 to v2, Update a Project
- Using CH5 Components and Themes topics: D-Pad, Join to Text (Boolean), Join to Text (Numeric), Join to Text (String), Keypad
- Testing and Debugging topics: View Project Information
- Best Practices topics: Crestron Template Project Performance Optimization
- Updated Showcase Application and Component Reference to reflect CH5 2.0
- General improvements and updates to code snippet formatting throughout document
December 20, 2021
- HTML5 Web XPanel Support for the Safari® Browser on iOS® and iPadOS® Devices
- HTML5 Web XPanel projects can now be run on the Safari browser from an iOS or iPadOS device.
- A secure communications certificate must be created to allow HTML5 Web Panel projects running on Safari for the iOS or iPadOS platforms to communicate with the control system.
- Documentation Updates
- Added new Create Certificates for Safari on iOS and iPadOS Platforms to explain how to create a secure communications certificate for HTML5 Web XPanel projects running on the Safari browser via an iOS or iPadOS device.
November 19, 2021
- Crestron HTML5 User Interface v1.2 Released
- Includes the NPM packages @crestron/ch5-webxpanel@1.2.5 and @crestron/ch5-crcomlib@1.2.0.
- Added support for running the HTML5 Web XPanel from the Crestron Fusion® software user interface without requiring purchase of a SW-MOBILITY license.
- Made URL parameters case insensitive.
- Updated the Info dialog to include the status of the gathering token and license requirements.
- The state of components is properly displayed when running the HTML5 Web XPanel after the control system is restarted, the control system program is reloaded, or the connection to the control system is reestablished.
- Documentation Updates
- Updated Deploy the Project topic for the HTML5 Web XPanel platform to include instructions for deploying the CH5 project onto a static web server.
June 1, 2021
- Added Crestron ONE™ App Support (version 1.1.27)
- When set to HTML5 UI mode, the Crestron ONE™ app enables custom Crestron HTML5 User Interface projects to be loaded into the application, creating a personalized user control experience for the home or office.
- Programming for the Crestron ONE app uses the same Crestron HTML5 User Interface scripts and components needed for touch screen and HTML Web XPanel deployments.
- Refer to Overview for information on supported browsers and control systems.
- Documentation Updates
- Added documentation for Crestron ONE app support.
- Added new Advanced Programming topics for creating custom Crestron Template Project components.
May 5, 2021
- HTML5 Web XPanel Support Update
- New version of the ch5 webxpanel library (1.03) is now available.
- Added support for Crestron Virtual Control (VC-4) software (version 2.4557.00147 or later)
- Bug Fixes:
- Corrected issue where control system hostnames containing "http" or "ws" did not default the WebSocket URL correctly.
- The Room ID will now be defaulted based upon the URL provided and not just the URL parameter "roomId."
February 17, 2021
- Added .AV Framework Support
- Crestron HTML5 User Interface can be used to create custom touch screen projects for .AV Framework™ software (AVF Pro 6.9 or higher). The Crestron HTML5 User Interface for .AV Framework project uses the same components as regular CH5 projects, but a custom AVF-CH5 contract is used to map the UI components to specific functionality within .AV Framework.
- Refer to AV Framework™ Software for information on creating a custom .AV Framework project with Crestron HTML5 User Interface.
- Refer to Downloads to download the latest AVF-CH5 project.
- Documentation Updates
- Add XPanel to Custom (Non‑Template) Project: Updated TypeScript example in Configuration and Initialization section.
February 1, 2021
- Added HTML5 Web XPanel functionality
- Transform any compatible HTML5 web browser into a virtual Crestron® touch screen with HTML5 Web XPanel on Windows®, macOS® and Android™ platforms. HTML5 Web XPanel works on any computer platform and any screen size using a mouse, touch screen display, or other pointing devices.
- Programming for HTML5 Web XPanel uses the same Crestron HTML5 User interface with the inclusion of the required HTML Web XPanel library and configuration to enable.
- Refer to Overview for information on supported browsers and control systems.
- Added Crestron Template Project
- The Crestron Template Project simplifies the development of HTML projects. Pages and reusable widgets can be created via the command line or one‑click NPM scripts (such as when using Visual Studio Code). By using these scripts, developers no longer need to edit the index.html file directly. All development work is contained within the project folder. Import and export scripts are also provided that allow a developer to extract (export) a page or widget and to easily bring these items into other projects (import).
- Refer to Setup for information on downloading and setting up the Crestron Template Project.
- CH5 CLI Script Enhancements (version @crestron/ch5-utilities-cli@0.1.52)
- Allows credentials to be provided via environment variables (Refer to Considerations for Credentials).
- Allows deployment using public and private key pairs (Refer to Considerations for Credentials).
- Provides a "slow mode" deployment feature for rare instances where deployment to touch screen fails (Refer to Slow Mode (CH5 CLI Deploy).
- Performance Enhancements
- Improved performance of <ch5-button> in browsers using mouse events (@crestron/ch5-crcomlib@1.1.0).
- Documentation Updates
- Added documentation for HTML5 Web XPanel and Crestron Template Project.
- Restructured microsite contents to improve user experience.
- Added Create UI Elements, Platform Deployment, and Component Reference sections.
- Added content to various topics and sections, including Best Practices, Resources, and Downloads sections.