@biz-dev-ops/model-viewer-component
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

Model Viewer for md-docs

HTML5 web component which renders every JSON-schema object into a human-readable and -understandable form.

Usage

  • Add model-viewer.js to the webpage
  • Add the model JSON to the global object window.modelViewer .
  • Add the <model-viewer></model-viewer> to the page

Attributes

id

The id attribute identifies the property within the window.modelViewer.

name

The name attribute is a human-readable name fallback. Only used when the model doesn't provide a title.

data-json

A HTML escaped version of the JSON-schema model.

model

The JSON-schema model, must be set via JavaScript.

Examples

HTML

<model-viewer 
    id="trainset"
    name="a name"
    data-json="{ &quot;key &quot;: &quot;value &quot; }" />

HTML and JavaScript

<model-viewer id="trainset" />

<script>
    document.getElementById('trainset').model = {
    	json-schema...
    }
<script>

/@biz-dev-ops/model-viewer-component/

    Package Sidebar

    Install

    npm i @biz-dev-ops/model-viewer-component

    Weekly Downloads

    1

    Version

    0.2.0

    License

    Apache 2.0

    Unpacked Size

    203 kB

    Total Files

    33

    Last publish

    Collaborators

    • stiekstra
    • arjangeertsema