npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@api-components/api-type-document

v4.2.29

Published

A documentation table for type (resource) properties. Works with AMF data model

Downloads

528

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jarrodekjarrodektwoplustwoonetwoplustwoonelbauretlbauretcarowrightcarowright

Keywords

api-components

Readme

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 property | Description | Default ----------------|-------------|---------- --api-type-document | Mixin applied to this element | {} --api-type-document-union-button-background-color | Background color of union selector button | #fff --api-type-document-union-button-color | Color of union selector button | #000 --api-type-document-union-button-active-background-color | Background color of active union selector button | #CDDC39 --api-type-document-union-button-active-color | Color of active union selector button | #000

From property-shape-document

Custom property | Description | Default ----------------|-------------|---------- --property-shape-document | Mixin applied each property element | {} --property-shape-document-array-color | Property border color when type is an array | #8BC34A --property-shape-document-object-color | Property border color when type is an object | #FF9800 --property-shape-document-union-color | Property border color when type is an union | #FFEB3B --arc-font-subhead | Theme mixin, applied to the property title | {} --property-shape-document-title | Mixin applied to the property title | {} --api-type-document-property-parent-color | Color of the parent property label | #757575 --api-type-document-property-color | Color of the property name label when display name is used | #757575 --api-type-document-child-docs-margin-left | Margin left of the item's properties description relative to the title when the item is a child property of another property | 24px --api-type-document-type-color | Color of the "type" trait | white --api-type-document-type-background-color | Background color of the "type" trait | #2196F3 --api-type-document-trait-background-color | Background color to main range trait (type, required, enum) | #EEEEEE, --api-type-document-trait-border-radius | Border radius of a main property traits like type, required, enum | 3px

From property-range-document

Custom property | Description | Default ----------------|-------------|---------- --property-range-document | Mixin applied to this element | {} --api-type-document-type-attribute-color | Color of each attribute that describes a property | #616161 --api-type-document-examples-title-color | Color of examples section title | `--api-type-document-examples-border-color` | Example section border color | `transparent` `--code-background-color` | Background color of the examples section | --arc-font-body1 | Mixin applied to an example name label | {} --arc-font-body2 | Mixin 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