Splitpanes Nuxt Module

This module integrates the Splitpanes component with Nuxt 3.

Installation

npx nuxi@latest module add splitpanes-nuxt

or with Yarn:

npx nuxi@latest module add splitpanes-nuxt

Usage

In your nuxt.config.ts (or nuxt.config.js), add the module:

export default {
  modules: [
    'splitpanes-nuxt'
  ]
}

With this configuration, you can now use the Splitpanes and Pane components in your project. If you want to add a prefix to these component names, you can add a splitpanes configuration to your nuxt.config.ts:

export default {
  modules: [
    'splitpanes-nuxt'
  ],
  splitpanes: {
    prefix: 'MyPrefix'
  }
}

This will allow you to use the components with a prefix, like so: <MyPrefixSplitpanes />, <MyPrefixPane />, etc.

Further References

For detailed information about the Splitpanes component, its usage, options and events, please refer to the official Splitpanes documentation.

To contribute, submit issues or pull requests, visit the Splitpanes GitHub repository.

Contribution

Local development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release