@penn-libraries/web 0.3.0-dev.4 → 0.3.0

package/dist/docs.json

@@ -0,0 +1,311 @@
+{
+  "timestamp": "2025-06-16T16:44:35",
+  "compiler": {
+    "name": "@stencil/core",
+    "version": "4.29.3",
+    "typescriptVersion": "5.5.4"
+  },
+  "components": [
+    {
+      "filePath": "src/components/pennlibs-banner/pennlibs-banner.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-banner",
+      "readme": "# pennlibs-banner\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-chat/pennlibs-chat.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-chat",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-fallback-img/pennlibs-fallback-img.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-fallback-img",
+      "readme": "# pennlibs-fallback-img\n\nA placeholder component that displays a grayed-out Penn shield logo, typically used as a fallback when Fallback image is available.\n",
+      "docs": "A placeholder component that displays a grayed-out Penn shield logo, typically used as a fallback when Fallback image is available.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-feedback/pennlibs-feedback.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-feedback",
+      "readme": "# pennlibs-feedback\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [
+        {
+          "event": "pennlibs-feedback",
+          "detail": "{ question: string; answer: string; url: string; pageHeading?: string; pageTitle?: string; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{\n    question: string;\n    answer: string;\n    url: string;\n    pageHeading?: string;\n    pageTitle?: string;\n  }",
+            "resolved": "{ question: string; answer: string; url: string; pageHeading?: string; pageTitle?: string; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-footer/pennlibs-footer.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-footer",
+      "readme": "# pennlibs-footer\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-header/pennlibs-header.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-header",
+      "readme": "# pennlibs-header\n\n\n",
+      "docs": "A header component for Penn Libraries websites that displays the Penn Libraries logo,\nservice branding, and navigation. Supports both light and dark themes.",
+      "docsTags": [
+        {
+          "name": "component"
+        },
+        {
+          "name": "example",
+          "text": "<pennlibs-header \n  service-name=\"Find Books\" \n  service-lede=\"Search our catalog and collections\"\n  theme=\"light\">\n  <a href=\"/search\">Search</a>\n  <a href=\"/help\">Help</a>\n</pennlibs-header>"
+        },
+        {
+          "name": "slot",
+          "text": "end - Content to display at the end of the header (right side)"
+        },
+        {
+          "name": "slot",
+          "text": "name-end - Content to display at the end of the service name (right side)"
+        },
+        {
+          "name": "prop",
+          "text": "--max-width: The maximum width of the header."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "serviceHref",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "service-href",
+          "reflectToAttr": false,
+          "docs": "The URL where the service name links to, typically the service homepage or main landing page.",
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "\"/\""
+            }
+          ],
+          "default": "\"/\"",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "serviceLede",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "service-lede",
+          "reflectToAttr": false,
+          "docs": "A brief, compelling description that helps users understand what they can do here. Keep it short and focused on user benefits.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "serviceName",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "service-name",
+          "reflectToAttr": false,
+          "docs": "The service name should clearly describe what users want to accomplish. Avoid technical jargon, technology names, and acronyms.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
+        {
+          "name": "theme",
+          "type": "\"dark\" | \"light\"",
+          "complexType": {
+            "original": "'light' | 'dark'",
+            "resolved": "\"dark\" | \"light\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "theme",
+          "reflectToAttr": false,
+          "docs": "The visual theme of the header. Light theme uses blue logo, dark theme uses white logo.",
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "'light'"
+            }
+          ],
+          "default": "'light'",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false,
+          "getter": false,
+          "setter": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "end",
+          "docs": "Content to display at the end of the header (right side)"
+        },
+        {
+          "name": "name-end",
+          "docs": "Content to display at the end of the service name (right side)"
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/pennlibs-hero/pennlibs-hero.tsx",
+      "encapsulation": "shadow",
+      "tag": "pennlibs-hero",
+      "readme": "# pennlibs-hero\n\n\n",
+      "docs": "Place your most important content in a prominent space, often at the top of your website.",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "start - Content to display at the start (top) of the hero."
+        },
+        {
+          "name": "prop",
+          "text": "--max-width: The maximum width of the hero inner content."
+        }
+      ],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "start",
+          "docs": "Content to display at the start (top) of the hero."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    }
+  ],
+  "typeLibrary": {}
+}