@craftercms/ice - npm Package Compare versions

Comparing version 1.2.2 to 1.2.3

package.json

 {
   "name": "@craftercms/ice",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Crafter CMS in-context editing library",
   "main": "./bundles/ice.umd.js",
-  "browser": "./bundles/ice.umd.js",
   "module": "./esm5/ice.js",
@@ -39,3 +38,3 @@ "es2015": "./esm2015/ice.js",
   "dependencies": {
-    "@craftercms/models": "1.2.2",
+    "@craftercms/models": "1.2.3",
     "tslib": "^1.10.0"
@@ -42,0 +41,0 @@ },

README.md

@@ -0,1 +1,3 @@
+![npm (scoped)](https://img.shields.io/npm/v/@craftercms/ice?style=plastic)
+
 # @craftercms/ice
@@ -5,4 +7,56 @@
 
-**Note**: All methods of this package work with [Content Instance](../models/src/ContentInstance.ts) as data structure they understand (the model param). Use in conjunction with `parseDescriptor` from `@craftercms/content` to obtain such data structure. 
+**Note**: All methods of this package work with [Content Instance](../models/src/ContentInstance.ts) as data structure they understand (the model param). Use in conjunction with `parseDescriptor` from `@craftercms/content` to obtain such data structure.
 
+## Usage
+
+## Via npm
+
+- `yarn add @craftercms/ice` or `npm install @craftercms/ice`
+- `import` or `require` the functions you wish.
+
+The examples below assume usage via npm. 
+
+## Via html script imports
+
+- Download the bundle and import them in your page.
+- The bundles declare a global variable named `craftercms`. You can access all craftercms' packages and functions under this root.
+- The `ice` package depends on rxjs, make sure to import rxjs too before the `ice` script.
+ 
+ **Tip**: Once you've imported the scripts, type `craftercms` on your browser's dev tools console to inspect the package(s)
+ 
+ ### Vanilla html/js example
+ ```html
+<div id="myFeature"></div>
+<script src="https://unpkg.com/rxjs"></script>
+<script src="https://unpkg.com/@craftercms/utils"></script>
+<script src="https://unpkg.com/@craftercms/classes"></script>
+<script src="https://unpkg.com/@craftercms/content"></script>
+<script src="https://unpkg.com/@craftercms/ice"></script>
+<script>
+  (function ({ content, ice }, { operators }) {
+
+    content.getItem(
+      '/site/website/index.xml',
+      { baseUrl: 'http://localhost:8080', site: 'editorial' }
+    ).pipe(
+      operators.map(content.parseDescriptor)
+    ).subscribe((model) => {
+      const attrs = ice.getICEAttributes({ model, parentModelId: '/site/website/index.xml' });
+      const elem = document.querySelector('#myFeature');
+      Object.entries(attrs).forEach(([attr, value]) => {
+        elem.setAttribute(attr, value);
+      });
+      Object.entries(model).forEach(([fieldId, value]) => {
+        if (fieldId !== 'craftercms') {
+          const el = document.createElement('div');
+          el.innerText = `${fieldId}: ${value}`;
+          elem.appendChild(el);
+        }
+      });
+    });
+
+  })(craftercms, rxjs);
+</script>
+```
+
 ## fetchIsAuthoring
@@ -9,0 +63,0 @@

No alert changes

Improved metrics

Total package byte prevSize

233995

increased by0.84%

Number of package files

52

increased by1.96%

Number of lines in readme file

288

increased by23.08%

Dependency changes

• + Added@craftercms/models@1.2.3(transitive)

• - Removed@craftercms/models@1.2.2(transitive)

• Updated@craftercms/models@1.2.3