Required Project Files

Regardless of the technology stack used in a CH5 project (JavaScript, TypeScript, Angular, React, and so forth), the following two libraries must be included in the project to ensure compatibility with all current and future CH5 components: CrComLib (CH5 Component Library) and Ch5Theme (CH5 Theme Editor).

The following files must be imported into the project from these libraries:

NOTE: All required files and libraries are located within the node_modules/@crestron directory.

CH5 Component Library
- cr-com-lib.js (available within ch5-crcomlib/build_bundles/ and in the amd, cjs, and umd folders)
- If JSON files are required (optional), ch5-crcomlib/build_bundles/generate-metadata can be used to select the JSON files.
CH5 Theme Library
- ch5-theme/output/themes/css (import the entire directory)
- ch5-theme/output/themes/font (import Material Icons)
- ch5-theme/output/themes/fonts (import Media Player Icons)
- ch5-theme/output/themes/svg (import Media Transport Icons)
- ch5-theme/output/themes/webfonts (import Font Awesome Icons)

Additionally, the ch5-webxpanel (CH5 Virtual Panel) library should be included in the project to connect to the control system. As needed, import ch5‑webxpanel/dist/ as well as the index.js file located within the amd, cjs, and umd folders.

Have feedback on this document? Contact docfeedback@crestron.com.

All brand names, product names and trademarks are the property of their respective owners. Certain trademarks, registered trademarks, and trade names may be used to refer to either the entities claiming the marks and names or their products. Crestron disclaims any proprietary interest in the marks and names of others. Crestron is not responsible for errors in typography or photography. Specifications are subject to change without notice.