@api-viewer/docs - npm Package Compare versions

Comparing version 1.0.0-pre.8 to 1.0.0-pre.9

lib/layout.js

@@ -7,4 +7,10 @@ import { __decorate } from "tslib";
 import { parse } from './utils/markdown.js';
-const renderItem = (prefix, name, description, valueType, value, attribute) => html `
+const renderItem = (prefix, name, description, valueType, value, attribute, isStatic, reflects) => html `
   <div part="docs-item">
+    ${isStatic || reflects
+    ? html `<div part="docs-row">
+          ${isStatic ? html `<div part="docs-tag">static</div>` : nothing}
+          ${reflects ? html `<div part="docs-tag">reflected</div>` : nothing}
+        </div>`
+    : nothing}
     <div part="docs-row">
@@ -96,2 +102,3 @@ <div part="docs-column" class="column-name-${prefix}">
         ].every((arr) => arr.length === 0);
+        props.sort((p) => (p.static ? -1 : 1));
         const attributes = attrs.filter((x) => !props.some((y) => y.name === x.fieldName));
@@ -109,5 +116,5 @@ return emptyDocs
                 ${props.map((prop) => {
-                const { name, description, type } = prop;
+                const { name, description, type, static: isStatic, reflects } = prop;
                 const attribute = attrs.find((x) => x.fieldName === name);
-                return renderItem('prop', name, description, type?.text, prop.default, attribute?.name);
+                return renderItem('prop', name, description, type?.text, prop.default, attribute?.name, isStatic, reflects);
             })}
@@ -114,0 +121,0 @@ `)}

lib/styles.js

@@ -42,2 +42,12 @@ import { css } from 'lit';
 
+  [part='docs-tag'] {
+    background-color: var(--ave-tag-background-color);
+    border: 1px solid var(--ave-tag-border-color);
+    border-radius: 3px;
+    color: var(--ave-tag-color);
+    display: inline-block;
+    font-size: 0.75rem;
+    padding: 1px 5px;
+  }
+
   [part='docs-description'] {
@@ -44,0 +54,0 @@ display: block;

lib/utils/markdown.js

@@ -7,6 +7,6 @@ import { html, nothing } from 'lit';
 export const parse = (markdown) => html `
-    ${!markdown
+  ${!markdown
     ? nothing
     : unsafeHTML(DOMPurify.sanitize(marked(markdown)).replace(/<(h[1-6]|a|p|ul|ol|li|pre|code|strong|em|blockquote|del)(\s+href="[^"]+")*>/g, '<$1 part="md-$1"$2>'))}
-  `;
+`;
 //# sourceMappingURL=markdown.js.map

package.json

 {
   "name": "@api-viewer/docs",
-  "version": "1.0.0-pre.8",
+  "version": "1.0.0-pre.9",
   "publishConfig": {
@@ -35,4 +35,4 @@ "access": "public"
   "dependencies": {
-    "@api-viewer/common": "^1.0.0-pre.8",
-    "@api-viewer/tabs": "^1.0.0-pre.8",
+    "@api-viewer/common": "^1.0.0-pre.9",
+    "@api-viewer/tabs": "^1.0.0-pre.9",
     "@types/dompurify": "^2.3.1",
@@ -39,0 +39,0 @@ "@types/marked": "^4.0.0",

No alert changes

Improved metrics

Total package byte prevSize

45123

increased by4.27%

Lines of code

641

increased by2.56%

Dependency changes

• Updated@api-viewer/common@^1.0.0-pre.9

• Updated@api-viewer/tabs@^1.0.0-pre.9