@italia/section 0.1.0-alpha.2

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-section>
+
+This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
+
+## Installation
+
+```bash
+npm i it-section
+```
+
+## Usage
+
+```html
+<script type="module">
+  import '@italia/it-section';
+</script>
+
+<it-section></it-section>
+```
+
+## 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,260 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ItSection",
+          "declaration": {
+            "name": "ItSection",
+            "module": "./it-section.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/it-section.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "ItSection",
+          "members": [
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "'muted' | 'emphasis' | 'primary' | undefined"
+              },
+              "attribute": "variant"
+            },
+            {
+              "kind": "field",
+              "name": "image",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "attribute": "image"
+            },
+            {
+              "kind": "field",
+              "name": "inverse",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "attribute": "inverse"
+            },
+            {
+              "kind": "field",
+              "name": "sectionId",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "updateInverseClass",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "organizeContent",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "updateAriaLabelledBy",
+              "privacy": "private"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "variant",
+              "type": {
+                "text": "'muted' | 'emphasis' | 'primary' | undefined"
+              },
+              "fieldName": "variant"
+            },
+            {
+              "name": "image",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "image"
+            },
+            {
+              "name": "inverse",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "inverse"
+            }
+          ],
+          "superclass": {
+            "name": "BaseComponent",
+            "package": "@italia/globals"
+          },
+          "tagName": "it-section",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ItSection",
+          "declaration": {
+            "name": "ItSection",
+            "module": "src/it-section.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "it-section",
+          "declaration": {
+            "name": "ItSection",
+            "module": "src/it-section.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/types.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "SECTION_VARIANTS",
+          "type": {
+            "text": "['muted', 'emphasis', 'primary']"
+          },
+          "default": "['muted', 'emphasis', 'primary']"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SECTION_VARIANTS",
+          "declaration": {
+            "name": "SECTION_VARIANTS",
+            "module": "src/types.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "stories/it-section.stories.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "meta",
+          "type": {
+            "text": "object"
+          },
+          "default": "{ title: 'Componenti/Section', tags: ['autodocs'], component: 'it-section', parameters: { docs: { description: { component: `<Description>Per creare sezioni di layout orizzontale con differenti sfondi.</Description> Il componente \\`<it-section>\\` rappresenta un contenitore visivo per introdurre sezioni di contenuto con o senza immagine. Per indicazioni su \"Come e Quando usarlo\" si fa riferimento alla [guida del design-system](https://designers.italia.it/design-system/componenti/sections/) <div class=\"callout callout-success\"><div class=\"callout-inner\"><div class=\"callout-title\"><span class=\"text\">Accessibilità (Draft)</span></div><p> Il titolo h2 dello snippet è solo indicativo: assicurati che il contenuto contenga un'intestazione semantica per garantire la corretta navigazione assistiva. <br>Il tag it-section contraddistingue una sezione semanticamente riconoscibile, associata all’id del titolo dall’attributo aria-labelledby. <br>Gli autori dovrebbero dividere la pagina in sezioni semantiche reali e non per solo scopo decorativo. <br> Qualora si utilizzino sezioni al solo scopo decorativo sostituire it-section con div ed eliminare l’attributo aria-labelledby. <br><br> Le immagini fornite tramite l'attributo <code>image</code> sono considerate <strong>decorative</strong>: sono rese con un tag <code>&lt;img&gt;</code> e <code>aria-hidden=\"true\"</code>. In questo modo non vengono annunciate dagli screen reader.</p><p class=\"pt-2\"> </p></div></div> `, }, }, }, args: { variant: '', image: '', inverse: false, }, argTypes: { variant: { control: { type: 'select' }, options: SECTION_VARIANTS, description: 'Variante grafica del componente, corrisponde alle classi di Bootstrap Italia', table: { defaultValue: { summary: undefined } }, }, image: { control: { type: 'text' }, description: 'URL immagine di sfondo, ad esempio https://picsum.photos/1600/500', }, inverse: { control: { type: 'boolean' }, description: 'Quando attivo, l’attributo inverse applica il colore bianco ai testi. È utile quando la sezione ha uno sfondo scuro o un’immagine di sfondo, così da garantire il corretto contrasto e la leggibilità dei contenuti.', table: { defaultValue: { summary: false } }, }, }, }"
+        },
+        {
+          "kind": "variable",
+          "name": "EsempioInterattivo",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ name: 'Esempio interattivo', tags: ['!autodocs', '!dev'], parameters: { docs: { canvas: { sourceState: 'shown', }, }, }, render: (args) => html`${renderSection(args)}`, }"
+        },
+        {
+          "kind": "variable",
+          "name": "PersonalizzazioneDegliStili",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ name: 'Personalizzazione degli stili', tags: ['!dev'], parameters: { viewMode: 'docs', // assicura che si apra la tab Docs anziché Canvas docs: { canvas: { hidden: true, sourceState: 'none' }, // nasconde solo il canvas nella docs page description: { story: ` Per la personalizzazione degli stili si può usare il selettore \\`::part\\` passando il valore \\`section\\`. [Vedi qui la guida dettagliata](/docs/personalizzazione-degli-stili--documentazione#selettore-part). Quando si organizzano i contenuti usando le classi della griglia, non serve aggiungere spazio ai lati. Se proprio necessario, si può aggiungere spazio laterale usando la variabile \\`--bs-section-padding-x\\`. Si può usare la variabile \\`--bs-section-image-overlay\\` per regolare l'opacità dell'overlay applicato all'immagine. `, }, }, }, render: () => html`<div class=\"hide-preview\"></div>`, }"
+        },
+        {
+          "kind": "variable",
+          "name": "VariantiColore",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ name: 'Varianti di sfondo', render: () => html` <div class=\"d-flex flex-column gap-4\"> ${(['muted', 'emphasis', 'primary'] as const).map((variant) => renderSection({ variant, inverse: variant !== 'muted', content: html` <div class=\"container\"> <h3 id=\"section-heading-${variant}\">Sezione ${variant}</h3> <p> Questa sezione usa la variante <code>${variant}</code> ${variant !== 'muted' ? \"con testo bianco attraverso l'attributo inverse\" : ''} </p> </div> `, }), )} </div> `, parameters: { docs: { description: { story: ` Sono disponibili le varianti colore di sfondo per le sezioni, corrispondenti alle classi di Bootstrap italia: - \\`muted\\` - \\`emphasis\\` - \\`primary\\` Il componente Section ha, per default, uno sfondo trasparente. `, }, }, }, }"
+        },
+        {
+          "kind": "variable",
+          "name": "VarianteConImmagine",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ name: 'Sezione con immagine decorativa', args: { image: 'https://picsum.photos/1280/720?image=81', inverse: true, }, render: (params) => renderSection({ ...params, }), parameters: { docs: { description: { story: ` Valorizzando l'attributo \\`image\\` del componente con l’URL dell’immagine da utilizzare la Section utilizzerà l’immagine indicata come sfondo, adattandone automaticamente le dimensioni per coprire l’intera Section. A seconda della luminosità dell’immagine si consiglia di valorizzare o meno l'attributo \\`inverse\\` per garantire il corretto contrasto fra testi e sfondo. `, }, }, }, }"
+        },
+        {
+          "kind": "variable",
+          "name": "SectionConCard",
+          "type": {
+            "text": "Story"
+          },
+          "default": "{ name: 'Sezione con card', args: { variant: 'muted', }, render: (params) => renderSection({ ...params, content: html` <div class=\"container\"> <div class=\"row\"> <div class=\"col\"> <h2 id=\"section-heading-card\" class=\"mb-4\">Morbi fermentum amet</h2> </div> </div> <div class=\"row gy-3\"> <div class=\"col-12 col-md-6\"> <div class=\"card shadow\"> <div class=\"card-body\"> <p class=\"card-text font-serif\"> Platea dictumst vestibulum rhoncus est pellentesque elit ullamcorper dignissim cras. </p> </div> </div> </div> <div class=\"col-12 col-md-6\"> <div class=\"card shadow\"> <div class=\"card-body\"> <p class=\"card-text font-serif\"> Dictum sit amet justo donec enim diam vulputate ut. Eu nisl nunc mi ipsum faucibus. </p> </div> </div> </div> </div> </div> `, }), parameters: { docs: { description: { story: ` Per aggiungere una serie di card all’interno di una Section si consiglia di utilizzare le griglie per garantire un corretto margine fra gli elementi . `, }, }, }, }"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "meta",
+            "module": "stories/it-section.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EsempioInterattivo",
+          "declaration": {
+            "name": "EsempioInterattivo",
+            "module": "stories/it-section.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PersonalizzazioneDegliStili",
+          "declaration": {
+            "name": "PersonalizzazioneDegliStili",
+            "module": "stories/it-section.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "VariantiColore",
+          "declaration": {
+            "name": "VariantiColore",
+            "module": "stories/it-section.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "VarianteConImmagine",
+          "declaration": {
+            "name": "VarianteConImmagine",
+            "module": "stories/it-section.stories.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "SectionConCard",
+          "declaration": {
+            "name": "SectionConCard",
+            "module": "stories/it-section.stories.ts"
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export { ItSection } from './it-section.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,SAAS,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,6 @@
+export { ItSection } from './it-section.js';
+import 'lit';
+import 'lit/decorators.js';
+import 'lit/directives/class-map.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-section.d.ts

@@ -0,0 +1,20 @@
+import { BaseComponent } from '@italia/globals';
+export declare class ItSection extends BaseComponent {
+    variant?: 'muted' | 'emphasis' | 'primary';
+    image: string;
+    inverse: boolean;
+    private sectionId?;
+    createRenderRoot(): this;
+    connectedCallback(): void;
+    updated(): void;
+    private updateInverseClass;
+    private organizeContent;
+    private updateAriaLabelledBy;
+    render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'it-section': ItSection;
+    }
+}
+//# sourceMappingURL=it-section.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"it-section.d.ts","sourceRoot":"","sources":["../../src/it-section.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,qBACa,SAAU,SAAQ,aAAa;IACd,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC;IAE3C,KAAK,SAAM;IAEV,OAAO,UAAS;IAE7C,OAAO,CAAC,SAAS,CAAC,CAAS;IAI3B,gBAAgB;IAIhB,iBAAiB;IAKjB,OAAO;IAMP,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,eAAe;IA4BvB,OAAO,CAAC,oBAAoB;IAkC5B,MAAM;CAuBP;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,YAAY,EAAE,SAAS,CAAC;KACzB;CACF"}