@cordwainer/cw-elements 1.3.0-alpha.3 → 1.3.0-alpha.4

package/dist/custom-elements.json

@@ -9405,6 +9405,117 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/footer/footer.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "CwFooter",
+          "cssParts": [
+            {
+              "description": "The component's base wrapper, a `<footer>` landmark element.",
+              "name": "base"
+            },
+            {
+              "description": "The container that wraps the slotted logo.",
+              "name": "logo"
+            },
+            {
+              "description": "The container that wraps the slotted menu links.",
+              "name": "menu"
+            },
+            {
+              "description": "The container that wraps the slotted about content.",
+              "name": "about"
+            },
+            {
+              "description": "The bottom bar that wraps the copyright text and social links.",
+              "name": "bottom"
+            },
+            {
+              "description": "The copyright text.",
+              "name": "copyright"
+            },
+            {
+              "description": "The container that wraps the slotted social links.",
+              "name": "social"
+            }
+          ],
+          "slots": [
+            {
+              "description": "A `<cw-logo>`.",
+              "name": "logo"
+            },
+            {
+              "description": "Plain `<a>` links. Not a repeating item component — a flat list that reflows into columns (3 wide, 1 narrow) via CSS, no grouping or headings.",
+              "name": "menu"
+            },
+            {
+              "description": "Arbitrary content, rendered full width.",
+              "name": "about"
+            },
+            {
+              "description": "Any number of `<cw-social-link>` elements.",
+              "name": "social"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "hasSlotController",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new HasSlotController(this, 'logo', 'menu', 'about', 'social')"
+            },
+            {
+              "kind": "field",
+              "name": "owner",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The copyright owner's name. When set, the footer renders `© {currentYear} {owner}`. Renders nothing if unset.",
+              "attribute": "owner"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "owner",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The copyright owner's name. When set, the footer renders `© {currentYear} {owner}`. Renders nothing if unset.",
+              "fieldName": "owner"
+            }
+          ],
+          "superclass": {
+            "name": "CwElement",
+            "module": "/src/internal/cw-element.js"
+          },
+          "summary": "Site footer region composing branding, a flat link list, arbitrary \"about\" content, and a bottom bar\nwith copyright and social links.",
+          "tagNameWithoutPrefix": "footer",
+          "tagName": "cw-footer",
+          "customElement": true,
+          "jsDoc": "/**\n * @summary Site footer region composing branding, a flat link list, arbitrary \"about\" content, and a bottom bar\n * with copyright and social links.\n * @documentation https://cordwainer.dev/components/footer\n * @status experimental\n * @since 1.3\n *\n * @slot logo - A `<cw-logo>`.\n * @slot menu - Plain `<a>` links. Not a repeating item component — a flat list that reflows into columns (3 wide,\n * 1 narrow) via CSS, no grouping or headings.\n * @slot about - Arbitrary content, rendered full width.\n * @slot social - Any number of `<cw-social-link>` elements.\n *\n * @csspart base - The component's base wrapper, a `<footer>` landmark element.\n * @csspart logo - The container that wraps the slotted logo.\n * @csspart menu - The container that wraps the slotted menu links.\n * @csspart about - The container that wraps the slotted about content.\n * @csspart bottom - The bottom bar that wraps the copyright text and social links.\n * @csspart copyright - The copyright text.\n * @csspart social - The container that wraps the slotted social links.\n */",
+          "documentation": "https://cordwainer.dev/components/footer",
+          "status": "experimental",
+          "since": "1.3"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "CwFooter",
+            "module": "components/footer/footer.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/format-bytes/format-bytes.js",
@@ -10677,6 +10788,15 @@
               "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
               "attribute": "download"
             },
+            {
+              "kind": "field",
+              "name": "rel",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The `rel` attribute for the link. Only used when `href` is set. Defaults to `noreferrer noopener` when `target`\nis set and this is left unset — pass an explicit value (e.g. `me noreferrer noopener`) to override it.",
+              "attribute": "rel"
+            },
             {
               "kind": "field",
               "name": "label",
@@ -10809,6 +10929,14 @@
               "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
               "fieldName": "download"
             },
