CH5 - Creston Components library (CrComLib) - Getting Started
Continuous Integration and Deployment Status
| DEV NIGHTLY - latest-dev | Status |
|---|---|
| Build Pipeline | |
| Release Pipeline | |
| NPM |  |
| MASTER-QE - latest-qe | Status |
|---|---|
| Build Pipeline | |
| Release Pipeline | |
| NPM |  |
See Crestron developer website for documentation
https://www.crestron.com/developer Search for CRESTRON HTML5 USER INTERFACE
Generated folders
- build_bundles/module_type - contains files generated by webpack (and the typescript compiler for the esm modules)
- compiled_bundles/module_type - contains files generated by the typescript compiler (tsc)
- docs/html
Where module_type is:
- umd - UMD (contains CommonJs, AMD, and also creates a global property in the window object).
- cjs - CommonJs
- esm - ES Modules, ES6.
- amd - Asynchronous Module Definition
Activating extra informmation in the browser console
For the bridge-related functions/methods
In order to display additional information, you must first enable this using the methods from Ch5Debug:
- getConfig - Returns the current configuration: all keys that can be set and their current value. A key enables debug info for a method/function
- loadConfig(cfg) - Loads a new config (replaces the previous one)
- enableAll() - Enables all keys. Will display all debug info available. (The debug info that uses Ch5Debug, the info from ch5 components, and custom attributes will not be affected)
- disablesAll() - Disables all keys
- setConfigKeyValue(key:string, value:boolean) - Changes the value of a key
Build Dev Universal Module Definition
npm run build:dev:umd
Run Test web-component-tester
npm run test:wct
Start
npm run start
npm link
cd crestron-components-lib npm link
cd CH5Sandbox\shell-template
npm link @crestron/ch5-crcomlib
yarn link
cd crestron-components-lib yarn link
cd CH5Sandbox\shell-template
yarn link @crestron/ch5-crcomlib