npm.io
4.1.1 • Published 4 years ago

@api-components/api-documentation-document

Licence
Apache-2.0
Version
4.1.1
Deps
4
Size
10 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

DEPRECATED

This component is being deprecated. The code base has been moved to api-documentation module. This module will be archived when PR 37 is merged.

A component to render documentation node of the AMF model

<api-documentation-document amf="{...}" shape="{...}"></api-documentation-document>

Version compatibility

This version only works with AMF model version 2 (AMF parser >= 4.0.0). For compatibility with previous model version use 3.x.x version of the component.

Usage

Installation
npm install --save @api-components/api-documentation-document
In an html file
<html>
  <head>
    <script type="module">
      import '@api-components/api-documentation-document/api-documentation-document.js';
    </script>
  </head>
  <body>
    <api-documentation-document></api-documentation-document>
  </body>
</html>
In a LitElement
import { LitElement, html } from 'lit-element';
import '@api-components/api-documentation-document/api-documentation-document.js';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <api-documentation-document .amf="${this.amf}"></api-documentation-document>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Development

git clone https://github.com/advanced-rest-client/api-documentation-document
cd api-documentation-document
npm install
Running the demo locally
npm start
Running the tests
npm test

API components

This components is a part of API components ecosystem

Keywords

api-componentsapi-consoledocumentationapi-fragment