Skip to content

An elegant calendar and datepicker plugin for Vue.

License

Notifications You must be signed in to change notification settings

nttps/v-calendar

 
 

Repository files navigation

VCalendar Plugin for Vue 3

A calendar and date picker plugin for Vue.js (requires version 3.2+).

Install Plugin

NPM

npm install v-calendar

Yarn

yarn add v-calendar

Use Plugin

⚠️ As of v3.0.0-alpha.7, all installation methods require manual import of component styles. This is due to Vite build restrictions in libary mode.

import 'v-calendar/style.css';

Method 1: Use Globally

import VCalendar from 'v-calendar';
import 'v-calendar/style.css';

// Use plugin with optional defaults
app.use(VCalendar, {})
<!-- MyComponent.vue -->
<template>
  <VCalendar />
  <VDatePicker v-model="date" />
</template>

Method 2: Use Components Globally

// main.js
import { SetupCalendar, Calendar, DatePicker } from 'v-calendar';
import 'v-calendar/style.css';

// Use plugin defaults (optional)
app.use(SetupCalendar, {})

// Use the components
app.component('VCalendar', Calendar)
app.component('VDatePicker', DatePicker)
<!-- MyComponent.vue -->
<template>
  <VCalendar />
  <VDatePicker v-model="date" />
</template>

Method 3: Use Components As Needed

// main.js
import { SetupCalendar } from 'v-calendar';

// Use calendar defaults (optional)
app.use(SetupCalendar, {})
<!-- MyComponent.vue -->
<template>
  <Calendar />
  <DatePicker v-model="date">
</template>

<script>
import { Calendar, DatePicker } from 'v-calendar';
import 'v-calendar/style.css';

export default {
  components: {
    Calendar,
    DatePicker,
  },
  data() {
    return {
      date: new Date(),
    };
  },
}
</script>

Source setup

Please follow below mentioned steps to clone and build this project:

Clone the repo

git clone https://github.com/nathanreyes/v-calendar

# Move to directory
cd v-calendar

Install dependencies

yarn

Switch to /next branch

git checkout next

Build Library

# Types, ES, ESM, CommonJS, IIFE
yarn build

Lint and fix files

yarn lint

About

An elegant calendar and datepicker plugin for Vue.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 69.1%
  • Vue 25.8%
  • CSS 3.9%
  • Other 1.2%