Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@crestron/ch5-crcomlib

Package Overview
Dependencies
Maintainers
2
Versions
449
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@crestron/ch5-crcomlib

Crestron HTML5 (CH5) Components Library

  • 99.0.424
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
788
decreased by-39.34%
Maintainers
2
Weekly downloads
 
Created
Source

CH5 - Creston Components library (CrComLib) - Getting Started

Continuous Integration and Deployment Status
DEV NIGHTLY - latest-devStatus
Build PipelineBuild status
Release PipelineDeployment status
NPMnpm (tag)
MASTER-QE - latest-qeStatus
Build PipelineBuild status
Release PipelineDeployment status
NPMnpm (tag)

See Crestron Labs for documentation

http://www.crestronlabs.com/forumdisplay.php?229-Crestron-HTML5-Lab

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 ch5 components

Ch5 components will display additional info in the browser console if they have a debug attribute defined. For example: <ch5-button debug label="Btn1"></ch5-button>

For ch5 custom attributes (dta-ch5-...)

Additional information will be displayed in the browser console if the element has a debug attribute. For example: <div debug data-ch5-show="a_signal">Hello</div>

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

Using the library

When using a no-ce build (a build intended for browsers that do not support customElements)

When importing the library in a webpage, two additional webcomponentsjs scripts should be included before the library:

  • The first one for the polyfills used by browsers that do not yet support customElements or that have partial support. For example, from CDN:
<script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.1.3/webcomponents-loader.js" type="text/javascript" charset="utf-8"></script>
  • The second one for allowing browsers that support customElements to also be able to use them from ES5. For example, from CDN:
<script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.1.3/custom-elements-es5-adapter.js" type="text/javascript" charset="utf-8"></script>

When using a build that does not have a 'no-ce' ending for the foldername

Browsers that do not support customElements will not be able to use the library

For more information, please consult the DEVELOPER.README

Keywords

FAQs

Package last updated on 31 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc