README.md

VueForge

Open source UI library for Vue 3, split into core components and layouts.

Install

npm i @codemonster-ru/vueforge

Optional companion packages:

npm i @codemonster-ru/vueforge-layouts

Peer dependencies:

• vue (v3)
• vue-router (v4)
• @codemonster-ru/vueiconify

Quick Start

import { createApp } from 'vue';
import { VueForge, DefaultTheme } from '@codemonster-ru/vueforge';
import '@codemonster-ru/vueforge/dist/index.css';
import '@codemonster-ru/vueforge-layouts/dist/index.css';
import App from './App.vue';

const app = createApp(App);

app.use(VueForge, {
    theme: {
        preset: DefaultTheme,
    },
});

<template>
    <Container size="lg">
        <PageHeader title="Dashboard" subtitle="Manage projects and teams">
            <template #actions>
                <Button label="Create project" />
            </template>
        </PageHeader>
    </Container>
</template>

<script setup lang="ts">
import { Container, Button } from '@codemonster-ru/vueforge';
import { PageHeader } from '@codemonster-ru/vueforge-layouts';
</script>

Packages

• @codemonster-ru/vueforge: core primitives, forms, overlays, data display, services, theme/config runtime
• @codemonster-ru/vueforge-layouts: app shell and layout composition

@codemonster-ru/vueforge-layouts complements the core package for app-shell and page layout composition.

Full catalog: docs/components/README.md

Documentation

• Theming: docs/theming.md
• Date/time locale setup: docs/guides/date-time-locale-setup.md
• Locale text setup: docs/guides/locale-text-setup.md
• i18n + RTL setup: docs/guides/i18n-rtl-setup.md
• Live examples recipe: docs/recipes/live-playground.md
• Core copy-paste cookbook: docs/recipes/core-cookbook.md
• Components catalog: docs/components/README.md
• Package split migration: docs/guides/package-split.md
• Package versioning / release tags: docs/contributing/package-versioning.md
• Roadmap / execution checklist: CHECKLIST.md
• Release notes: CHANGELOG.md

Development

npm run dev
npm run test
npm run typecheck
npm run build

Release Tags

• vueforge-vx.y.z publishes @codemonster-ru/vueforge
• layouts-vx.y.z publishes @codemonster-ru/vueforge-layouts

License

MIT

Author

@KolesnikovKirill