Skip to content

docs: Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 18, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## @softechub-ib/vue-datepicker

[![License](https://img.shields.io/npm/l/@softechub-ib/vue-datepicker)](https://github.com/softechub-ib/vue-datepicker/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/@softechub-ib/vue-datepicker)](https://www.npmjs.com/package/@softechub-ib/vue-datepicker) ![Downloads](https://img.shields.io/npm/dm/@softechub-ib/vue-datepicker) [![Coverage Status](https://coveralls.io/repos/github/softechub-ib/vue-datepicker/badge.svg?branch=main)](https://coveralls.io/github/softechub-ib/vue-datepicker?branch=main)
[![License](https://img.shields.io/npm/l/@softechub-ib/vue-datepicker)](https://github.com/softechub-ib/vue-datepicker/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/@softechub-ib/vue-datepicker)](https://www.npmjs.com/package/@softechub-ib/vue-datepicker) ![Downloads](https://img.shields.io/npm/dm/@softechub-ib/vue-datepicker) [![Open issues](https://img.shields.io/github/issues-raw/softechub-ib/vue-datepicker)](https://github.com/softechub-ib/vue-datepicker/issues) ![CI](https://img.shields.io/github/actions/workflow/status/softechub-ib/vue-datepicker/ci-coverage-upload.yml?branch=main&label=CI) [![Coverage Status](https://coveralls.io/repos/github/softechub-ib/vue-datepicker/badge.svg?branch=main)](https://coveralls.io/github/softechub-ib/vue-datepicker?branch=main)

### Datepicker solution for Vue 3 that offers:

@@ -67,6 +67,18 @@ const date = ref();
</template>
```

**Types**

```ts
import type {
CalendarStylesProp, // calendar-styles
DateValue, // min, max, model-value (DateValue | DateValue[])
DayjsLocale, // locale
InputStylesProp, // input-styles
Size, // size
} from "@softechub-ib/vue-datepicker";
```

## Props

| Prop | Required | Type | Default value |
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@softechub-ib/vue-datepicker",
"version": "1.0.13",
"version": "1.0.14",
"description": "Datepicker component for Vue 3",
"author": "softechub-ib",
"private": false,
Loading