@dymik-form/dymik-vue
v1.0.0
Published
A dynamic form library for Vue 3 with built-in validation support (Zod, ArkType)
Maintainers
Readme
Dymik Core
Dymik Core is a powerful library designed to support building web applications with flexible and easy-to-use features. This library provides components, models, and utilities to accelerate development and ensure code quality.
Features
- Reusable Components: Includes UI components like
DymikFormdesigned for easy reuse. - Validation Utilities: Provides robust validation tools based on
arktypeandzod. - Type-Safe Models: Defines data models with TypeScript to ensure type safety.
- Modular Architecture: Clear library structure, easy to extend and maintain.
Advantages
- High Performance: Optimized for fast and efficient operation.
- Ease of Use: Developer-friendly API, easy to integrate into projects.
- Great Integration: Supports integration with popular tools and frameworks like Vue.js.
Installation Guide
Requirements
- Node.js >= 16
- pnpm (recommended)
Installation
Add
dymik-coreto your project:pnpm add dymik-coreEnsure that TypeScript is configured in your project.
Usage
Import and Use Components
To use DymikForm in your Vue.js project, follow these steps:
- Import and register
DymikFormas a plugin in yourmain.tsfile:
import { createApp } from 'vue';
import App from './App.vue';
import DymikForm from 'dymik-core';
import 'dymik-core/dist/dymik-core.css';
const app = createApp(App);
// Register DymikForm as a plugin
app.use(DymikForm);
app.mount('#app');- Use the
DymikFormcomponent in your Vue templates // TODO: Write usage here
Integration with PrimeVue
If you are using PrimeVue, you can integrate it alongside DymikForm as follows:
import PrimeVue from 'primevue/config';
import Aura from '@primeuix/themes/aura';
import ToastService from 'primevue/toastservice';
app.use(PrimeVue, {
theme: {
preset: Aura
}
});
app.use(ToastService);Additionally, register PrimeVue components globally if needed:
import InputText from 'primevue/inputtext';
import Button from 'primevue/button';
app.component('InputText', InputText);
app.component('Button', Button);Contribution
We welcome contributions from the community. If you want to contribute, please create a pull request or open an issue on GitHub.
License
Dymik Core is released under the MIT license. Please refer to the LICENSE file for more details.
Contact
If you have any questions or feedback, feel free to contact us via email: [email protected].
