Persian Components

Remember that work is in progress!

This NPM package is a Vue 3 Composition API component library integrated with Tailwind CSS and date-fns-jalali. It provides various utility components and functions for working with Jalali (Persian) dates in a Vue project.

Installation

You can install the package via npm:

npm install persian-components

Usage

First of all

import { PersianComponents } from 'persian-components'
import 'persian-components/style.css'

import { createApp } from 'vue'


app.use(PersianComponents)

Then import the components or functions from the package and start using them in your Vue 3 project:

// Use the DatePicker component
<template>
  <PersianDatePicker />
</template>

<script setup lang="ts">
import { PersianDatePicker } from 'persian-components'
</script>

Documentation

For detailed usage instructions and examples, please refer to the documentation.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

To contribute to the project, follow these steps:

1. Fork the repository.
2. Create a new branch for your feat/fix.
3. Make your changes and write tests if applicable.
4. Run npm run lint to ensure code quality.
5. Commit your changes and push to your forked repository.
6. Submit a pull request to the main repository.

Please make sure to follow the code of conduct when contributing.

License

This package is open source and available under the MIT License.

Acknowledgements

This project wouldn't have been possible without the following amazing libraries:

• Vue.js
• Tailwind CSS
• date-fns-jalali

Contact

If you have any questions or inquiries, feel free to contact me at [email protected].

Thank you for using This NPM Package! We hope it helps you in your projects. Contributions and feedback are highly appreciated.