OpenParable
Skip to content
← Back to skills

Vue Wrapper Dev

Development
vue-wrapper-dev

Vue Wrapper Dev is an Agent Skill for development published in the handsontable/handsontable repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when developing or modifying the @handsontable/vue3 wrapper package - Vue 3 SFC components, deep watchers, and provide/inject patterns for settings propagation

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/handsontable/handsontable/blob/HEAD/.claude/skills/vue-wrapper-dev/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/vue-wrapper-dev, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Vue 3 Wrapper Development

Package location

wrappers/vue3/

Components

  • HotTable.vue - the main Single-File Component. Creates the Handsontable instance on mount and tears it down on unmount.
  • HotColumn.vue - child component for declarative per-column configuration.

Architecture

Components use defineComponent with propFactory('HotTable') to auto-generate prop definitions matching every Handsontable option.

Deep watchers (watch with deep: true) monitor prop changes. When a change is detected, the watcher calls updateSettings() on the Handsontable instance with the new values.

prepareSettings() is a helper that transforms Vue component props into a plain Handsontable settings object, filtering out Vue-specific properties.

Parent-child communication uses Vue's provide() / inject() pattern. The HotTable component provides its settings and instance reference so HotColumn children can register their column configurations.

Data handling: Data is synced by reference, not deep-copied. Mutations to the original data array are reflected in the grid without extra work. Avoid replacing the data array reference unless you intend a full reload.

Build and test

  • Build system: Rollup 4.
  • Tests: Jest with @vue/test-utils.
  • Run tests: npm run test --prefix wrappers/vue3
  • Important: Build core first with npm run build --prefix handsontable. Wrappers consume handsontable/tmp/, not dist/.

Key files

FilePurpose
src/HotTable.vueMain grid component
src/HotColumn.vuePer-column configuration component
src/helpers.tsSettings preparation and utility functions
src/types.tsTypeScript type definitions

Rules

  • No business logic in wrappers. All data transformation and validation belongs in handsontable/src/.
  • Cross-platform npm scripts: use Node.js .mjs helpers instead of bash-only constructs.