Skip to content

Latest commit

 

History

History
461 lines (329 loc) · 18.2 KB

README.md

File metadata and controls

461 lines (329 loc) · 18.2 KB
Raw

Design Angular Kit

angular-logo
Design Angular Kit è un toolkit basato su Bootstrap Italia
per la creazione di applicazioni web sviluppate con Angular.

italia.github.io/design-angular-kit

NPM

Build codecov License GitHub issues

semantic-release: angular code style: prettier formatter: angular-eslint

Join the #design-dev-angular channel Get invited

Read this in other languages: English 🇬🇧.

⚠️ Se si necessita della vecchia versione il codice e la sua documentazione possono essere reperiti qua.

Commenti e contributi di tutta la community sono più che benvenuti! 🎉

Intro

Design Angular kit è un set di componenti Angular che implementa Bootstrap Italia e gli stili presenti su Design UI Kit. La versione pubblica della documentazione della libreria è disponibile qui per l'ultima release stabile pubblicata, mentre qui per la versione di sviluppo relativa al branch main. Per giocare con la libreria è disponibile il Playground Angular Kit.

Indice

Come usare il kit

Design Angular Kit è disponibile su NPM, per installarlo su una applicazione esistente sulla quale provare la libreria esegui il comando

npm install design-angular-kit --save

Scegli la versione corrispondente alla tua versione Angular:

Angular design-angular-kit
18+ v1.1.0 +
17+ v1.0.0 +

In alternativa, puoi lanciar il comando

ng add design-angular-kit --project <projectName>

Eseguirà in serie:

  • scelta della corretta versione da installare
  • installazione della dipendenza
  • aggiunta della dipendenza al package.json
  • configurazione dell'applicazione

Le istruzioni del paragrafo successivo, Configurazione, verranno eseguite automaticamente, eccetto per la personalizzazione della configurazione di i18n.

Configurazione

Configurazione app

La libreria design-angular-kit può essere utilizzata con i componenti standalone o con l'applicazione che utilizza i moduli. Segui la sezione di configurazione che corrisponde alla tua applicazione.

Applicazione standalone

Utilizza la funzione provideDesignAngularKit nella configurazione dell'applicazione ApplicationConfig per poter inizializzare le funzionalità della libreria.

import { provideDesignAngularKit } from 'design-angular-kit';

export const appConfig: ApplicationConfig = {
  providers: [...provideDesignAngularKit()],
};

Applicazione modulare

È necessario importare DesignAngularKitModule all'interno del modulo principale dell'applicazione (solitamente denominato AppModule) utilizzando il metodo forRoot per poter inizializzare le funzionalità della libreria e importare tutti i componenti.

import { DesignAngularKitModule } from 'design-angular-kit';

@NgModule({
  imports: [...DesignAngularKitModule.forRoot()],
})
export class AppModule {}

Utilizza il metodo forChild durante l'importazione del modulo DesignAngularKitModule in altri moduli dell'applicazione per importare tutti i componenti della libreria.

import { DesignAngularKitModule } from 'design-angular-kit';

@NgModule({
  imports: [...DesignAngularKitModule.forChild()],
  exports: [DesignAngularKitModule],
})
export class SharedModule {}

Applicazione ibrida

Se nella tua applicazione è presente il modulo AppModule ma vuoi utilizzare i nostri componenti con la configurazione standalone, utilizza la funzione provideDesignAngularKit all'interno del modulo principale dell'applicazione per poter inizializzare le funzionalità della libreria.

import { provideDesignAngularKit } from 'design-angular-kit';

@NgModule({
  imports: [],
  providers: [provideDesignAngularKit()],
})
export class AppModule {}

Parametri di configurazione

Sia per la funzione provideDesignAngularKit che per il modulo DesignAngularKitModule.forRoot() è possibile utilizzare una configurazione iniziale DesignAngularKitConfig.

import { provideDesignAngularKit, DesignAngularKitModule, DesignAngularKitConfig } from 'design-angular-kit';

// Puoi aggiungere alla libreria una configurazione iniziale
const initConfig: DesignAngularKitConfig | undefined = {
  /**
   * The bootstrap-italia asset folder path
   * @default ./bootstrap-italia
   */
  assetBasePath: string | undefined,

  /**
   * Load the <a href="https://italia.github.io/bootstrap-italia/docs/come-iniziare/introduzione/#fonts">bootstrap-italia fonts</a>
   * @default true
   */
  loadFont: boolean | undefined,

  ...
};

provideDesignAngularKit(initConfig)

DesignAngularKitModule.forRoot(initConfig)

Importazione stili bootstrap-italia

