@oslokommune/oslo-designsystem-vue

Bruk av @oslokommune/oslo-designsystem-vue

Oslo Designsystems 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/oslo-designsystem.

Forutsetninger

Peer dependencies:

• nodejs 16.5
• vue >= 2.6.12 < 3.0.0
• @oslokommune/oslo-designsystem >= 0.14.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/oslo-designsystem-vue

2. Importer komponentene i appen

/* src/main.js

Velg å installere hele bundlen */
import Vue from 'vue';
import OdsVue from '@oslokommune/oslo-designsystem-vue';

Vue.use(OdsVue);


/* eller kun individuelle komponenter */
import Vue from 'vue';
import { OdsHeader, OdsFooter } from '@oslokommune/oslo-designsystem-vue';

Vue.use(OdsHeader);
Vue.use(OdsFooter);

Versjonering

Oslo Designsystem 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

Oslo designsystem er distribuert under MIT-lisens for åpen kildekode.