4.2.29 • Published 3 months ago

@api-components/api-type-document v4.2.29

Weekly downloads
569
License
Apache-2.0
Repository
github
Last release
3 months ago

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 documentation table for RAML type / OAS schema properties. Works with AMF data model.

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.

Styling

<api-type-document> provides the following custom properties and mixins for styling:

Custom propertyDescriptionDefault
--api-type-documentMixin applied to this element{}
--api-type-document-union-button-background-colorBackground color of union selector button#fff
--api-type-document-union-button-colorColor of union selector button#000
--api-type-document-union-button-active-background-colorBackground color of active union selector button#CDDC39
--api-type-document-union-button-active-colorColor of active union selector button#000

From property-shape-document

Custom propertyDescriptionDefault
--property-shape-documentMixin applied each property element{}
--property-shape-document-array-colorProperty border color when type is an array#8BC34A
--property-shape-document-object-colorProperty border color when type is an object#FF9800
--property-shape-document-union-colorProperty border color when type is an union#FFEB3B
--arc-font-subheadTheme mixin, applied to the property title{}
--property-shape-document-titleMixin applied to the property title{}
--api-type-document-property-parent-colorColor of the parent property label#757575
--api-type-document-property-colorColor of the property name label when display name is used#757575
--api-type-document-child-docs-margin-leftMargin left of the item's properties description relative to the title when the item is a child property of another property24px
--api-type-document-type-colorColor of the "type" traitwhite
--api-type-document-type-background-colorBackground color of the "type" trait#2196F3
--api-type-document-trait-background-colorBackground color to main range trait (type, required, enum)#EEEEEE,
--api-type-document-trait-border-radiusBorder radius of a main property traits like type, required, enum3px

From property-range-document

Custom propertyDescriptionDefault
--property-range-documentMixin applied to this element{}
--api-type-document-type-attribute-colorColor of each attribute that describes a property#616161
--api-type-document-examples-title-colorColor of examples section title
--api-type-document-examples-border-colorExample section border colortransparent
--code-background-colorBackground color of the examples section
--arc-font-body1Mixin applied to an example name label{}
--arc-font-body2Mixin applied to the examples section title{}

Usage

Installation

npm install --save @api-components/api-type-document

In an html file

<html>
  <head>
    <script type="module">
      import '@api-components/api-type-document/api-type-document.js';
    </script>
  </head>
  <body>
    <api-type-document></api-type-document>
  </body>
</html>

In a LitElement

import { LitElement, html } from 'lit-element';
import '@api-components/api-type-document/api-type-document.js';

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

Development

git clone https://github.com/advanced-rest-client/api-type-document
cd api-type-document
npm install

Running the demo locally

npm start

Running the tests

npm test
api-components
@advanced-rest-client/arc-marked@advanced-rest-client/markdown-styles@anypoint-web-components/anypoint-button@api-components/amf-helper-mixin@api-components/api-annotation-document@api-components/api-resource-example-document@open-wc/dedupe-mixinlit-element
@infinitebrahmanuniverse/nolb-_api@everything-registry/sub-chunk-73@api-components/api-body-document@api-components/api-headers-document@api-components/api-parameters-document@api-components/api-type-documentation@zalastax/nolb-_api
4.2.29

3 months ago

4.2.28

9 months ago

4.2.26

10 months ago

4.2.27

10 months ago

4.2.24

11 months ago

4.2.22

1 year ago

4.2.23

1 year ago

4.2.20

1 year ago

4.2.21

1 year ago

4.2.19

2 years ago

4.2.18

2 years ago

4.2.17

2 years ago

4.2.16

2 years ago

4.2.15

3 years ago

4.2.14

3 years ago

4.2.13

3 years ago

4.2.12

3 years ago

4.2.11

3 years ago

4.2.9

3 years ago

4.2.8

3 years ago

4.2.10

3 years ago

4.2.7

3 years ago

4.2.6

3 years ago

4.2.5

3 years ago

4.2.4

3 years ago

4.2.3

4 years ago

4.2.2

4 years ago

4.2.1

4 years ago

4.2.0

4 years ago

4.1.2

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.5

4 years ago

4.0.6

4 years ago

4.0.4

4 years ago

4.0.3

4 years ago

4.0.2

4 years ago

4.0.1

5 years ago

4.0.0

5 years ago

3.0.11

5 years ago

3.0.10

5 years ago

3.0.9

5 years ago

3.0.8

5 years ago

3.0.7

5 years ago

3.0.6

5 years ago

3.0.5

5 years ago

3.0.4

5 years ago

3.0.3

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

3.0.0-preview.6

5 years ago

3.0.0-preview.5

5 years ago

3.0.0-preview.4

5 years ago

3.0.0-preview.3

5 years ago

3.0.0-preview.2

5 years ago

3.0.0-preview.1

5 years ago

2.0.6

6 years ago

2.0.4

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago