JSPM

@utrecht/icon

1.0.0-alpha.416
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 634
  • Score
    100M100P100Q90472F
  • License EUPL-1.2

Icons for the Municipality of Utrecht based on the NL Design System architecture

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@utrecht/icon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Iconen in code

    Iconen gebruiken als Custom Element

    Eén van de makkelijkste manieren om iconen te gebruiken is door ze te includen in de web component library, zodat je ze als custom element kan gebruiken. Elk icoon is beschikbaar als custom element. De naam van van het icoon (utrecht-icon-...) is ook de naam van het custom-element. Voorbeeld:

    <div>
      <utrecht-icon-loupe></utrecht-icon-loupe>
    </div>

    Verander de kleur van het icoon via de CSS-eigenschap color op een parent element of via de custom eigenschap --utrecht-icon-color.

    color van de omgevings content

    Op onderstaande manier kan je het makkelijkst de kleur aanpassen. De kleur van de bestaande tekst zal ook op het icoon toegepast worden.

    <button>
      <utrecht-icon-loupe></utrecht-icon-loupe>
      Search
    </button>
    
    <style>
      button {
        background-color: rgb(0, 0, 0);
        color: rgb(255, 255, 255);
      }
    </style>

    --utrecht-icon-color als custom icoon kleur

    Deze manier is handig als je een klein verschil wilt aanbrengen tussen de tekst kleur en de kleur van het icoon. Het gebruikt een CSS custom property --utrecht-icon-color als de kleur van het icoon.

    <button>
      <utrecht-icon-loupe></utrecht-icon-loupe>
      Search
    </button>
    
    <style>
      button {
        --utrecht-icon-color: rgba(255, 255, 255, 0.75);
        background-color: rgb(0, 0, 0);
        color: rgb(255, 255, 255);
      }
    </style>

    Icoon grootte aanpassen

    De grootte van het icoon kan aangepast worden met de --utrecht-icon-size CSS eigenschap:

    <button>
      <utrecht-icon-loupe></utrecht-icon-loupe>
      Search
    </button>
    
    <style>
      button {
        --utrecht-icon-size: 42px;
        background-color: rgb(0, 0, 0);
        color: rgb(255, 255, 255);
      }
    </style>

    Overzicht van icons

    Wanneer het nodig is een overzicht te hebben van de beschikbare icons, gebruik dan als basis de meegeleverde JSON informatie in dist/index.json. Het bevat een array met onder andere de ID van elke icoon. Op dit moment is de naam van de custom element altijd gelijk aan de ID.