@crestron/ch5-crcomlib - npm Package Compare versions

Comparing version 99.0.60 to 99.0.61

package.json

 {
   "name": "@crestron/ch5-crcomlib",
-  "version": "99.0.60",
+  "version": "99.0.61",
   "description": "Crestron HTML5 (CH5) Components Library",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Crestron/CH5ComponentLibrary.git"
+  },
   "keywords": [
@@ -6,0 +10,0 @@ "ch5",

README.md

@@ -40,2 +40,46 @@ <p align="center">
 
-For further details please read the developer.readme.md file.
+## Activating extra info 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 info 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>```
+
+### For the bridge relate functions/methods
+
+In order to display additional info 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](https://github.com/webcomponents/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](./DEVELOPER.README.md)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2297256

increased by0.1%

Number of lines in readme file

85

increased by107.32%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes