plugin-ui-for-kzt

plugin-ui-for-kzt

A custom UI plugin for Vue 3 + TypeScript projects, with Quasar integration support.

🚀 Installation

✅ Prerequisites

• Node.js v23.x or higher
• Vue 3 project (with or without Quasar)

📦 Install the Plugin

npm install plugin-ui-for-kzt

⚙️ Quasar Integration Setup

If you're using Quasar, follow these additional steps to properly integrate the plugin:

1. Create a Boot File

Create a new file named plugin-ui-for-kzt.ts in your project's boot/ directory.

// src/boot/plugin-ui-for-kzt.ts
import { boot } from 'quasar/wrappers'
import PluginUIForKZT from 'plugin-ui-for-kzt'

export default boot(({ app }) => {
  app.use(PluginUIForKZT)
})

2. Register the Boot File in quasar.config.js

boot: [
  'plugin-ui-for-kzt',
  // other boot files
]

3. (Optional) Import in client-entry.js if needed

import('boot/plugin-ui-for-kzt')

🔢 Plugin Versioning Rules

The plugin version must follow the pattern: X.Y.Z, with a maximum version value of 100.
Examples of valid versions:

• version: "0.0.25"
• version: "0.25.99"
• version: "46.25.46"

🚀 Publishing the Plugin to npm

Follow these steps to update and publish a new version of the plugin:

1. Update the Version

Update the version field in your package.json file according to Semantic Versioning.

2. Clean Previous Builds

rm -rf dist

3. Clean Previous Builds

npm run build

check to correct build version

4. Log in to npm

npm login

💡 Use the npm credentials stored in your GitLab vault or settings.

5. Publish the Package

npm publish --access public

6. Commit and Push to GitLab

git add .
git commit -m "chore: bump version to x.x.x"
git push

7. (Optional) Clear npm Cache

npm cache clean --force

7. Update the Plugin in Your Project

npm install plugin-ui-for-kzt@latest --force

8. Restart Your Quasar Project

quasar clean
quasar dev

✅ Done! Your plugin is now published and integrated successfully into your Quasar project.