@madsb/dkfds-vue-kit

Vue 3 component library implementing Det Fælles Designsystem (DKFDS) v11.

✨ 40+ accessible Vue 3 components following Danish government design standards
🎯 WCAG 2.1 AA compliant with comprehensive accessibility support
📦 Modern ESM-only package with full TypeScript support
🌲 Tree-shakeable - Import only what you need
🎨 Theme-agnostic - Works with any DKFDS theme (Virkdk, Borgerdk, or default)

📦 Installation

npm install @madsb/dkfds-vue-kit dkfds
# or
pnpm add @madsb/dkfds-vue-kit dkfds

Required peer dependencies: vue@^3.4.0 and dkfds@^11.0.0

🚀 Quick Start

1. Install the Vue Plugin

// main.ts
import { createApp } from 'vue'
import dkfdsVueKit from '@madsb/dkfds-vue-kit'
import App from './App.vue'

const app = createApp(App)
app.use(dkfdsVueKit)
app.mount('#app')

2. Import Styles

Choose one of these approaches:

Option A: Pre-built CSS (Easiest)

// main.ts
import '@madsb/dkfds-vue-kit/dist/dkfds-vue-kit.css'

Option B: Theme-based SCSS (Recommended)

Simple two-step integration:

Default Theme (Generic DKFDS):

// main.scss
// 1. Import DKFDS base styles with default theme
@use '../../node_modules/dkfds/src/stylesheets/dkfds' as dkfds with (
  $font-path: '../../node_modules/dkfds/src/fonts/IBMPlexSans/',
  $image-path: '../../node_modules/dkfds/src/img/',
  $icons-folder-path: '../../node_modules/dkfds/src/img/svg-icons/'
);

// 2. Import Vue3 components - one simple import!
@use '@madsb/dkfds-vue-kit/styles';

Virk Theme (for virk.dk solutions):

// main.scss
// 1. Import DKFDS base styles with Virk theme
@use '../../node_modules/dkfds/src/stylesheets/dkfds-virkdk' as dkfds with (
  $font-path: '../../node_modules/dkfds/src/fonts/IBMPlexSans/',
  $image-path: '../../node_modules/dkfds/src/img/',
  $icons-folder-path: '../../node_modules/dkfds/src/img/svg-icons/'
);

// 2. Import Vue3 components - one simple import!
@use '@madsb/dkfds-vue-kit/styles';

Borger Theme (for borger.dk solutions):

// main.scss
// 1. Import DKFDS base styles with Borger theme
@use '../../node_modules/dkfds/src/stylesheets/dkfds-borgerdk' as dkfds with (
  $font-path: '../../node_modules/dkfds/src/fonts/IBMPlexSans/',
  $image-path: '../../node_modules/dkfds/src/img/',
  $icons-folder-path: '../../node_modules/dkfds/src/img/svg-icons/'
);

// 2. Import Vue3 components - one simple import!
@use '@madsb/dkfds-vue-kit/styles';

3. Use Components

<script setup lang="ts">
import { FdsButton, FdsAlert, FdsInput } from '@madsb/dkfds-vue-kit'
</script>

<template>
  <fds-alert type="info">Welcome!</fds-alert>
  <fds-input v-model="name" label="Your name" />
  <fds-button @click="submit">Submit</fds-button>
</template>

Composables & Utilities

All composables, utilities, and types are available via the root entry point so you only need one import path.

// Import composables and utilities
import { useToast, formId, generateId, navigation } from '@madsb/dkfds-vue-kit'

🎨 Theme Configuration

This library provides simple DKFDS integration that works with any official theme:

Available Themes

Theme	DKFDS Stylesheet	Colors	Use Case
Default	dkfds	Generic DKFDS blue	Development, testing, generic use
Virk	dkfds-virkdk	Virk.dk blue	Government websites and applications
Borger	dkfds-borgerdk	Borger.dk green	Public-facing citizen services

Theme Benefits

• ✅ Dead simple - Two imports: DKFDS base + Vue3 components
• ✅ Official colors - DKFDS handles all theme colors
• ✅ Modern SCSS - Uses latest Sass module system (@use/@forward)
• ✅ Theme-agnostic - Works with any DKFDS theme
• ✅ No deprecation warnings - Dart Sass 2.0+ compatible

Switching Themes

Change themes by updating your DKFDS stylesheet import:

// From this:
@use '../../node_modules/dkfds/src/stylesheets/dkfds-virkdk' with (...);

// To this:
@use '../../node_modules/dkfds/src/stylesheets/dkfds-borgerdk' with (...);

// Vue3 import stays the same
@use '@madsb/dkfds-vue-kit/styles';

🛠️ Development

Setup

# Install dependencies
pnpm install

# Build the library
pnpm run build

# Run documentation site
pnpm run docs:dev

Scripts

# Development
pnpm run build            # Build library
pnpm run docs:dev         # Run documentation site
pnpm run test             # Run tests
pnpm run typecheck        # Check TypeScript types
pnpm run lint             # Lint code
pnpm run format           # Format code

# Testing
pnpm run test:run         # Run tests once
pnpm run test:coverage    # Run tests with coverage
pnpm run test:ui          # Run tests with UI

Project Structure

src/
├── components/           # Vue components organized by category
│   ├── forms/           # Form structure components
│   ├── input/           # Input and form control components
│   ├── navigation/      # Navigation and menu components
│   ├── feedback/        # User feedback (alerts, toasts, modals)
│   ├── data-display/    # Data presentation components
│   └── layout/          # Layout and utility components
├── composables/         # Vue composables
├── utils/               # Utility functions
├── types/               # TypeScript type definitions
└── index.ts             # Main entry point

🎯 Available Components

40+ components organized by category:

• Forms: FdsFormgroup, FdsLabel, FdsHint, FdsFejlmeddelelse
• Input: FdsInput, FdsCheckbox, FdsDropdown, FdsFileUpload
• Navigation: FdsBreadcrumb, FdsMenu, FdsPaginering, FdsTrinindikator
• Feedback: FdsAlert, FdsToast, FdsModal, FdsSpinner
• Data Display: FdsAccordion, FdsCard, FdsList, FdsTable
• Layout: FdsButton, FdsIkon, FdsCookiemeddelelse

🧪 Testing

# Run tests
pnpm test

# Run tests with coverage
pnpm test:coverage

# Type checking
pnpm typecheck

# Check with strict mode (shows potential improvements)
./typecheck-strict.sh

📄 License & Credits

MIT License - Fork of dkfds-vue-kit by Kenneth Torsten Rørstrøm
Built on Det Fælles Designsystem by the Danish Agency for Digital Government

🤝 Contributing

Contributions welcome! Please ensure tests pass and follow DKFDS specifications.