@oslokommune/punkt-vue2

Bruk av @oslokommune/punkt-vue2

Dette repoet inneholder Punkt sine UI-komponenter for Vue 2.6+. Vue 3 støttes ikke på dette tidspunktet. Komponentene er laget for å fungere sammen med CSS fra designsystemet @oslokommune/punkt-css.

Forutsetninger

Peer dependencies:

• nodejs 16.5
• vue >= 2.6.12 < 3.0.0
• @oslokommune/punkt-css >= 0.20.0

📄 Dokumentasjon [UNDER ARBEID]

Hver komponent vil være dokumentert på nettsiden til designsystemet, på en stadig bedre måte.

🚀 Kom i gang

Eksempelet under viser installasjon i en applikasjon med Vue 2 + Webpack. Går utifra at peerDependencies allerede er installert og tatt i bruk, hvis ikke så se veiledere for dette.

1. Installer komponentbiblioteket

npm add @oslokommune/punkt-vue2

2. Importer komponentene i appen

/* src/main.js

Velg å installere hele bundlen */
import Vue from 'vue';
import PktVue from '@oslokommune/punkt-vue2';

Vue.use(PktVue);


/* eller kun individuelle komponenter */
import Vue from 'vue';
import { PktHeader, PktFooter } from '@oslokommune/punkt-vue2';

Vue.use(PktHeader);
Vue.use(PktFooter);

Versjonering

Punkt bruker Semantic Versioning 2.0.0 for versjonering av pakkene.

Mens vi er i en beta-fase, versjonering vil følge dette mønsteret: v0.Y.Z, hvor

• Y: Major (breaking changes)
• Z: Minor eller patch

👮 Lisens

Punkt er distribuert under MIT-lisens for åpen kildekode.