Skip to content

Commit b5693ab

Browse files
committed
chore: deprecating the component
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
1 parent a9ffefe commit b5693ab

File tree

3 files changed

+2198
-2518
lines changed

3 files changed

+2198
-2518
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-type-document.svg)](https://www.npmjs.com/package/@api-components/api-type-document)
1+
# DEPRECATED
22

3-
[![Build Status](https://travis-ci.com/advanced-rest-client/api-type-document.svg)](https://travis-ci.com/advanced-rest-client/api-type-document)
3+
This component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.
44

5-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/advanced-rest-client/api-type-document)
6-
7-
## &lt;api-type-document&gt;
5+
-----
86

97
A documentation table for RAML type / OAS schema properties. Works with AMF data model.
108

@@ -19,7 +17,7 @@ For compatibility with previous model version use `3.x.x` version of the compone
1917

2018
Custom property | Description | Default
2119
----------------|-------------|----------
22-
`--api-type-document` | Mixin applied to this elment | `{}`
20+
`--api-type-document` | Mixin applied to this element | `{}`
2321
`--api-type-document-union-button-background-color` | Background color of union selector button | `#fff`
2422
`--api-type-document-union-button-color` | Color of union selector button | `#000`
2523
`--api-type-document-union-button-active-background-color` | Background color of active union selector button | `#CDDC39`
@@ -29,7 +27,7 @@ From `property-shape-document`
2927

3028
Custom property | Description | Default
3129
----------------|-------------|----------
32-
`--property-shape-document` | Mixin applied each proeprty element | `{}`
30+
`--property-shape-document` | Mixin applied each property element | `{}`
3331
`--property-shape-document-array-color` | Property border color when type is an array | `#8BC34A`
3432
`--property-shape-document-object-color` | Property border color when type is an object | `#FF9800`
3533
`--property-shape-document-union-color` | Property border color when type is an union | `#FFEB3B`
@@ -41,17 +39,17 @@ Custom property | Description | Default
4139
`--api-type-document-type-color` | Color of the "type" trait | `white`
4240
`--api-type-document-type-background-color` | Background color of the "type" trait | `#2196F3`
4341
`--api-type-document-trait-background-color` | Background color to main range trait (type, required, enum) | `#EEEEEE`,
44-
`--api-type-document-trait-border-radius` | Border radious of a main property traits like type, required, enum | `3px`
42+
`--api-type-document-trait-border-radius` | Border radius of a main property traits like type, required, enum | `3px`
4543

4644
From `property-range-document`
4745

4846
Custom property | Description | Default
4947
----------------|-------------|----------
50-
`--property-range-document` | Mixin applied to this elment | `{}`
48+
`--property-range-document` | Mixin applied to this element | `{}`
5149
`--api-type-document-type-attribute-color` | Color of each attribute that describes a property | `#616161`
5250
`--api-type-document-examples-title-color` | Color of examples section title | ``
5351
`--api-type-document-examples-border-color` | Example section border color | `transparent`
54-
`--code-background-color` | Background color of the examples section | ``
52+
`--code-background-color` | Background color of the examples section |``
5553
`--arc-font-body1` | Mixin applied to an example name label | `{}`
5654
`--arc-font-body2` | Mixin applied to the examples section title | `{}`
5755

0 commit comments

Comments
 (0)