Configura gli stili richiesti nel file styles.scss. Importa la libreria SCSS come mostrato nell'esempio qui sotto.

// Importazione libreria SCSS di bootstrap-italia
@import 'bootstrap-italia/src/scss/bootstrap-italia';
Come personalizzare e sovrascrivere le variabili di default della libreria (es. colori, font-family, misure, ecc.)

Bootstrap Italia eredita ed estende tutte le variabili di default di Bootstrap, sovrascrivendo alcuni valori in fase di compilazione e impostandone di nuovi all’occorenza. Un esempio fra tutti è il valore del colore $primary che in Bootstrap Italia è rappresentato dal colore blu #0066CC, tipico della libreria.

L’utilizzo del blu #0066CC dovrebbe però essere riservato alle amministrazioni centrali dello Stato, e quindi ci si può trovare nella condizione di dover personalizzare i valori delle variabili colore di Bootstrap Italia, impostando nuovi valori per le proprie necessità.

Questo colore e le altre tonalità vengono generate a partire dalla terna HSB, pertanto occorre modificare le variabili primary-h, primary-s e primary-b. Per avere la corrispondenza tra valore esadecimale del colore e HSB si può utilizzare il portale rgb.to, ad esempio https://rgb.to/0066CC.

Di seguito un esempio di file styles.scss con la personalizzazione dei colori. Le personalizzazioni delle variabili devono sempre essere effettuate prima dell'importazione del file bootstrap-italia.scss

// modifica completa del template: è possibile ricompilare la libreria modificando alcune variabili SCSS

// Per l'override del colore $primary della palette in formato HSB (colore #FF3333 https://rgb.to/ff3333):
$primary-h: 0;
$primary-s: 80;
$primary-b: 100;

// Per l'override della famiglia di caratteri
$font-family-serif: 'Custom Font', Georgia, serif;
$font-family-sans-serif: 'Custom Font', Arial, Helvetica, sans-serif;
$font-family-monospace: 'Custom Font', 'Courier New', Courier, monospace;

// Importazione libreria SCSS di bootstrap-italia
@import 'bootstrap-italia/src/scss/bootstrap-italia';

Supporto icone e assets

Per aggiungere il supporto icone/assets, modifica il tuo angular.json aggiungendo:

{
 "assets": [
    ...
    {
      "glob": "**/*",
      "input": "./node_modules/bootstrap-italia/",
      "output": "/bootstrap-italia/"
    }
  ]
}

Supporto i18n (localizzazione)

La libreria usa ngx-translate per aggiungere le localizazioni i18n.

Modifica il tuo angular.json aggiungendo:

{
  "assets": [
    ...
    {
      "glob": "**/*",
      "input": "./node_modules/design-angular-kit/assets/i18n",
      "output": "/bootstrap-italia/i18n/"
    }
  ]
}

Puoi utilizzare le label localizzate della libreria design-angular-kit nella tua applicazione, ad esempio {{'it.errors.required-field' | translate}}. Vedi le nostre label

Localizzazione esistente

Se utilizzi già i file di localizzazione nella tua app, puoi utilizzare la libreria ngx-translate-multi-http-loader per caricare sia i file di localizzazione dell'app che quelli della libreria design-angular-kit

Utilizzando la funzione provideDesignAngularKit:

import { HttpBackend } from '@angular/common/http';
import { TranslateLoader } from '@ngx-translate/core';
import { MultiTranslateHttpLoader } from 'ngx-translate-multi-http-loader';
import { provideDesignAngularKit } from 'design-angular-kit';

provideDesignAngularKit({
  translateLoader: (itPrefix: string, itSuffix: string) => ({
    provide: TranslateLoader,
    useFactory: (http: HttpBackend) =>
      new MultiTranslateHttpLoader(http, [
        { prefix: itPrefix, suffix: itSuffix }, // Load library translations first, so you can edit the keys in your localization file
        { prefix: './assets/i18n/' }, // Your i18n location
      ]),
    deps: [HttpBackend],
  }),
});

Utilizzando il modulo DesignAngularKitModule:

import { HttpBackend } from '@angular/common/http';
import { TranslateLoader } from '@ngx-translate/core';
import { MultiTranslateHttpLoader } from 'ngx-translate-multi-http-loader';
import { DesignAngularKitModule } from 'design-angular-kit';

DesignAngularKitModule.forRoot({
  translateLoader: (itPrefix: string, itSuffix: string) => ({
    provide: TranslateLoader,
    useFactory: (http: HttpBackend) =>
      new MultiTranslateHttpLoader(http, [
        { prefix: itPrefix, suffix: itSuffix }, // Load library translations first, so you can edit the keys in your localization file
        { prefix: './assets/i18n/' }, // Your i18n location
      ]),
    deps: [HttpBackend],
  }),
});

