Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yatendra121/vq-vuetify

An extendable library of Vuetify components.
https://github.com/yatendra121/vq-vuetify

typescript validation vue3 vuejs vuetify

Last synced: 6 days ago
JSON representation

An extendable library of Vuetify components.

Awesome Lists containing this project

README

        

# @qnx/vuetify

`@qnx/vuetify` is a Vue.js library designed to simplify Vuetify form, streamlining code and handling various processes internally, including validation, data set management, and server data submission. This approach aims to reduce code complexity and promote clean and manageable code.

## Example

To see examples of components provided by @qnx/vuetify, please visit [here](https://qnx-vuetify-sample.vercel.app/). For complete documentation, visit [@qnx/vuetify Documentation](https://qnx-vuetify-docs.vercel.app/).

## Installation

Use the package manager [npm](https://www.npmjs.com/) to install @qnx/vuetify.

```bash
npm install @qnx/vuetify
```

You can also use [yarn](https://yarnpkg.com/), [pnpm](https://pnpm.io/), or [bun](https://bun.sh/)

```bash
yarn add @qnx/vuetify
```

```bash
pnpm install @qnx/vuetify
```

```bash
bun install @qnx/vuetify
```

#### Peer-Dependencies

@qnx/vuetify resolves problems internally and depends on some other libraries.

```bash
npm install vuetify@latest @qnx/composables @vee-validate yup axios
```

## Usage

```bash

import { VqForm, VqTextField } from '@qnx/vuetify'
import { object, string } from 'yup';

let validationSchema= object({
name: string().required(),
email: string().required().email(),
});

const initialValues = { name:'Test User', email:'[email protected]' }

const onSuccess = (res) => { console.log(res) }




Submit

```

## Components

Here's a list of components provided by @qnx/vuetify:

### Vuetify Form Components:

- VqTextField
- VqTextarea
- VqAutocomplete
- VqFileInput
- VqForm
- VqCheckbox
- VqDatePicker
- VqTimePicker
- VqColorPicker
- VqOtpInput
- VqSubmitBtn

### Other Components:

- VqDataTable
- VqSerialNo
- VqList
- VqTableFilter
- VqListLoadMoreBtn

### Integration Components:

- VqTextEditor

## Composables

- useVqForm
- collectVqHeaders
- useVqList

Additionally, @qnx/vuetify extends existing components that are specifically useful in the context of forms. The library also includes additional components designed for displaying data. Overall, it appears to be a comprehensive solution for simplifying the implementation of forms and managing data presentation within Vuetify-based applications.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT License](https://github.com/yatendra121/vq-vuetify/blob/main/LICENSE.md) © 2023-PRESENT [Yatendra Kushwaha](https://github.com/yatendra121)