@skdx/web-components-blocks 0.1.0

package/custom-elements.json

@@ -0,0 +1,695 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SkdxDashboardLayout",
+          "declaration": {
+            "name": "SkdxDashboardLayout",
+            "module": "./dashboard-layout"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxDashboardNavigationItem",
+          "declaration": {
+            "name": "SkdxDashboardNavigationItem",
+            "module": "./dashboard-layout"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxPageContainer",
+          "declaration": {
+            "name": "SkdxPageContainer",
+            "module": "./page-container"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxPageContainerBreadcrumb",
+          "declaration": {
+            "name": "SkdxPageContainerBreadcrumb",
+            "module": "./page-container"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defaultProviderLabel",
+          "declaration": {
+            "name": "defaultProviderLabel",
+            "module": "./sign-in-page"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInPage",
+          "declaration": {
+            "name": "SkdxSignInPage",
+            "module": "./sign-in-page"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInDetail",
+          "declaration": {
+            "name": "SkdxSignInDetail",
+            "module": "./sign-in-page"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInProvider",
+          "declaration": {
+            "name": "SkdxSignInProvider",
+            "module": "./sign-in-page"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/dashboard-layout/DashboardLayout.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Application shell block: an app bar, a collapsible side navigation and the content region.\n\nRenders light DOM, so its parts are classes rather than shadow `::part()`\ntargets: `.skdx-dashboard-layout` on the host, then `__app-bar`,\n`__nav-toggle`, `__branding`, `__title`, `__actions`, `__body`, `__nav`,\n`__nav-list`, `__nav-item`, `__nav-header`, `__nav-divider` and `__content`.\n`data-nav-open` sits on the host while the navigation is shown.",
+          "name": "SkdxDashboardLayout",
+          "slots": [
+            {
+              "description": "The page content rendered inside the `<main>` region.",
+              "name": ""
+            },
+            {
+              "description": "Logo or product mark at the start of the app bar.",
+              "name": "branding"
+            },
+            {
+              "description": "Controls at the end of the app bar.",
+              "name": "actions"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "Application title shown in the app bar after the branding, shadowing the native tooltip attribute.",
+              "attribute": "title"
+            },
+            {
+              "kind": "field",
+              "name": "navigation",
+              "type": {
+                "text": "readonly SkdxDashboardNavigationItem[]"
+              },
+              "description": "The side navigation, one entry per row, nested through each entry's `children`.",
+              "required": true
+            },
+            {
+              "kind": "field",
+              "name": "navOpen",
+              "type": {
+                "text": "boolean | undefined"
+              },
+              "description": "Whether the side navigation is shown, for controlled usage.",
+              "default": "undefined",
+              "attribute": "nav-open"
+            },
+            {
+              "kind": "field",
+              "name": "defaultNavOpen",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "true",
+              "description": "Whether the side navigation starts shown, for uncontrolled usage.",
+              "attribute": "default-nav-open"
+            },
+            {
+              "kind": "field",
+              "name": "navLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Main navigation'",
+              "description": "Accessible name of the side navigation landmark.",
+              "attribute": "nav-label"
+            },
+            {
+              "kind": "field",
+              "name": "navToggleLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Toggle navigation'",
+              "description": "Accessible name of the icon-only button that shows and hides the navigation.",
+              "attribute": "nav-toggle-label"
+            }
+          ],
+          "events": [
+            {
+              "description": "Fires with the new open state whenever the navigation toggle is activated.",
+              "name": "nav-open-change"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "Application title shown in the app bar after the branding, shadowing the native tooltip attribute.",
+              "fieldName": "title"
+            },
+            {
+              "name": "nav-open",
+              "type": {
+                "text": "boolean | undefined"
+              },
+              "description": "Whether the side navigation is shown, for controlled usage.",
+              "default": "undefined",
+              "fieldName": "navOpen"
+            },
+            {
+              "name": "default-nav-open",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "true",
+              "description": "Whether the side navigation starts shown, for uncontrolled usage.",
+              "fieldName": "defaultNavOpen"
+            },
+            {
+              "name": "nav-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Main navigation'",
+              "description": "Accessible name of the side navigation landmark.",
+              "fieldName": "navLabel"
+            },
+            {
+              "name": "nav-toggle-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Toggle navigation'",
+              "description": "Accessible name of the icon-only button that shows and hides the navigation.",
+              "fieldName": "navToggleLabel"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "skdx-dashboard-layout",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SkdxDashboardLayout",
+          "declaration": {
+            "name": "SkdxDashboardLayout",
+            "module": "src/dashboard-layout/DashboardLayout.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "skdx-dashboard-layout",
+          "declaration": {
+            "name": "SkdxDashboardLayout",
+            "module": "src/dashboard-layout/DashboardLayout.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/dashboard-layout/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SkdxDashboardLayout",
+          "declaration": {
+            "name": "SkdxDashboardLayout",
+            "module": "./DashboardLayout"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxDashboardNavigationItem",
+          "declaration": {
+            "name": "SkdxDashboardNavigationItem",
+            "module": "./DashboardLayout"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/internal/define.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "tagName",
+          "declaration": {
+            "name": "anonymous_0",
+            "module": "src/internal/define.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/internal/events.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/internal/part.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/internal/slots.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/page-container/PageContainer.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Page header block: a breadcrumb trail, a heading and page-level actions above the page content.\n\nRenders light DOM, so its parts are classes rather than shadow `::part()`\ntargets: `.skdx-page-container` on the host, then `__header`,\n`__breadcrumbs`, `__heading-row`, `__title`, `__actions` and `__content`.",
+          "name": "SkdxPageContainer",
+          "slots": [
+            {
+              "description": "The page content below the header.",
+              "name": ""
+            },
+            {
+              "description": "Controls placed in the toolbar beside the heading.",
+              "name": "actions"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "description": "The page heading text, rendered into a derived Heading that also names the section.",
+              "attribute": "title",
+              "required": true
+            },
+            {
+              "kind": "field",
+              "name": "headingLevel",
+              "type": {
+                "text": "1 | 2 | 3 | 4 | 5 | 6"
+              },
+              "default": "1",
+              "description": "Heading level of the derived title. A page container normally holds the page's only `<h1>`; lower it when the block sits inside a larger outline.",
+              "attribute": "heading-level"
+            },
+            {
+              "kind": "field",
+              "name": "breadcrumbs",
+              "type": {
+                "text": "readonly SkdxPageContainerBreadcrumb[] | undefined"
+              },
+              "description": "Trail rendered into a derived Breadcrumb above the heading.",
+              "default": "undefined"
+            },
+            {
+              "kind": "field",
+              "name": "breadcrumbLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Breadcrumb'",
+              "description": "Accessible name of the derived breadcrumb `<nav>` landmark.",
+              "attribute": "breadcrumb-label"
+            },
+            {
+              "kind": "field",
+              "name": "actionsLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Page actions'",
+              "description": "Accessible name of the derived actions Toolbar beside the heading.",
+              "attribute": "actions-label"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "description": "The page heading text, rendered into a derived Heading that also names the section.",
+              "fieldName": "title",
+              "required": true
+            },
+            {
+              "name": "heading-level",
+              "type": {
+                "text": "1 | 2 | 3 | 4 | 5 | 6"
+              },
+              "default": "1",
+              "description": "Heading level of the derived title. A page container normally holds the page's only `<h1>`; lower it when the block sits inside a larger outline.",
+              "fieldName": "headingLevel"
+            },
+            {
+              "name": "breadcrumb-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Breadcrumb'",
+              "description": "Accessible name of the derived breadcrumb `<nav>` landmark.",
+              "fieldName": "breadcrumbLabel"
+            },
+            {
+              "name": "actions-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Page actions'",
+              "description": "Accessible name of the derived actions Toolbar beside the heading.",
+              "fieldName": "actionsLabel"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "skdx-page-container",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SkdxPageContainer",
+          "declaration": {
+            "name": "SkdxPageContainer",
+            "module": "src/page-container/PageContainer.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "skdx-page-container",
+          "declaration": {
+            "name": "SkdxPageContainer",
+            "module": "src/page-container/PageContainer.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/page-container/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SkdxPageContainer",
+          "declaration": {
+            "name": "SkdxPageContainer",
+            "module": "./PageContainer"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxPageContainerBreadcrumb",
+          "declaration": {
+            "name": "SkdxPageContainerBreadcrumb",
+            "module": "./PageContainer"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/sign-in-page/SignInPage.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "defaultProviderLabel",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "provider",
+              "type": {
+                "text": "SkdxSignInProvider"
+              }
+            }
+          ],
+          "description": "Default provider button text, reading \"Sign in with Google\" for a provider named Google."
+        },
+        {
+          "kind": "class",
+          "description": "Sign-in block: provider buttons, an email and password form, and a magic-link form.\n\nRenders light DOM, so its parts are classes rather than shadow `::part()`\ntargets: `.skdx-sign-in-page` on the host, then `__panel`, `__title`,\n`__error`, `__providers`, `__provider`, `__divider`, `__form`, `__field`\nand `__submit`.",
+          "name": "SkdxSignInPage",
+          "members": [
+            {
+              "kind": "field",
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Sign in'",
+              "description": "Heading text, rendered into a derived `<h1>` that names the section.",
+              "attribute": "title"
+            },
+            {
+              "kind": "field",
+              "name": "providers",
+              "type": {
+                "text": "readonly SkdxSignInProvider[]"
+              },
+              "description": "The ways to sign in, in render order; `'credentials'` and `'magic-link'` render their forms.",
+              "required": true
+            },
+            {
+              "kind": "field",
+              "name": "error",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Message rendered into a derived error Alert above the providers. The block never clears it.",
+              "default": "undefined",
+              "attribute": "error"
+            },
+            {
+              "kind": "field",
+              "name": "emailLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Email'",
+              "description": "Label of the email field in both forms.",
+              "attribute": "email-label"
+            },
+            {
+              "kind": "field",
+              "name": "passwordLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Password'",
+              "description": "Label of the password field in the credentials form.",
+              "attribute": "password-label"
+            },
+            {
+              "kind": "field",
+              "name": "submitLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Sign in'",
+              "description": "Text of the credentials form submit button.",
+              "attribute": "submit-label"
+            },
+            {
+              "kind": "field",
+              "name": "magicLinkLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Send magic link'",
+              "description": "Text of the magic-link form submit button.",
+              "attribute": "magic-link-label"
+            },
+            {
+              "kind": "field",
+              "name": "getProviderLabel",
+              "type": {
+                "text": "(provider: SkdxSignInProvider) => string | undefined"
+              },
+              "description": "Formats a provider button's text from its entry.",
+              "default": "defaultProviderLabel"
+            }
+          ],
+          "events": [
+            {
+              "description": "Fires with `{ providerId, email?, password? }` when a provider button is activated or a form submits with valid fields.",
+              "name": "sign-in"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Sign in'",
+              "description": "Heading text, rendered into a derived `<h1>` that names the section.",
+              "fieldName": "title"
+            },
+            {
+              "name": "error",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Message rendered into a derived error Alert above the providers. The block never clears it.",
+              "default": "undefined",
+              "fieldName": "error"
+            },
+            {
+              "name": "email-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Email'",
+              "description": "Label of the email field in both forms.",
+              "fieldName": "emailLabel"
+            },
+            {
+              "name": "password-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Password'",
+              "description": "Label of the password field in the credentials form.",
+              "fieldName": "passwordLabel"
+            },
+            {
+              "name": "submit-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Sign in'",
+              "description": "Text of the credentials form submit button.",
+              "fieldName": "submitLabel"
+            },
+            {
+              "name": "magic-link-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Send magic link'",
+              "description": "Text of the magic-link form submit button.",
+              "fieldName": "magicLinkLabel"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "skdx-sign-in-page",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "defaultProviderLabel",
+          "declaration": {
+            "name": "defaultProviderLabel",
+            "module": "src/sign-in-page/SignInPage.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInPage",
+          "declaration": {
+            "name": "SkdxSignInPage",
+            "module": "src/sign-in-page/SignInPage.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "skdx-sign-in-page",
+          "declaration": {
+            "name": "SkdxSignInPage",
+            "module": "src/sign-in-page/SignInPage.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/sign-in-page/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "defaultProviderLabel",
+          "declaration": {
+            "name": "defaultProviderLabel",
+            "module": "./SignInPage"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInPage",
+          "declaration": {
+            "name": "SkdxSignInPage",
+            "module": "./SignInPage"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInDetail",
+          "declaration": {
+            "name": "SkdxSignInDetail",
+            "module": "./SignInPage"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SkdxSignInProvider",
+          "declaration": {
+            "name": "SkdxSignInProvider",
+            "module": "./SignInPage"
+          }
+        }
+      ]
+    }
+  ]
+}