Namespace, Primitive, Method

    @api-components/api-headers-document
    TypeScript icon, indicating that this package has built-in type declarations

    4.2.3 • Public • Published

    api-headers-document

    Documentation component for API headers based on AMF data model.

    Published on NPM

    Tests and publishing

    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-headers-document

    In an html file

    <html>
       <head>
         <script type="module">
           import '@api-components/api-headers-document/api-headers-document.js';
         </script>
       </head>
       <body>
         <api-headers-document></api-headers-document>
       </body>
    </html>
    import { LitElement, html } from 'lit-element';
    import '@api-components/api-headers-document/api-headers-document.js';
    
    class SampleElement extends PolymerElement {
      render() {
        return html`
        <api-headers-document .amf="${this.amf}"></api-headers-document>
        `;
      }
    }
    customElements.define('sample-element', SampleElement);

    Development

    git clone https://github.com/api-components/api-headers-document
    cd api-headers-document
    npm install

    Running the demo locally

    npm start

    Running the tests

    npm test

    Install

    npm i @api-components/api-headers-document

    DownloadsWeekly Downloads

    382

    Version

    4.2.3

    License

    Apache-2.0

    Unpacked Size

    16.5 kB

    Total Files

    10

    Last publish

    Collaborators

    • jarrodek
    • twoplustwoone
    • lbauret
    • carowright