Dimensional Innovations Vue Toolkit

A lightweight, flexible toolkit designed to streamline Vue 3 application development at Dimensional Innovations. This library provides essential building blocks to maintain consistency, reduce code duplication, and accelerate development across projects.

Purpose

The DI Vue Toolkit aims to:

• Standardize Development - Establish consistent patterns and practices across DI Vue projects
• Reduce Redundancy - Eliminate repeatedly coding the same solutions across different projects
• Enhance Quality - Provide well-tested, reliable implementations of common functionality
• Increase Developer Velocity - Enable teams to focus on business logic rather than infrastructure
• Promote Best Practices - Implement Vue ecosystem best practices in a reusable fashion

The toolkit is designed to be lightweight and non-prescriptive, allowing teams to use only what they need while maintaining flexibility in their architecture decisions.

Installation

# Using npm
npm install @dimensional-innovations/vue-toolkit

# Using yarn
yarn add @dimensional-innovations/vue-toolkit

# Using pnpm
pnpm add @dimensional-innovations/vue-toolkit

Usage

Import only what you need from the toolkit:

// Import specific functionality
import { VideoDisplay } from '@dimensional-innovations/vue-toolkit';
import { useSanitizeHtml } from '@dimensional-innovations/vue-toolkit';
import { formatDate } from '@dimensional-innovations/vue-toolkit';

Documentation

Comprehensive documentation is available in the docs directory, organized by category:

• Components - Reusable Vue 3 components
• Composables - Vue composition API functions
• Utilities - Pure JavaScript helper functions

Please refer to the documentation index for a complete list of available tools with usage instructions and examples.

Development

# Install dependencies
yarn install

# Lint code
yarn lint

# Run tests
yarn test

# Run all checks (lint, style, format, and tests)
yarn lint:all

Contributing

This toolkit is designed to grow with our needs. If you have a component, composable, or utility that could benefit other DI projects:

1. Ensure it follows the established patterns in the codebase
2. Add appropriate tests and documentation
3. Submit a pull request with a clear description of the addition

License

MIT