Jøkul er et designsystem som er utviklet av Fremtind.
- Stil: Jøkul gir deg css- og scss-stilark for de grunnleggende komponentene og designmønstrene til Fremtind. De følger Fremtinds designprinsipper.
- Komponenter: React-komponentene våre er klare til bruk. Vi har skrevet dem i Typescript, slik at utvikleropplevelsen blir bedre og det blir færre feil.
- Kan utvides: Jøkul har innebygd støtte for css, scss og React, men er lagt opp til å kunne støtte andre rammeverk og fremtidig teknologi.
- Klon repoet til maskinen din og naviger deg til mappen i terminalen
- Installer avhengigheter og bygg pakkene med
yarn boot - Start portalen lokalt med
yarn dev
NB! Når du sjekker ut en ny branch bør du bygge på nytt for å hindre at gammel bygget kode blir med når du kjører opp eksempler eller portalen. Kommandoen yarn reboot sletter alle bygde filer, installerer avhengigheter, og bygger pakkene på nytt.
Tips: Du kan starte opp én og én komponent ved å kjøre yarn dev i react-pakken til komponenten. Den vil lytte på endringer i både react-og stilpakkene.
Du kan bruke Jøkul på to måter. Du kan enten ta inn kun stilark eller du kan bruke stilarkene og de ferdige komponentene. Komponentpakkene inneholder alt som trengs, inkludert avhengigheter til andre pakker. NB! Selv om komponentpakkene inneholder alle avhengigheter må du selv sørge for å importere stilpakken i koden din.
yarn add @fremtind/jkl-button-react
import { PrimaryButton } from "@fremtind/jkl-button-react";
import "@fremtind/jkl-button/button.min.css"; // husk å importere stilarket
...
<PrimaryButton onClick={doStuff}>Cool</PrimaryButton>
...Hvis du ikke vil bruke React-komponentene, kan du bruke stilarkene direkte. Da laster du enten inn css-filene, eller du laster inn scss-filene inn i din egen scss-fil og får tilgang til Jøkuls variabler og mixins. Pass på at du har den riktige loaderen for å ta dette i bruk i prosjektet ditt.
yarn add @fremtind/jkl-button
import "@fremtind/jkl-button/button.min.css";
...
<button classname="jkl-button--primary" onClick={doStuff}>Cool</button>
...På https://fremtind.github.io/jokul/ finner du informasjon om hvordan du bruker Jøkul, om designprinsippene til Fremtind og beskrivelse, bruksområder og kode for hver enkelt komponent.
Formålet vårt med Jøkul er at det skal gå raskere å utvikle Fremtind-løsninger. Det skal være enkelt og lett å vedlikeholde og de ferdige løsningene skal føles like, selv om de er spesifikke for ulike fagområder i Fremtind eller ulike kundebehov. All utvikling skjer åpent på GitHub. Det gjør at alle interesserte kan følge med, påvirke retningen vi går i og være med på å videreutvikle designsystemet.
Vi setter pris på alle bidrag, enten du rapporterer feil, har ønsker om ny funksjonalitet, bugfix eller vil utvikle noe nytt.
Les mer om hvordan du kan bidra i guiden vår.
Jøkul er et åpent og positivt felleskap der alle skal føle seg velkommen. Gjør deg kjent med våre etiske regler for bidragsytere før du deltar med bidrag.
Jøkul er distribuert under MIT-lisensen for åpen kildekode.
Takk for bidrag fra disse flotte menneskene (emoji-oversikt):
Dette prosjektet følger retningslinjene i spesifikasjonen all-contributors. Vi setter pris på alle bidrag!