@api-components/api-example-generator
Advanced tools
Comparing version
@@ -1,3 +0,3 @@ | ||
import {PolymerElement} from '@polymer/polymer/polymer-element.js'; | ||
import {AmfHelperMixin} from '@api-components/amf-helper-mixin/amf-helper-mixin.js'; | ||
import {PolymerElement} from '../../@polymer/polymer/polymer-element.js'; | ||
import {AmfHelperMixin} from '../../@api-components/amf-helper-mixin/amf-helper-mixin.js'; | ||
/** | ||
@@ -4,0 +4,0 @@ * `api-example-generator` |
@@ -11,3 +11,3 @@ { | ||
"name": "@api-components/api-example-generator", | ||
"version": "3.0.0-preview.2", | ||
"version": "3.0.0-preview.4", | ||
"license": "Apache-2.0", | ||
@@ -21,18 +21,18 @@ "main": "api-example-generator.js", | ||
"@api-components/api-model-generator": "^0.1.10", | ||
"@api-components/api-navigation": "^3.0.0-preview.1", | ||
"@api-components/api-navigation": "^3.0.0-preview.2", | ||
"@polymer/gen-typescript-declarations": "^1.6.1", | ||
"@polymer/iron-demo-helpers": "^3.0.0", | ||
"@polymer/iron-component-page": "^4.0.0", | ||
"@polymer/iron-demo-helpers": "^3.1.0", | ||
"@polymer/iron-test-helpers": "^3.0.0", | ||
"@webcomponents/webcomponentsjs": "^2.0.0", | ||
"@polymer/paper-checkbox": "^3.0.0", | ||
"@polymer/paper-dropdown-menu": "^3.0.0", | ||
"@polymer/paper-item": "^3.0.0", | ||
"@polymer/paper-listbox": "^3.0.0", | ||
"@polymer/paper-item": "^3.0.0", | ||
"@polymer/paper-checkbox": "^3.0.0", | ||
"web-animations-js": "^2.3.1", | ||
"@polymer/test-fixture": "^4.0.2", | ||
"@webcomponents/webcomponentsjs": "^2.0.0", | ||
"chai": "^4.2.0", | ||
"mocha": "^5.2.0", | ||
"sinon": "^7.2.3", | ||
"wct-mocha": "^1.0.0" | ||
"sinon": "^7.3.0", | ||
"wct-mocha": "^1.0.0", | ||
"web-animations-js": "^2.3.1" | ||
}, | ||
@@ -54,4 +54,4 @@ "scripts": { | ||
"dependencies": { | ||
"@polymer/polymer": "^3.0.0" | ||
"@polymer/polymer": "^3.2.0" | ||
} | ||
} |
@@ -1,9 +0,11 @@ | ||
[](https://travis-ci.org/advanced-rest-client/api-example-generator) | ||
[](https://www.npmjs.com/package/@api-components/api-example-generator) | ||
[](https://www.webcomponents.org/element/advanced-rest-client/api-example-generator) | ||
[](https://travis-ci.org/api-components/api-example-generator) | ||
# api-example-generator | ||
[](https://www.webcomponents.org/element/api-components/api-example-generator) | ||
Examples generator from AMF model | ||
## <api-example-generator> | ||
Examples generator from AMF model. | ||
```html | ||
@@ -15,2 +17,61 @@ <api-example-generator></api-example-generator> | ||
This components is a part of API components ecosystem: https://elements.advancedrestclient.com/ | ||
This components is a part of [API components ecosystem](https://elements.advancedrestclient.com/) | ||
## Usage | ||
### Installation | ||
``` | ||
npm install --save @api-components/api-example-generator | ||
``` | ||
### In an html file | ||
```html | ||
<html> | ||
<head> | ||
<script type="module"> | ||
import '@api-components/api-example-generator/api-example-generator.js'; | ||
</script> | ||
</head> | ||
<body> | ||
<api-example-generator></api-example-generator> | ||
</body> | ||
</html> | ||
``` | ||
### In a Polymer 3 element | ||
```js | ||
import {PolymerElement, html} from '@polymer/polymer'; | ||
import '@api-components/api-example-generator/api-example-generator.js'; | ||
class SampleElement extends PolymerElement { | ||
static get template() { | ||
return html` | ||
<api-example-generator></api-example-generator> | ||
`; | ||
} | ||
} | ||
customElements.define('sample-element', SampleElement); | ||
``` | ||
### Installation | ||
```sh | ||
git clone https://github.com/api-components/api-example-generator | ||
cd api-url-editor | ||
npm install | ||
npm install -g polymer-cli | ||
``` | ||
### Running the demo locally | ||
```sh | ||
polymer serve --npm | ||
open http://127.0.0.1:<port>/demo/ | ||
``` | ||
### Running the tests | ||
```sh | ||
polymer test --npm | ||
``` |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
77
381.25%92302
-98.27%5
-92.96%1461
-99.54%1
Infinity%Updated