@enos5/enos-vue

Shared Vue 3 UI components from Enos

Requirements

• Node.js 20+
• npm

Install

Clone the repository, then install dependencies:

npm install

Build the package:

npm run build

Component Documentation Sandbox

This repository includes a dedicated docs playground for the component library. It renders each component with a live example and generates editable prop controls from the component prop definitions.

Run it locally:

npm install
npm run docs:dev

Build the docs site:

npm run docs:build

Run With Docker

Start the docs app with Docker Compose:

docker compose up --build

Then open http://localhost:4173.

Use In Another Project

Install the published package:

npm install @enos5/enos-vue

This package expects these peer dependencies in the consuming app:

• vue
• @inertiajs/vue3
• @heroicons/vue
• vue-i18n

Rich text support uses TinyMCE and is bundled as a regular dependency in this library. Consuming apps can use the shared TinyEditor component directly or through InputGroup with type="tiny-editor".

TinyEditor is intentionally app-agnostic:

• pass init to merge in app-specific TinyMCE configuration
• pass licenseKey to override the TinyMCE license mode when needed
• pass readonly to lock editing without removing the viewer
• pass plugins and toolbar to change the editing surface

You can register everything globally:

import { createApp } from 'vue'
import App from './App.vue'
import { EnosVue } from '@enos5/enos-vue'

createApp(App).use(EnosVue).mount('#app')

Or import individual components:

import { PrimaryButton, TextInput } from '@enos5/enos-vue'

Publish To npm

Before publishing, build the package and verify the tarball:

npm run build
npm pack --dry-run

npm run build generates the release artifacts in dist/:

• dist/index.js for runtime imports
• dist/index.js.map for debugging
• dist/index.d.ts for TypeScript consumers

Then bump the version in package.json, commit the change, and make sure you are logged in to npm:

npm login

Publish the package:

npm publish

If this is a scoped package being published publicly for the first time, use:

npm publish --access public

Release Checklist

For each release:

1. Update the version number in package.json.
2. Commit the version change.
3. Run npm run build.
4. Run npm pack --dry-run if you want to inspect the publish contents.
5. Run npm publish.
6. Create a matching release in Gitea for the same version tag.

Keeping the npm package version and the Gitea release aligned avoids release drift.