@swisspost/design-system-components 1.0.0-alpha.0

package/dist/docs.d.ts

@@ -0,0 +1,124 @@
+
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * DO NOT MODIFY IT MANUALLY
+ */
+export interface JsonDocs {
+    components: JsonDocsComponent[];
+    timestamp: string;
+    compiler: {
+        name: string;
+        version: string;
+        typescriptVersion: string;
+    };
+}
+export interface JsonDocsComponent {
+    dirPath?: string;
+    fileName?: string;
+    filePath?: string;
+    readmePath?: string;
+    usagesDir?: string;
+    encapsulation: 'shadow' | 'scoped' | 'none';
+    tag: string;
+    readme: string;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    usage: JsonDocsUsage;
+    props: JsonDocsProp[];
+    methods: JsonDocsMethod[];
+    events: JsonDocsEvent[];
+    listeners: JsonDocsListener[];
+    styles: JsonDocsStyle[];
+    slots: JsonDocsSlot[];
+    parts: JsonDocsPart[];
+    dependents: string[];
+    dependencies: string[];
+    dependencyGraph: JsonDocsDependencyGraph;
+    deprecation?: string;
+}
+export interface JsonDocsDependencyGraph {
+    [tagName: string]: string[];
+}
+export interface JsonDocsTag {
+    name: string;
+    text?: string;
+}
+export interface JsonDocsValue {
+    value?: string;
+    type: string;
+}
+export interface JsonDocsUsage {
+    [key: string]: string;
+}
+export interface JsonDocsProp {
+    name: string;
+    type: string;
+    mutable: boolean;
+    /**
+     * The name of the attribute that is exposed to configure a compiled web component
+     */
+    attr?: string;
+    reflectToAttr: boolean;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    default: string;
+    deprecation?: string;
+    values: JsonDocsValue[];
+    optional: boolean;
+    required: boolean;
+}
+export interface JsonDocsMethod {
+    name: string;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    deprecation?: string;
+    signature: string;
+    returns: JsonDocsMethodReturn;
+    parameters: JsonDocMethodParameter[];
+}
+export interface JsonDocsMethodReturn {
+    type: string;
+    docs: string;
+}
+export interface JsonDocMethodParameter {
+    name: string;
+    type: string;
+    docs: string;
+}
+export interface JsonDocsEvent {
+    event: string;
+    bubbles: boolean;
+    cancelable: boolean;
+    composed: boolean;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    deprecation?: string;
+    detail: string;
+}
+export interface JsonDocsStyle {
+    name: string;
+    docs: string;
+    annotation: string;
+}
+export interface JsonDocsListener {
+    event: string;
+    target?: string;
+    capture: boolean;
+    passive: boolean;
+}
+export interface JsonDocsSlot {
+    name: string;
+    docs: string;
+}
+export interface JsonDocsPart {
+    name: string;
+    docs: string;
+}
+export interface StyleDoc {
+    name: string;
+    docs: string;
+    annotation: 'prop';
+}
+
+declare const _default: JsonDocs;
+export default _default;

package/dist/docs.json

@@ -0,0 +1,101 @@
+{
+  "timestamp": "2022-10-03T15:44:17",
+  "compiler": {
+    "name": "@stencil/core",
+    "version": "2.18.0",
+    "typescriptVersion": "4.7.4"
+  },
+  "components": [
+    {
+      "filePath": "./src/components/my-component/my-component.tsx",
+      "encapsulation": "shadow",
+      "tag": "my-component",
+      "readme": "# my-component\nBla\n\n",
+      "docs": "Bla",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "first",
+          "type": "string",
+          "mutable": false,
+          "attr": "first",
+          "reflectToAttr": false,
+          "docs": "The first name",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "last",
+          "type": "string",
+          "mutable": false,
+          "attr": "last",
+          "reflectToAttr": false,
+          "docs": "The last name",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "middle",
+          "type": "string",
+          "mutable": false,
+          "attr": "middle",
+          "reflectToAttr": false,
+          "docs": "The middle name",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "write",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "write(text: string) => Promise<void>",
+          "parameters": [],
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "someevent",
+          "detail": "string",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "This event is fired randomly",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    }
+  ]
+}