Skip to content

codemonster-ru/vueforge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

130 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VueForge

VueForge is a Vue 3 ecosystem for design-system foundations, theming, accessible components, layouts, icons, code presentation, and interactive playgrounds.

Requirements

  • Vue ^3.5.0.
  • Node.js 18 or newer for packages other than CodeBlock and Playground. A selected Vite version may impose a higher Node.js requirement on the Playground Vite plugin.
  • Node.js 20 or newer when using CodeBlock or Playground.

Install Core

Use the package manager that owns your application lockfile:

npm install vue@^3.5.0 @codemonster-ru/vueforge-core@^2.1.0
pnpm add vue@^3.5.0 @codemonster-ru/vueforge-core@^2.1.0
yarn add vue@^3.5.0 @codemonster-ru/vueforge-core@^2.1.0

Quick start

Install the Core plugin once and import its complete stylesheet in the browser entry:

// src/main.ts
import { createApp } from 'vue';
import VueForgeCore from '@codemonster-ru/vueforge-core';
import '@codemonster-ru/vueforge-core/styles.css';
import App from './App.vue';

createApp(App).use(VueForgeCore).mount('#app');

Wrap themed UI in VfThemeProvider. Components are not registered globally, so import the components used by each application:

<!-- src/App.vue -->
<script setup lang="ts">
import { VfButton, VfThemeProvider, VfThemeSwitch } from '@codemonster-ru/vueforge-core';
</script>

<template>
  <VfThemeProvider default-theme="system">
    <main>
      <VfThemeSwitch label="Theme" />
      <VfButton>First VueForge action</VfButton>
    </main>
  </VfThemeProvider>
</template>

VfThemeSwitch persists the selected light or dark mode through the provider. Build the application with its normal production command—for a standard Vite project:

npm run build

Packages

Package Release Purpose
@codemonster-ru/vueforge-core 2.0.0 Components, composables, theme integration
@codemonster-ru/vueforge-theme 2.0.0 Framework-agnostic theme engine
@codemonster-ru/vueforge-layouts 2.0.0 Layout primitives and application shells
@codemonster-ru/vueforge-icons 2.0.0 Vue icon renderer and catalog
@codemonster-ru/vueforge-codeblock 4.0.0 Highlighted, themed code blocks
@codemonster-ru/vueforge-playground 3.0.0 Vue playground UI adapter
@codemonster-ru/vueforge-playground-core 2.0.0 Framework-agnostic playground runtime
@codemonster-ru/vueforge-playground-vite-plugin 1.0.0 Vite playground virtual-module integration

Documentation

For full documentation, visit docs.codemonster.net/vueforge. Use the VueForge 2 migration guide for breaking changes and the release notes for the coordinated package changes.

License

VueForge packages are available under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages