@italia/skiplinks 1.0.0-alpha.4

package/AUTHORS

@@ -0,0 +1,3 @@
+Copyright (c) 2025 Dipartimento per la trasformazione digitale - Presidenza del Consiglio dei Ministri
+
+The version control system provides attribution for specific lines of code.

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright (c) 2025, the respective contributors, as shown by the AUTHORS file.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,75 @@
+# \<it-skiplinks>
+
+This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
+
+## Installation
+
+```bash
+npm i @italia/skiplinks
+```
+
+## Usage
+
+```html
+<script type="module">
+  import '@italia/it-skiplinks';
+</script>
+
+<it-skiplinks></it-skiplinks>
+```
+
+## Linting and formatting
+
+To scan the project for linting and formatting errors, run
+
+```bash
+npm run lint
+```
+
+To automatically fix linting and formatting errors, run
+
+```bash
+npm run format
+```
+
+## Testing with Web Test Runner
+
+To execute a single test run:
+
+```bash
+npm run test
+```
+
+To run the tests in interactive watch mode run:
+
+```bash
+npm run test:watch
+```
+
+## Demoing with Storybook
+
+To run a local instance of Storybook for your component, run
+
+```bash
+npm run storybook
+```
+
+To build a production version of Storybook, run
+
+```bash
+npm run storybook:build
+```
+
+## Tooling configs
+
+For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
+
+If you customize the configuration a lot, you can consider moving them to individual files.
+
+## Local Demo with `web-dev-server`
+
+```bash
+npm start
+```
+
+To run a local development server that serves the basic demo located in `demo/index.html`

package/custom-elements.json