+            {
+              "name": "rel",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The `rel` attribute for the link. Only used when `href` is set. Defaults to `noreferrer noopener` when `target`\nis set and this is left unset — pass an explicit value (e.g. `me noreferrer noopener`) to override it.",
+              "fieldName": "rel"
+            },
             {
               "name": "label",
               "type": {
@@ -18639,6 +18767,190 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/social-link/social-link.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "CwSocialLink",
+          "cssParts": [
+            {
+              "description": "The internal `<cw-icon-button>`'s exported `base` part.",
+              "name": "base"
+            },
+            {
+              "description": "An alias of `base`, kept for consistency with other components that forward an icon-button's exported `base` part.",
+              "name": "base__icon-button"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "dependencies",
+              "type": {
+                "text": "object"
+              },
+              "static": true,
+              "default": "{ 'cw-icon-button': CwIconButton }"
+            },
+            {
+              "kind": "field",
+              "name": "href",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The URL of the profile to link to.",
+              "attribute": "href"
+            },
+            {
+              "kind": "field",
+              "name": "target",
+              "type": {
+                "text": "'_blank' | '_parent' | '_self' | '_top'"
+              },
+              "default": "'_blank'",
+              "description": "Tells the browser where to open the link. Defaults to a new tab, since a social link always points off-site.",
+              "attribute": "target"
+            },
+            {
+              "kind": "field",
+              "name": "rel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'noreferrer noopener'",
+              "description": "The `rel` attribute for the link. Defaults to `noreferrer noopener`. To mark this link as a verified profile\nreference — the IndieWeb `rel=\"me\"` convention Mastodon and the wider fediverse use for identity verification —\ninclude `me` yourself, e.g. `rel=\"me noreferrer noopener\"`.",
+              "attribute": "rel"
+            },
+            {
+              "kind": "field",
+              "name": "platform",
+              "type": {
+                "text": "Platform | undefined"
+              },
+              "description": "One of the common social/fediverse platforms. When set, both the icon and the accessible `label` default to\nthat platform's — set `name`/`library` and/or `label` explicitly to override either, or to support a platform\nnot in this list.",
+              "attribute": "platform"
+            },
+            {
+              "kind": "field",
+              "name": "name",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The name of the icon to draw. Defaults to `platform`'s icon when set.",
+              "attribute": "name"
+            },
+            {
+              "kind": "field",
+              "name": "library",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The name of a registered custom icon library. Defaults to `system` when `platform` is set.",
+              "attribute": "library"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "A description that gets read by assistive devices. Defaults to `platform`'s name when set.",
+              "attribute": "label"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "href",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "The URL of the profile to link to.",
+              "fieldName": "href"
+            },
+            {
+              "name": "target",
+              "type": {
+                "text": "'_blank' | '_parent' | '_self' | '_top'"
+              },
+              "default": "'_blank'",
+              "description": "Tells the browser where to open the link. Defaults to a new tab, since a social link always points off-site.",
+              "fieldName": "target"
+            },
+            {
+              "name": "rel",
+              "type": {
+                "text": "string"
+              },
+              "default": "'noreferrer noopener'",
+              "description": "The `rel` attribute for the link. Defaults to `noreferrer noopener`. To mark this link as a verified profile\nreference — the IndieWeb `rel=\"me\"` convention Mastodon and the wider fediverse use for identity verification —\ninclude `me` yourself, e.g. `rel=\"me noreferrer noopener\"`.",
+              "fieldName": "rel"
+            },
+            {
+              "name": "platform",
+              "type": {
+                "text": "Platform | undefined"
+              },
+              "description": "One of the common social/fediverse platforms. When set, both the icon and the accessible `label` default to\nthat platform's — set `name`/`library` and/or `label` explicitly to override either, or to support a platform\nnot in this list.",
+              "fieldName": "platform"
+            },
+            {
+              "name": "name",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The name of the icon to draw. Defaults to `platform`'s icon when set.",
+              "fieldName": "name"
+            },
+            {
+              "name": "library",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The name of a registered custom icon library. Defaults to `system` when `platform` is set.",
+              "fieldName": "library"
+            },
+            {
+              "name": "label",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "A description that gets read by assistive devices. Defaults to `platform`'s name when set.",
+              "fieldName": "label"
+            }
+          ],
+          "superclass": {
+            "name": "CwElement",
+            "module": "/src/internal/cw-element.js"
+          },
+          "summary": "A link to a social or fediverse profile, rendered as a single icon. Purpose-built for this domain rather\nthan a generic icon-link: set `platform` for one of the common networks and both the icon and accessible label\nare filled in for you.",
+          "tagNameWithoutPrefix": "social-link",
+          "tagName": "cw-social-link",
+          "customElement": true,
+          "jsDoc": "/**\n * @summary A link to a social or fediverse profile, rendered as a single icon. Purpose-built for this domain rather\n * than a generic icon-link: set `platform` for one of the common networks and both the icon and accessible label\n * are filled in for you.\n * @documentation https://cordwainer.dev/components/social-link\n * @status experimental\n * @since 1.3\n *\n * @dependency cw-icon-button\n *\n * @csspart base - The internal `<cw-icon-button>`'s exported `base` part.\n * @csspart base__icon-button - An alias of `base`, kept for consistency with other components that forward an\n * icon-button's exported `base` part.\n */",
+          "documentation": "https://cordwainer.dev/components/social-link",
+          "status": "experimental",
+          "since": "1.3",
+          "dependencies": [
+            "cw-icon-button"
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "CwSocialLink",
+            "module": "components/social-link/social-link.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/spinner/spinner.js",
@@ -23496,7 +23808,7 @@
   "package": {
     "name": "@cordwainer/cw-elements",
     "description": "Cordwainer Elements — Web Component Library, a hard fork of Shoelace (@shoelace-style/shoelace).",
-    "version": "1.3.0-alpha.3",
+    "version": "1.3.0-alpha.4",
     "author": "Matt Hand",
     "homepage": "https://cordwainer.dev",
     "license": "MIT"

package/dist/cw-elements.d.ts

@@ -69,6 +69,8 @@ export { default as CwPrimaryNavigationMenu } from './components/primary-navigat
 export { default as CwSecondaryNavigation } from './components/secondary-navigation/secondary-navigation.js';
 export { default as CwSecondaryNavigationItem } from './components/secondary-navigation-item/secondary-navigation-item.js';
 export { default as CwHeader } from './components/header/header.js';
+export { default as CwSocialLink } from './components/social-link/social-link.js';
+export { default as CwFooter } from './components/footer/footer.js';
 export * from './utilities/animation.js';
 export * from './utilities/base-path.js';
 export * from './utilities/icon-library.js';