Personalizzazione della localizzazione

Se vuoi personalizzare le nostre label:

  • Non includere il supporto i18n nel tuo angular.json
    • Crea i tuoi file di localizzazione personalizzati nella tua cartella assets/bootstrap-italia/i18n/ (crea il percorso se non esiste)
    • Il json deve avere questo formato.
    • Aggiungi nella configurazione iniziale della libreria il translateLoader custom, sostituendo la stringa assets/bootstrap-italia/i18n/ all'attributo itPrefix
  • Oppure, aggiungi le localizzazioni nei tuoi file json, sovrascrivendo le chiavi del json della libreria.

Utilizzo

Utilizzando il modulo DesignAngularKitModule tutti i componenti della libreria verranno importati nell'applicazione.

In alternativa, poiché tutti i nostri componenti e direttive sono standalone, puoi importare solo i componenti/moduli di cui hai bisogno, ad es. Alert, Paginazione e Breadcrumb.

import { ItAlertComponent, ItPaginationComponent, ItBreadcrumbsModule } from 'design-angular-kit';

@NgModule({
  imports: [
    ItAlertComponent,
    ItPaginationComponent,
    ItBreadcrumbsModule, // Include ItBreadcrumbComponent e ItBreadcrumbItemComponent
  ],
})
export class YourAppModule {}
import { ItAlertComponent, ItPaginationComponent, ItBreadcrumbsModule } from 'design-angular-kit';

@Component({
  selector: 'app-product',
  standalone: true,
  imports: [ItAlertComponent, ItPaginationComponent, ItBreadcrumbsModule],
  templateUrl: './product.component.html',
})
export class ProductComponent {}

Come contribuire 💙

👉🏻 È possibile contribuire alla libreria in vari modi:

  • Con il proprio codice, prendendo in carico una issue tra quelle aperte e non già assegnate tra le issue di Angular Kit (è sufficiente anche un commento sulla issue per notificare la volontà di presa in carico).
  • Attraverso la segnalazione di bug o miglioramenti al repository ufficiale di Angular Kit.
  • Scrivendoci sul canale dedicato di Slack.

Come contribuire con il codice

Vorresti dare una mano su Design Angular Kit? Sei nel posto giusto!

Se non l'hai già fatto, inizia spendendo qualche minuto per approfondire la tua conoscenza sulle linee guida di design per i servizi web della PA, e fai riferimento alle indicazioni su come contribuire a Design Angular Kit.

Impostare l'ambiente locale

I requisiti minimi del tuo ambiente locale devono essere:

  • NodeJS (>= 20)

A questo punto, è necessario impostare il tuo ambiente locale per la compilazione dei file sorgente e la generazione della documentazione:

  1. Clonare il progetto
git clone https://github.com/italia/design-angular-kit.git
  1. Nella cartella di progetto installare le dipendenze
npm i
  1. Lanciare l'applicazione in locale
npm run start
  1. Per eseguire i test di unità eseguire il comando
npm run test

Impostare l'ambiente locale con Devcontainer

I requisiti minimi del tuo ambiente locale per lavorare con i Devcontainer devono essere:

  • Visual Studio Code
  • Docker
  • git

Avvia Visual Studio Code e installa l'estensione Dev Containers di Microsoft (ms-vscode-remote.remote-containers).

A questo punto, è necessario impostare seguire i seguenti step:

  1. Clonare il progetto
git clone https://github.com/italia/design-angular-kit.git

  1. Aprire la cartella di progetto con Visual Studio Code

  2. Al caricamento, Visual Studio Code riconoscerà la presenta della configurazione di un Devcontainer. Aprire il progetto con il devcontainer. Altre info qui.

  3. Visual Studio Code effettuerà il setup del container, andando ad installare la corretta versione di NodeJs, di npm e delle estensioni dell'IDE. Le dipendenze di progetto saranno installate nel processo di creazione del container. L'ambiente di sviuppo sarà pronto a setup ultimato.

  4. Lanciare l'applicazione in locale

npm run start
  1. Per eseguire i test di unità eseguire il comando
npm run test

Link utili

Dalla community

Contributor della libreria

Un grazie speciale a chi ha reso possibile lo sviluppo di questa libreria

Antonino Bonanno Cristian Borelli Alessio Napolitano
Antonino Bonanno Cristian Borelli Alessio Napolitano

e grazie in particolare al team di NetService:

NetService logo

Tutti i contributor (made with contributors-img)