jervis-form

A dynamic Vue 3 form library to render configurable form schemas with reusable field components.

Installation

npm install jervis-form

Peer Dependencies

Make sure these are installed in your app:

• vue
• vuetify
• jervis-icons
• jervis-datepicker
• @vueup/vue-quill (optional)

Build

npm run build

Documentation (VitePress)

Run docs locally:

npm run docs:dev

Build docs for static hosting:

npm run docs:build
npm run docs:preview

Custom Input Registration

Register custom field components globally with the plugin:

import { createApp } from "vue";
import App from "./App.vue";
import { JervisFormPlugin } from "jervis-form";
import MyCustomInput from "./components/MyCustomInput.vue";

const app = createApp(App);

app.use(JervisFormPlugin, {
  customFieldTypes: {
    myCustomInput: MyCustomInput,
  },
});

Then use it in your schema:

const schema = [
  {
    type: "myCustomInput",
    key: "customValue",
    label: "Custom Value",
  },
];

You can also register custom fields locally on a single GenericForm instance:

<GenericForm
  :schema="schema"
  :customFieldTypes="{ myCustomInput: MyCustomInput }"
/>

Publish Checklist

npm run build
npm run pack:check
npm publish

License

MIT

AI Agent Skill

This package ships with an Agent Skill at docs/SKILL.md. The skill teaches supported AI coding agents the intended API, workflows, constraints, and verification steps for this package.

Install the package

npm install jervis-form

Install the skill for your AI agent

npx skills add ./node_modules/jervis-form/docs

The skills CLI can install the skill into supported agents such as Claude Code, Codex, Cursor, OpenCode, and many others. Run the command from your project root after installing the npm package.

To install globally instead of only for the current project:

npx skills add ./node_modules/jervis-form/docs -g

You can also target a specific supported agent with --agent, for example:

npx skills add ./node_modules/jervis-form/docs --agent codex

After installation, the agent can discover and follow the package skill automatically according to that agent's supported skill location.