@vueland/ui

⚠️ Active development — not production ready

This package is still far from a production-ready UI library. APIs, behavior, styles, and accessibility details may change between releases. The component catalog shows what currently exists; Stable means comparatively documented and tested within the current early-development phase, not a production-readiness guarantee.

@vueland/ui is the early UI layer of the Vueland platform. It currently includes a 12-column grid, form controls, overlays, composables, presets, and experiments around slot-first component anatomy. Treat it as an evolving foundation for testing ideas and giving feedback, not as a finished drop-in UI kit.

Documentation

Full documentation, examples, and component API references:

https://vueland.github.io/vueland/en/guide/getting-started

Installation

# pnpm
pnpm add @vueland/ui

# npm
npm install @vueland/ui

# yarn
yarn add @vueland/ui

Setup

1. Register the library

// src/main.ts
import { createApp } from 'vue'
import { createVuelandUI } from '@vueland/ui'
import * as components from '@vueland/ui/components'

import '@vueland/ui/styles/styles.scss'
import '@vueland/ui/styles/lib.scss'

import App from './App.vue'

const app = createApp(App)
app.use(createVuelandUI({ components }))
app.mount('#app')

Import SCSS source, not pre-compiled CSS. Styles are compiled by Vite at build time. If you import dist/styles.css, breakpoints configured via @vueland/utils-jit will not be applied.

2. Use components

Components are registered globally after app.use(vueland):

<template>
  <CRow>
    <CCol cols="12" sm="6" md="4">
      <CCard class="pa-4 elevation-2">Hello Vueland</CCard>
    </CCol>
  </CRow>
</template>

Breakpoints

Material Design breakpoint scale, shared across the grid, utility classes, and useDisplay:

To customize breakpoints, use @vueland/utils-jit — one config in vite.config.ts syncs all layers. See the Breakpoints guide.

Grid system

<CRow align="center" justify="space-between">
  <CCol cols="12" sm="6" md="4">
    <CCard class="pa-4">Card</CCard>
  </CCol>
</CRow>

Utility classes

<div class="pa-2 md:pa-6 lg:pa-10">responsive padding</div>
<div class="d-none md:d-flex">hidden on mobile</div>
<div class="bg-indigo text-white radius-12 elevation-2">styled card</div>

useDisplay composable

<script setup lang="ts">
import { useBreakpoints } from '@vueland/ui/composables'

const { mdAndUp } = useBreakpoints()
</script>

<template>
  <CRow>
    <CCol :cols="mdAndUp ? 6 : 12">Adaptive column</CCol>
  </CRow>
</template>

Part of the Vueland platform

@vueland/ui is one part of the Vueland platform. The platform also includes:

• @vueland/utils-jit — JIT utility class generation for Vite
• More plugins and adapters coming over time

See the platform overview for the full picture.

⭐ Support the project

If this package is useful to you, a star on GitHub goes a long way.

Star on GitHub →

License

MIT