api-viewer-element - npm Package Compare versions

Comparing version 0.2.4 to 0.2.5

CHANGELOG.md

@@ -19,2 +19,8 @@ # Change Log
 
+## [0.2.5] - 2019-11-13
+
+### Added
+
+- Exposed `section` property to toggle between docs and demo
+
 ## [0.2.4] - 2019-11-11
@@ -21,0 +27,0 @@

lib/api-viewer.d.ts

@@ -5,2 +5,3 @@ import { LitElement, TemplateResult } from 'lit-element';
     src?: string;
+    section: string;
     private jsonFetched;
@@ -7,0 +8,0 @@ private lastSrc?;

lib/api-viewer.js

@@ -10,10 +10,14 @@ import { __decorate } from "tslib";
         super(...arguments);
+        this.section = 'docs';
         this.jsonFetched = Promise.resolve([]);
     }
     // eslint-disable-next-line class-methods-use-this
-    async renderDocs(jsonFetched) {
+    async renderDocs(jsonFetched, section) {
         const elements = await jsonFetched;
         return elements.length
             ? html `
-          <api-viewer-content .elements="${elements}"></api-viewer-content>
+          <api-viewer-content
+            .elements="${elements}"
+            .section="${section}"
+          ></api-viewer-content>
         `
@@ -63,3 +67,3 @@ : html `
         return html `
-      ${until(this.renderDocs(this.jsonFetched))}
+      ${until(this.renderDocs(this.jsonFetched, this.section))}
     `;
@@ -74,2 +78,5 @@ }
 ], ApiViewer.prototype, "src", void 0);
+__decorate([
+    property({ type: String })
+], ApiViewer.prototype, "section", void 0);
 ApiViewer = __decorate([
@@ -76,0 +83,0 @@ customElement('api-viewer')

package.json

 {
   "name": "api-viewer-element",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Web Components API viewer element",
@@ -5,0 +5,0 @@ "author": "Serhii Kulykov <[e-mail]>",

README.md

@@ -83,2 +83,11 @@ # <api-viewer>
 
+### Section
+
+By default, the API documentation is shown. If you want to show the playground instead, set the
+`section` property to `demo`:
+
+```html
+<api-viewer src="./custom-elements.json" section="demo"></api-viewer>
+```
+
 ### Knobs
@@ -85,0 +94,0 @@

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

Improved metrics

Total package byte prevSize

206318

increased by0.4%

Lines of code

2487

increased by0.32%

Number of lines in readme file

200

increased by4.71%

No dependency changes