@@ -0,0 +1,133 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ItSkiplinks",
+          "declaration": {
+            "name": "ItSkiplinks",
+            "module": "./it-skiplinks.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/it-skiplinks.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "ItSkiplinks",
+          "members": [
+            {
+              "kind": "field",
+              "name": "links",
+              "type": {
+                "text": "array"
+              },
+              "privacy": "protected",
+              "default": "[]"
+            },
+            {
+              "kind": "method",
+              "name": "_onSlotChange",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "any"
+                  }
+                }
+              ]
+            }
+          ],
+          "superclass": {
+            "name": "BaseComponent",
+            "package": "@italia/globals"
+          },
+          "tagName": "it-skiplinks",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ItSkiplinks",
+          "declaration": {
+            "name": "ItSkiplinks",
+            "module": "src/it-skiplinks.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "it-skiplinks",
+          "declaration": {
+            "name": "ItSkiplinks",
+            "module": "src/it-skiplinks.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "stories/it-skiplinks.stories.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "meta",
+          "default": "{ title: 'Componenti/Skiplinks', tags: ['new', 'a11y-ok', 'web-component'], component: 'it-skiplinks', args: { 'it-aria-label': 'Aria label', }, argTypes: { 'it-aria-label': { control: 'text', description: 'Testo aria-label del wrapper degli skiplinks.', }, }, parameters: { docs: { description: { component: ` <Description>Gli skiplinks sono scorciatoie di navigazione che consentono agli utenti di andare direttamente ai contenuti principali della pagina, soprattutto se questa è particolarmente complessa da navigare.</Description> Questo componente permette a chi naviga sequenzialmente i contenuti di accedere a tutti i contenuti principali della pagina in modo più semplice. È particolarmente utile per chi usa la tastiera o tecnologie assistive come i lettori di schermo. Deve essere il primo contenuto della pagina. Se è presente l’elemento \\`<header>\\` è raccomandato integrarlo come primo suo elemento figlio, così da includerlo sempre in un landmark di pagina. Per navigare tra gli elementi puoi usare il tasto: **TAB** (tabulazione). <div class=\"callout callout-success\"><div class=\"callout-inner\"><div class=\"callout-title\"><span class=\"text\">Accessibilità</span></div> <p> Nel caso in cui il numero di link sia superiore a 2, è necessario passare al componente \\`it-skiplinks\\` l'attributo \\`it-aria-label\\` dedicato che ne spieghi l’uso. In questo caso infatti verrà generato un elemento \\`<nav>\\` a cui verrà applicato l'attributo \\`aria-label\\` per migliorarne l'accessibilità. </p></div></div> Nell’esempio che segue, implementato per il sito Designers Italia, sono inseriti due collegamenti che è utile approfondire: - un salto ad un *modulo per chiedere alle persone come stanno valutando l’esperienza d’uso* della pagina. Il testo dello skiplink anticipa già la domanda; - un *collegamento diretto alla Dichiarazione di accessibilità disponibile sul form AgID*, che accompagnerà il necessario link presente anche nel piede di pagina, per permettere a chi naviga con strumenti assistivi di trovarla facilmente senza dover scansionare tutti i contennuti. È raccomandato di limitare il numero di elementi scorciatoia per evitare che gli utenti debbano saltare le scorciatoie stesse. `, }, }, }, } satisfies Meta<SkiplinksProps>"
+        },
+        {
+          "kind": "variable",
+          "name": "EsempioInterattivo",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ ...meta, name: 'Esempio', args: { 'it-aria-label': 'Vai a:', }, parameters: { docs: { className: 'my-wide-story', canvas: { sourceState: 'shown', }, }, }, render: (params) => html` ${renderComponent({ ...params, slot: html`<a href=\"#menu\">Vai al menu</a> <a href=\"#main-content\">Vai al contenuto principale</a> <a href=\"#satisfaction\">Questa pagina ti è stata utile?</a> <a href=\"#footer\">Vai al piè di pagina</a> <a href=\"https://form.agid.gov.it/view/xyz\">Dichiarazione di accessibilità (link esterno su sito AgID</a> `, })}`, }"
+        },
+        {
+          "kind": "variable",
+          "name": "PochiLink",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ ...meta, name: 'Numero ridotto di link', args: {}, parameters: { docs: { description: { story: ` Quando sono presenti uno o due link, il componente evita di generare un elemento \\`<nav>\\` al fine di ridurre la complessità di lettura per gli screen reader. `, }, }, }, render: (params) => html` ${renderComponent({ ...params, // eslint-disable-next-line no-useless-computed-key ['it-aria-label']: undefined, slot: html`<a href=\"#menu\">Vai al menu</a> <a href=\"#main-content\">Vai al contenuto principale</a> `, })}`, }"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "meta",
+            "module": "stories/it-skiplinks.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EsempioInterattivo",
+          "declaration": {
+            "name": "EsempioInterattivo",
+            "module": "stories/it-skiplinks.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PochiLink",
+          "declaration": {
+            "name": "PochiLink",
+            "module": "stories/it-skiplinks.stories.ts"
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export { ItSkiplinks } from './it-skiplinks.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,5 @@
+export { ItSkiplinks } from './it-skiplinks.js';
+import 'lit';
+import 'lit/decorators.js';
+import 'lit/directive.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/src/it-skiplinks.d.ts

@@ -0,0 +1,13 @@
+import { BaseComponent } from '@italia/globals';
+export declare class ItSkiplinks extends BaseComponent {
+    static styles: import("lit").CSSResultGroup;
+    protected links: never[];
+    private _onSlotChange;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'it-skiplinks': ItSkiplinks;
+    }
+}
+//# sourceMappingURL=it-skiplinks.d.ts.map

package/dist/src/it-skiplinks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"it-skiplinks.d.ts","sourceRoot":"","sources":["../../src/it-skiplinks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAiB,MAAM,iBAAiB,CAAC;AAG/D,qBACa,WAAY,SAAQ,aAAa;IAC5C,MAAM,CAAC,MAAM,+BAAU;IAEvB,SAAS,CAAC,KAAK,UAAM;IAErB,OAAO,CAAC,aAAa;IAcrB,MAAM;CAwBP;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,cAAc,EAAE,WAAW,CAAC;KAC7B;CACF"}