Polymer documentation viewer elements

Published on NPM Build status Published on webcomponents.org

<iron-doc-viewer>

A collection of elements that display documentation about custom elements, mixins, classes, and more using the JSON descriptor format produced by Polymer Analyzer.

See: Documentation, Demo.

You may also be interested in <iron-component-page>, which composes the iron-doc elements into a more complete documentation browser.

Elements

  • <iron-doc-nav> Show a table-of-contents.
  • <iron-doc-viewer> Manage routing and delegate to a child doc element.
  • <iron-doc-element> Show docs about a custom element.
  • <iron-doc-behavior> Show docs about a Polymer behavior.
  • <iron-doc-namespace> Show docs about a JavaScript namespace.
  • <iron-doc-class> Show docs about a JavaScript class.
  • <iron-doc-mixin> Show docs about a JavaScript mixin.

Usage

Installation

npm install --save @polymer/iron-doc-viewer

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/polymer/lib/elements/dom-bind.js';
      import '@polymer/iron-ajax/iron-ajax.js';
      import '@polymer/iron-doc-viewer/iron-doc-viewer.js';
    </script>
  </head>

  <body>
    <dom-bind>
      <template>
        <iron-ajax
          auto
          url="./analysis.json"
          last-response="{{descriptor}}">
        </iron-ajax>

        <iron-doc-viewer
          descriptor="[[descriptor]]"
          root-namespace="MyNamespace">
        </iron-doc-viewer>
      </template>
    </dom-bind>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-doc-viewer/iron-doc-viewer.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <iron-doc-viewer
        descriptor="[[descriptor]]"
        root-namespace="MyNamespace">
      </iron-doc-viewer>
    `;
  },

  static get properties() {
    return {
      descriptor: {
        type: Object,
        value: {
          // Analyzer descriptor goes here.
        }
      }
    };
  }
}

customElements.define('sample-element', SampleElement);

Routing

<iron-doc-viewer> handles URL routing to provide permanent addresses for all locations in the documentation tree, including scroll anchor targets.

By default it uses the URL fragment for routing (e.g. docs.html#/elements/my-element#property-foo), in order to support simple static file hosts.

To use the real URL path for routing, set the base-href property to the server mount point, omitting the trailing slash (e.g. /api/docs or empty string for the root path). Note that this requires a host that serves the application from all paths that should be handled by the doc viewer.

Styling

The iron-doc elements come with an optional material-design default theme that must be explicitly included as custom style:

<script type="module">
  import '@polymer/iron-doc-viewer/default-theme.js';
</script>

<custom-style>
  <style is="custom-style" include="iron-doc-default-theme"></style>
</custom-style>

The following custom properties and mixins are available for styling:

Custom property Description Default
--iron-doc-accent-color Color for emphasis (e.g. hyperlink hover). #1565c0
--iron-doc-font-body Mixin applied to non-code text. {}
--iron-doc-font-code Mixin applied to code snippets. {}
--iron-doc-title Mixin applied to page titles. {}
--iron-doc-heading Mixin applied to section headings. {}

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/iron-doc-viewer
cd iron-doc-viewer
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Install

Link to this version
ImportedReleased 08 May 2018Other
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (4.0.1)Polymer 3 (4.0.1)
Browser Compatibility
Install with
bower install --save PolymerElements/iron-doc-viewer"#3.3.2"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.3.2

Dependencies

  • polymer#Polymer/polymer#1.9 - 2
  • iron-location#PolymerElements/iron-location#1 - 2
  • marked-element#PolymerElements/marked-element#1 - 2
  • paper-styles#PolymerElements/paper-styles#1 - 2
  • prism-element#PolymerElements/prism-element#1 - 2