@artsdatabanken/icons
v2.1.0
Published
Artsdatabanken ikonbibliotek — inline SVG Web Component + optimiserte SVG-filer
Keywords
Readme
@artsdatabanken/icons
Artsdatabanken ikonbibliotek — optimiserte SVG-ikoner og en Lit web component (<adb-icon>).
Installasjon
npm install @artsdatabanken/iconsBruk
Web component (<adb-icon>)
import '@artsdatabanken/icons/icon';<!-- Dekorativt ikon (skjult for skjermlesere) -->
<adb-icon name="search"></adb-icon>
<!-- Meningsbærende ikon (aria-label settes automatisk) -->
<adb-icon name="search" label="Søk" size="lg"></adb-icon>Størrelser
| size | Størrelse |
|--------|-----------|
| sm | 16 px |
| md | 24 px (standard) |
| lg | 24 px (samme som md, matcher <adb-icon-button size="lg">) |
Ikoner arver color fra omgivelsene via currentColor:
<adb-icon name="close" style="color: red"></adb-icon>SVG som tekst (uten web component)
@artsdatabanken/icons/svg eksporterer hvert ikon som en SVG-streng. Importen har ingen sideeffekter —
den registrerer ikke <adb-icon> og drar ikke inn Lit — og bundleren tar bare med ikonene du importerer.
import { iconSearch, iconArrowBack, iconLicenseBy } from '@artsdatabanken/icons/svg';
button.innerHTML = iconSearch;Eksportnavnet er icon + ikonnavnet i PascalCase: search → iconSearch, arrow-back → iconArrowBack,
license/by → iconLicenseBy.
Trenger du alle ikonene (f.eks. i en ikonvelger), bruk icons og typen IconName:
import { icons, type IconName } from '@artsdatabanken/icons/svg';
const name: IconName = 'search';
const svg = icons[name];SVG-ene bruker currentColor og arver tekstfargen der de settes inn.
Angular: [innerHTML] fjerner <svg>-elementer. Bruk DomSanitizer.bypassSecurityTrustHtml() —
det er trygt her fordi innholdet kommer fra pakken, ikke fra brukeren:
import { DomSanitizer } from '@angular/platform-browser';
import { iconSearch } from '@artsdatabanken/icons/svg';
searchIcon = inject(DomSanitizer).bypassSecurityTrustHtml(iconSearch);
// <span [innerHTML]="searchIcon"></span>SVG-filer (Drupal, Twig, <img> etc.)
Optimaliserte SVG-filer ligger på @artsdatabanken/icons/svg/<ikonnavn>.svg — stien er den samme som ikonnavnet:
{{ source('@artsdatabanken/icons/svg/search.svg') }}
{{ source('@artsdatabanken/icons/svg/license/by.svg') }}Angular — kopier filene inn som assets i angular.json:
{ "glob": "**/*.svg", "input": "node_modules/@artsdatabanken/icons/dist/svg", "output": "icons" }<img src="icons/search.svg" alt="Søk" />I <img> blir currentColor svart. Bruk SVG-strengen over hvis ikonet skal arve tekstfargen.
Eller med CDN:
<img src="https://cdn.example.com/@artsdatabanken/[email protected]/svg/search.svg" alt="Søk" /><adb-icon> API
| Attributt | Type | Standard | Beskrivelse |
|---|---|---|---|
| name | string | — | Ikonnavn (filnavn uten .svg) |
| size | 'sm' \| 'md' \| 'lg' | 'md' | Størrelse |
| label | string | — | Aria-label — sett for meningsbærende ikoner |
Legg til egne ikoner
- Eksporter SVG-filen fra Figma (24×24 px, SVG-format)
- Gi filen et navn i
lowercase-kebab-case, f.eks.my-icon.svg - Legg den i
src/svg/(egendefinerte ikoner kan legges isrc/svg/custom/) - Kjør bygget:
npm run build:icons -w @artsdatabanken/iconsDette genererer src/generated/icons.ts og optimiserte SVG-filer i dist/svg/.
Commit begge deler.
Navnekonvensjon
Filnavn i src/svg/ brukes direkte som ikonnavnet i <adb-icon name="...">:
| Fil | name |
|---|---|
| src/svg/search.svg | search |
| src/svg/arrow-back.svg | arrow-back |
| src/svg/custom/logo.svg | custom/logo |
| src/svg/license/by.svg | license/by |
Se alle ikoner i ikonoversikten.
Navnene følger «GMI Navn»-kolonnen i Figma (Icon Material design / Icon Licenses), skrevet i lowercase-kebab-case.
custom/— modifiserte Material-ikoner (f.eks.custom/polygon,custom/sparkle)license/— Creative Commons- og lisensikoner (f.eks.license/creative-commons,license/by,license/nc-eu)
CDN
<script type="module" src="https://cdn.example.com/@artsdatabanken/[email protected]/cdn/adb-icons.js"></script>